AWS::IoTTwinMaker::Entity

IoTTwinMaker Entity

Resource schema for AWS::IoTTwinMaker::Entity

Properties

8 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`EntityName`	`string`	Required
`WorkspaceId`	`string`	RequiredCreate-only
`Components`	`object`
`CompositeComponents`	`object`
`Description`	`string`
`EntityId`	`string`	Create-only
`ParentEntityId`	`string`
`Tags`	`object`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The ARN of the entity.
`CreationDateTime`	`string`	The date and time when the entity was created.
`HasChildEntities`	`boolean`	A Boolean value that specifies whether the entity has child entities or not.
`Status`	`Status`	The current status of the entity.
`UpdateDateTime`	`string`	The last date and time when the entity was updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoTTwinMaker::Entity

Resources:
  MyResource:
    Type: AWS::IoTTwinMaker::Entity
    Properties:
      WorkspaceId: "my-workspaceid"
      EntityName: "my-entityname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iottwinmaker:GetWorkspaceiottwinmaker:CreateEntityiottwinmaker:GetEntityiottwinmaker:ListComponentsiottwinmaker:ListPropertiesiottwinmaker:ListTagsForResourceiottwinmaker:TagResource

read

iottwinmaker:GetComponentTypeiottwinmaker:GetEntityiottwinmaker:ListComponentsiottwinmaker:ListPropertiesiottwinmaker:GetWorkspaceiottwinmaker:ListEntitiesiottwinmaker:ListTagsForResource

update

iottwinmaker:GetComponentTypeiottwinmaker:GetEntityiottwinmaker:ListComponentsiottwinmaker:ListPropertiesiottwinmaker:GetWorkspaceiottwinmaker:ListTagsForResourceiottwinmaker:TagResourceiottwinmaker:UntagResource

delete

iottwinmaker:GetEntityiottwinmaker:GetWorkspaceiottwinmaker:DeleteEntity

list

iottwinmaker:GetWorkspaceiottwinmaker:ListTagsForResourceiottwinmaker:GetEntityiottwinmaker:ListEntities

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

ServiceIoTTwinMaker

Properties13

Required2

TaggingSupported

Primary IDWorkspaceId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

WorkspaceIdEntityId

Related Resources

External Links

AWS Documentation