AWS::IoTTwinMaker::Entity

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

Syntax

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

JSON

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

YAML

Type: AWS::IoTTwinMaker::Entity
Properties: 
  Components: 
    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: Map of Component

Update requires: No interruption

Description

The description of the entity.

Required: No

Type: String

Update requires: No interruption

EntityId

The entity ID.

Required: No

Type: String

Update requires: Replacement

EntityName

The entity name.

Required: Yes

Type: String

Update requires: No interruption

ParentEntityId

The ID of the parent entity.

Required: No

Type: String

Update requires: No interruption

Tags

Metadata that you can use to manage the entity.

Required: No

Type: Map of String

Update requires: No interruption

WorkspaceId

The ID of the workspace.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the workspace Id and the entity Id.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic 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.

Status

The entity status.

Status.Error

The error.

Status.Error.Code

The error code.

Status.Error.Message

The error message.

Status.State

The state ofthe entity, component type, or workspace.

UpdateDateTime

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