AWS::IoTTwinMaker::Entity - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTTwinMaker::Entity

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTTwinMaker::Entity",
  "Properties" : {
      "Components" : {Key: Value, ...},
      "CompositeComponents" : {Key: Value, ...},
      "Description" : String,
      "EntityId" : String,
      "EntityName" : String,
      "ParentEntityId" : String,
      "Tags" : {Key: Value, ...},
      "WorkspaceId" : String
    }
}

YAML

Type: AWS::IoTTwinMaker::Entity
Properties:
  Components: 
    Key: Value
  CompositeComponents: 
    Key: Value
  Description: String
  EntityId: String
  EntityName: String
  ParentEntityId: String
  Tags: 
    Key: Value
  WorkspaceId: String

Properties

Components

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 API reference.

Required: No

Type: Object of Component

Update requires: No interruption

CompositeComponents

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

Required: No

Type: Object of CompositeComponent

Update requires: No interruption

Description

The description of the entity.

Required: No

Type: String

Minimum: 0

Maximum: 512

Update requires: No interruption

EntityId

The ID of the entity.

Required: No

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Minimum: 1

Maximum: 128

Update requires: Replacement

EntityName

The entity name.

Required: Yes

Type: String

Pattern: [a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+

Minimum: 1

Maximum: 256

Update requires: No interruption

ParentEntityId

The ID of the parent entity.

Required: No

Type: String

Pattern: \$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Minimum: 1

Maximum: 128

Update requires: No interruption

Tags

Metadata that you can use to manage the entity.

Required: No

Type: Object of String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Minimum: 1

Maximum: 256

Update requires: No interruption

WorkspaceId

The ID of the workspace that contains the entity.

Required: Yes

Type: String

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Minimum: 1

Maximum: 128

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the workspace Id and the entity Id.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The entity ARN.

CreationDateTime

The date and time the entity was created.

HasChildEntities

A boolean value that specifies whether the entity has child entities or not.

UpdateDateTime

The date and time when the component type was last updated.