AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTTwinMaker::Entity

CfnEntity

Use the `AWS::IoTTwinMaker::Entity` resource to declare an entity.

Import

import { CfnEntity } from 'aws-cdk-lib/aws-iottwinmaker';

Or use the module namespace:

import * as iottwinmaker from 'aws-cdk-lib/aws-iottwinmaker';
// iottwinmaker.CfnEntity

Properties

Configuration passed to the constructor as CfnEntityProps.

entityNameRequired
string

The entity name.

workspaceIdRequired
string

The ID of the workspace that contains the entity.

componentsOptional
IResolvable | { [key: string]: IResolvable | ComponentProperty }

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object. For information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference.

compositeComponentsOptional
IResolvable | { [key: string]: IResolvable | CompositeComponentProperty }

Maps string to `compositeComponent` updates in the request. Each key of the map represents the `componentPath` of the `compositeComponent` .

descriptionOptional
string

The description of the entity.

entityIdOptional
string

The ID of the entity.

parentEntityIdOptional
string

The ID of the parent entity.

tagsOptional
{ [key: string]: string }

Metadata that you can use to manage the entity.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoTTwinMaker::EntityView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iottwinmaker
CFN TypeAWS::IoTTwinMaker::Entity
Properties8

Related Constructs

Explore This Service

External Links