This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IoTTwinMaker::Entity
<a name="aws-resource-iottwinmaker-entity"></a>

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

## Syntax
<a name="aws-resource-iottwinmaker-entity-syntax"></a>

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

### JSON
<a name="aws-resource-iottwinmaker-entity-syntax.json"></a>

```
{
  "Type" : "AWS::IoTTwinMaker::Entity",
  "Properties" : {
      "[Components](#cfn-iottwinmaker-entity-components)" : {Key: Value, ...},
      "[CompositeComponents](#cfn-iottwinmaker-entity-compositecomponents)" : {Key: Value, ...},
      "[Description](#cfn-iottwinmaker-entity-description)" : String,
      "[EntityId](#cfn-iottwinmaker-entity-entityid)" : String,
      "[EntityName](#cfn-iottwinmaker-entity-entityname)" : String,
      "[ParentEntityId](#cfn-iottwinmaker-entity-parententityid)" : String,
      "[Tags](#cfn-iottwinmaker-entity-tags)" : {Key: Value, ...},
      "[WorkspaceId](#cfn-iottwinmaker-entity-workspaceid)" : String
    }
}
```

### YAML
<a name="aws-resource-iottwinmaker-entity-syntax.yaml"></a>

```
Type: AWS::IoTTwinMaker::Entity
Properties:
  [Components](#cfn-iottwinmaker-entity-components): 
    Key: Value
  [CompositeComponents](#cfn-iottwinmaker-entity-compositecomponents): 
    Key: Value
  [Description](#cfn-iottwinmaker-entity-description): String
  [EntityId](#cfn-iottwinmaker-entity-entityid): String
  [EntityName](#cfn-iottwinmaker-entity-entityname): String
  [ParentEntityId](#cfn-iottwinmaker-entity-parententityid): String
  [Tags](#cfn-iottwinmaker-entity-tags): 
    Key: Value
  [WorkspaceId](#cfn-iottwinmaker-entity-workspaceid): String
```

## Properties
<a name="aws-resource-iottwinmaker-entity-properties"></a>

`Components`  <a name="cfn-iottwinmaker-entity-components"></a>
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.  
*Required*: No  
*Type*: Object of [Component](aws-properties-iottwinmaker-entity-component.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CompositeComponents`  <a name="cfn-iottwinmaker-entity-compositecomponents"></a>
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](aws-properties-iottwinmaker-entity-compositecomponent.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-iottwinmaker-entity-description"></a>
The description of the entity.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EntityId`  <a name="cfn-iottwinmaker-entity-entityid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EntityName`  <a name="cfn-iottwinmaker-entity-entityname"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParentEntityId`  <a name="cfn-iottwinmaker-entity-parententityid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-iottwinmaker-entity-tags"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkspaceId`  <a name="cfn-iottwinmaker-entity-workspaceid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-iottwinmaker-entity-return-values"></a>

### Ref
<a name="aws-resource-iottwinmaker-entity-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-iottwinmaker-entity-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-iottwinmaker-entity-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The entity ARN.

`CreationDateTime`  <a name="CreationDateTime-fn::getatt"></a>
The date and time the entity was created.

`HasChildEntities`  <a name="HasChildEntities-fn::getatt"></a>
A boolean value that specifies whether the entity has child entities or not.

`UpdateDateTime`  <a name="UpdateDateTime-fn::getatt"></a>
The date and time when the component type was last updated.

# AWS::IoTTwinMaker::Entity Component
<a name="aws-properties-iottwinmaker-entity-component"></a>

The entity component.

## Syntax
<a name="aws-properties-iottwinmaker-entity-component-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-component-syntax.json"></a>

```
{
  "[ComponentName](#cfn-iottwinmaker-entity-component-componentname)" : String,
  "[ComponentTypeId](#cfn-iottwinmaker-entity-component-componenttypeid)" : String,
  "[DefinedIn](#cfn-iottwinmaker-entity-component-definedin)" : String,
  "[Description](#cfn-iottwinmaker-entity-component-description)" : String,
  "[Properties](#cfn-iottwinmaker-entity-component-properties)" : {Key: Value, ...},
  "[PropertyGroups](#cfn-iottwinmaker-entity-component-propertygroups)" : {Key: Value, ...},
  "[Status](#cfn-iottwinmaker-entity-component-status)" : Status
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-component-syntax.yaml"></a>

```
  [ComponentName](#cfn-iottwinmaker-entity-component-componentname): String
  [ComponentTypeId](#cfn-iottwinmaker-entity-component-componenttypeid): String
  [DefinedIn](#cfn-iottwinmaker-entity-component-definedin): String
  [Description](#cfn-iottwinmaker-entity-component-description): String
  [Properties](#cfn-iottwinmaker-entity-component-properties): 
    Key: Value
  [PropertyGroups](#cfn-iottwinmaker-entity-component-propertygroups): 
    Key: Value
  [Status](#cfn-iottwinmaker-entity-component-status): 
    Status
```

## Properties
<a name="aws-properties-iottwinmaker-entity-component-properties"></a>

`ComponentName`  <a name="cfn-iottwinmaker-entity-component-componentname"></a>
The name of the component.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComponentTypeId`  <a name="cfn-iottwinmaker-entity-component-componenttypeid"></a>
The ID of the component type.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefinedIn`  <a name="cfn-iottwinmaker-entity-component-definedin"></a>
The name of the property definition set in the request.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-iottwinmaker-entity-component-description"></a>
The description of the component.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Properties`  <a name="cfn-iottwinmaker-entity-component-properties"></a>
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.  
*Required*: No  
*Type*: Object of [Property](aws-properties-iottwinmaker-entity-property.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropertyGroups`  <a name="cfn-iottwinmaker-entity-component-propertygroups"></a>
An object that maps strings to the property groups in the component type. Each string in the mapping must be unique to this object.  
*Required*: No  
*Type*: Object of [PropertyGroup](aws-properties-iottwinmaker-entity-propertygroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-iottwinmaker-entity-component-status"></a>
The status of the component.  
*Required*: No  
*Type*: [Status](aws-properties-iottwinmaker-entity-status.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity CompositeComponent
<a name="aws-properties-iottwinmaker-entity-compositecomponent"></a>

Information about a composite component.

## Syntax
<a name="aws-properties-iottwinmaker-entity-compositecomponent-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-compositecomponent-syntax.json"></a>

```
{
  "[ComponentName](#cfn-iottwinmaker-entity-compositecomponent-componentname)" : String,
  "[ComponentPath](#cfn-iottwinmaker-entity-compositecomponent-componentpath)" : String,
  "[ComponentTypeId](#cfn-iottwinmaker-entity-compositecomponent-componenttypeid)" : String,
  "[Description](#cfn-iottwinmaker-entity-compositecomponent-description)" : String,
  "[Properties](#cfn-iottwinmaker-entity-compositecomponent-properties)" : {Key: Value, ...},
  "[PropertyGroups](#cfn-iottwinmaker-entity-compositecomponent-propertygroups)" : {Key: Value, ...},
  "[Status](#cfn-iottwinmaker-entity-compositecomponent-status)" : Status
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-compositecomponent-syntax.yaml"></a>

```
  [ComponentName](#cfn-iottwinmaker-entity-compositecomponent-componentname): String
  [ComponentPath](#cfn-iottwinmaker-entity-compositecomponent-componentpath): String
  [ComponentTypeId](#cfn-iottwinmaker-entity-compositecomponent-componenttypeid): String
  [Description](#cfn-iottwinmaker-entity-compositecomponent-description): String
  [Properties](#cfn-iottwinmaker-entity-compositecomponent-properties): 
    Key: Value
  [PropertyGroups](#cfn-iottwinmaker-entity-compositecomponent-propertygroups): 
    Key: Value
  [Status](#cfn-iottwinmaker-entity-compositecomponent-status): 
    Status
```

## Properties
<a name="aws-properties-iottwinmaker-entity-compositecomponent-properties"></a>

`ComponentName`  <a name="cfn-iottwinmaker-entity-compositecomponent-componentname"></a>
The name of the component.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComponentPath`  <a name="cfn-iottwinmaker-entity-compositecomponent-componentpath"></a>
The path to the composite component, starting from the top-level component.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9/]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComponentTypeId`  <a name="cfn-iottwinmaker-entity-compositecomponent-componenttypeid"></a>
The ID of the composite component type.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-iottwinmaker-entity-compositecomponent-description"></a>
The description of the component type.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Properties`  <a name="cfn-iottwinmaker-entity-compositecomponent-properties"></a>
Map of strings to the properties in the component type. Each string in the mapping must be unique to this component.  
*Required*: No  
*Type*: Object of [Property](aws-properties-iottwinmaker-entity-property.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropertyGroups`  <a name="cfn-iottwinmaker-entity-compositecomponent-propertygroups"></a>
The property groups.  
*Required*: No  
*Type*: Object of [PropertyGroup](aws-properties-iottwinmaker-entity-propertygroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-iottwinmaker-entity-compositecomponent-status"></a>
The current status of the composite component.  
*Required*: No  
*Type*: [Status](aws-properties-iottwinmaker-entity-status.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity DataType
<a name="aws-properties-iottwinmaker-entity-datatype"></a>

The entity data type.

## Syntax
<a name="aws-properties-iottwinmaker-entity-datatype-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-datatype-syntax.json"></a>

```
{
  "[AllowedValues](#cfn-iottwinmaker-entity-datatype-allowedvalues)" : [ DataValue, ... ],
  "[NestedType](#cfn-iottwinmaker-entity-datatype-nestedtype)" : DataType,
  "[Relationship](#cfn-iottwinmaker-entity-datatype-relationship)" : Relationship,
  "[Type](#cfn-iottwinmaker-entity-datatype-type)" : String,
  "[UnitOfMeasure](#cfn-iottwinmaker-entity-datatype-unitofmeasure)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-datatype-syntax.yaml"></a>

```
  [AllowedValues](#cfn-iottwinmaker-entity-datatype-allowedvalues): 
    - DataValue
  [NestedType](#cfn-iottwinmaker-entity-datatype-nestedtype): 
    DataType
  [Relationship](#cfn-iottwinmaker-entity-datatype-relationship): 
    Relationship
  [Type](#cfn-iottwinmaker-entity-datatype-type): String
  [UnitOfMeasure](#cfn-iottwinmaker-entity-datatype-unitofmeasure): String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-datatype-properties"></a>

`AllowedValues`  <a name="cfn-iottwinmaker-entity-datatype-allowedvalues"></a>
The allowed values.  
*Required*: No  
*Type*: Array of [DataValue](aws-properties-iottwinmaker-entity-datavalue.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NestedType`  <a name="cfn-iottwinmaker-entity-datatype-nestedtype"></a>
The nested type.  
*Required*: No  
*Type*: [DataType](#aws-properties-iottwinmaker-entity-datatype)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Relationship`  <a name="cfn-iottwinmaker-entity-datatype-relationship"></a>
The relationship.  
*Required*: No  
*Type*: [Relationship](aws-properties-iottwinmaker-entity-relationship.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-iottwinmaker-entity-datatype-type"></a>
The entity type.  
*Required*: No  
*Type*: String  
*Allowed values*: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UnitOfMeasure`  <a name="cfn-iottwinmaker-entity-datatype-unitofmeasure"></a>
The unit of measure.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity DataValue
<a name="aws-properties-iottwinmaker-entity-datavalue"></a>

An object that specifies a value for a property.

## Syntax
<a name="aws-properties-iottwinmaker-entity-datavalue-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-datavalue-syntax.json"></a>

```
{
  "[BooleanValue](#cfn-iottwinmaker-entity-datavalue-booleanvalue)" : Boolean,
  "[DoubleValue](#cfn-iottwinmaker-entity-datavalue-doublevalue)" : Number,
  "[Expression](#cfn-iottwinmaker-entity-datavalue-expression)" : String,
  "[IntegerValue](#cfn-iottwinmaker-entity-datavalue-integervalue)" : Integer,
  "[ListValue](#cfn-iottwinmaker-entity-datavalue-listvalue)" : [ DataValue, ... ],
  "[LongValue](#cfn-iottwinmaker-entity-datavalue-longvalue)" : Number,
  "[MapValue](#cfn-iottwinmaker-entity-datavalue-mapvalue)" : {Key: Value, ...},
  "[RelationshipValue](#cfn-iottwinmaker-entity-datavalue-relationshipvalue)" : RelationshipValue,
  "[StringValue](#cfn-iottwinmaker-entity-datavalue-stringvalue)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-datavalue-syntax.yaml"></a>

```
  [BooleanValue](#cfn-iottwinmaker-entity-datavalue-booleanvalue): 
    Boolean
  [DoubleValue](#cfn-iottwinmaker-entity-datavalue-doublevalue): Number
  [Expression](#cfn-iottwinmaker-entity-datavalue-expression): String
  [IntegerValue](#cfn-iottwinmaker-entity-datavalue-integervalue): 
    Integer
  [ListValue](#cfn-iottwinmaker-entity-datavalue-listvalue): 
    - DataValue
  [LongValue](#cfn-iottwinmaker-entity-datavalue-longvalue): Number
  [MapValue](#cfn-iottwinmaker-entity-datavalue-mapvalue): 
    Key: Value
  [RelationshipValue](#cfn-iottwinmaker-entity-datavalue-relationshipvalue): 
    RelationshipValue
  [StringValue](#cfn-iottwinmaker-entity-datavalue-stringvalue): 
    String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-datavalue-properties"></a>

`BooleanValue`  <a name="cfn-iottwinmaker-entity-datavalue-booleanvalue"></a>
A boolean value.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DoubleValue`  <a name="cfn-iottwinmaker-entity-datavalue-doublevalue"></a>
A double value.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Expression`  <a name="cfn-iottwinmaker-entity-datavalue-expression"></a>
An expression that produces the value.  
*Required*: No  
*Type*: String  
*Pattern*: `(^\$\{Parameters\.[a-zA-z]+([a-zA-z_0-9]*)}$)`  
*Minimum*: `1`  
*Maximum*: `316`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IntegerValue`  <a name="cfn-iottwinmaker-entity-datavalue-integervalue"></a>
An integer value.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ListValue`  <a name="cfn-iottwinmaker-entity-datavalue-listvalue"></a>
A list of multiple values.  
*Required*: No  
*Type*: Array of [DataValue](#aws-properties-iottwinmaker-entity-datavalue)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LongValue`  <a name="cfn-iottwinmaker-entity-datavalue-longvalue"></a>
A long value.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MapValue`  <a name="cfn-iottwinmaker-entity-datavalue-mapvalue"></a>
An object that maps strings to multiple DataValue objects.  
*Required*: No  
*Type*: Object of [DataValue](#aws-properties-iottwinmaker-entity-datavalue)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RelationshipValue`  <a name="cfn-iottwinmaker-entity-datavalue-relationshipvalue"></a>
A value that relates a component to another component.  
*Required*: No  
*Type*: [RelationshipValue](aws-properties-iottwinmaker-entity-relationshipvalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StringValue`  <a name="cfn-iottwinmaker-entity-datavalue-stringvalue"></a>
A string value.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity Definition
<a name="aws-properties-iottwinmaker-entity-definition"></a>

The entity definition.

## Syntax
<a name="aws-properties-iottwinmaker-entity-definition-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-definition-syntax.json"></a>

```
{
  "[Configuration](#cfn-iottwinmaker-entity-definition-configuration)" : {Key: Value, ...},
  "[DataType](#cfn-iottwinmaker-entity-definition-datatype)" : DataType,
  "[DefaultValue](#cfn-iottwinmaker-entity-definition-defaultvalue)" : DataValue,
  "[IsExternalId](#cfn-iottwinmaker-entity-definition-isexternalid)" : Boolean,
  "[IsFinal](#cfn-iottwinmaker-entity-definition-isfinal)" : Boolean,
  "[IsImported](#cfn-iottwinmaker-entity-definition-isimported)" : Boolean,
  "[IsInherited](#cfn-iottwinmaker-entity-definition-isinherited)" : Boolean,
  "[IsRequiredInEntity](#cfn-iottwinmaker-entity-definition-isrequiredinentity)" : Boolean,
  "[IsStoredExternally](#cfn-iottwinmaker-entity-definition-isstoredexternally)" : Boolean,
  "[IsTimeSeries](#cfn-iottwinmaker-entity-definition-istimeseries)" : Boolean
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-definition-syntax.yaml"></a>

```
  [Configuration](#cfn-iottwinmaker-entity-definition-configuration): 
    Key: Value
  [DataType](#cfn-iottwinmaker-entity-definition-datatype): 
    DataType
  [DefaultValue](#cfn-iottwinmaker-entity-definition-defaultvalue): 
    DataValue
  [IsExternalId](#cfn-iottwinmaker-entity-definition-isexternalid): Boolean
  [IsFinal](#cfn-iottwinmaker-entity-definition-isfinal): Boolean
  [IsImported](#cfn-iottwinmaker-entity-definition-isimported): Boolean
  [IsInherited](#cfn-iottwinmaker-entity-definition-isinherited): Boolean
  [IsRequiredInEntity](#cfn-iottwinmaker-entity-definition-isrequiredinentity): Boolean
  [IsStoredExternally](#cfn-iottwinmaker-entity-definition-isstoredexternally): Boolean
  [IsTimeSeries](#cfn-iottwinmaker-entity-definition-istimeseries): Boolean
```

## Properties
<a name="aws-properties-iottwinmaker-entity-definition-properties"></a>

`Configuration`  <a name="cfn-iottwinmaker-entity-definition-configuration"></a>
The configuration.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataType`  <a name="cfn-iottwinmaker-entity-definition-datatype"></a>
The data type  
*Required*: No  
*Type*: [DataType](aws-properties-iottwinmaker-entity-datatype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultValue`  <a name="cfn-iottwinmaker-entity-definition-defaultvalue"></a>
The default value.  
*Required*: No  
*Type*: [DataValue](aws-properties-iottwinmaker-entity-datavalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsExternalId`  <a name="cfn-iottwinmaker-entity-definition-isexternalid"></a>
Displays if the entity has a external Id.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsFinal`  <a name="cfn-iottwinmaker-entity-definition-isfinal"></a>
Displays if the entity is final.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsImported`  <a name="cfn-iottwinmaker-entity-definition-isimported"></a>
Displays if the entity is imported.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsInherited`  <a name="cfn-iottwinmaker-entity-definition-isinherited"></a>
Displays if the entity is inherited.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsRequiredInEntity`  <a name="cfn-iottwinmaker-entity-definition-isrequiredinentity"></a>
Displays if the entity is a required entity.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsStoredExternally`  <a name="cfn-iottwinmaker-entity-definition-isstoredexternally"></a>
Displays if the entity is tored externally.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsTimeSeries`  <a name="cfn-iottwinmaker-entity-definition-istimeseries"></a>
Displays if the entity  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity Error
<a name="aws-properties-iottwinmaker-entity-error"></a>

The entity error.

## Syntax
<a name="aws-properties-iottwinmaker-entity-error-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-error-syntax.json"></a>

```
{
  "[Code](#cfn-iottwinmaker-entity-error-code)" : String,
  "[Message](#cfn-iottwinmaker-entity-error-message)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-error-syntax.yaml"></a>

```
  [Code](#cfn-iottwinmaker-entity-error-code): String
  [Message](#cfn-iottwinmaker-entity-error-message): String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-error-properties"></a>

`Code`  <a name="cfn-iottwinmaker-entity-error-code"></a>
The entity error code.  
*Required*: No  
*Type*: String  
*Allowed values*: `VALIDATION_ERROR | INTERNAL_FAILURE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Message`  <a name="cfn-iottwinmaker-entity-error-message"></a>
The entity error message.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity Property
<a name="aws-properties-iottwinmaker-entity-property"></a>

An object that sets information about a property.

## Syntax
<a name="aws-properties-iottwinmaker-entity-property-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-property-syntax.json"></a>

```
{
  "[Definition](#cfn-iottwinmaker-entity-property-definition)" : Definition,
  "[Value](#cfn-iottwinmaker-entity-property-value)" : DataValue
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-property-syntax.yaml"></a>

```
  [Definition](#cfn-iottwinmaker-entity-property-definition): 
    Definition
  [Value](#cfn-iottwinmaker-entity-property-value): 
    DataValue
```

## Properties
<a name="aws-properties-iottwinmaker-entity-property-properties"></a>

`Definition`  <a name="cfn-iottwinmaker-entity-property-definition"></a>
An object that specifies information about a property.  
*Required*: No  
*Type*: [Definition](aws-properties-iottwinmaker-entity-definition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-iottwinmaker-entity-property-value"></a>
An object that contains information about a value for a time series property.  
*Required*: No  
*Type*: [DataValue](aws-properties-iottwinmaker-entity-datavalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity PropertyGroup
<a name="aws-properties-iottwinmaker-entity-propertygroup"></a>

The property group.

## Syntax
<a name="aws-properties-iottwinmaker-entity-propertygroup-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-propertygroup-syntax.json"></a>

```
{
  "[GroupType](#cfn-iottwinmaker-entity-propertygroup-grouptype)" : String,
  "[PropertyNames](#cfn-iottwinmaker-entity-propertygroup-propertynames)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-propertygroup-syntax.yaml"></a>

```
  [GroupType](#cfn-iottwinmaker-entity-propertygroup-grouptype): String
  [PropertyNames](#cfn-iottwinmaker-entity-propertygroup-propertynames): 
    - String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-propertygroup-properties"></a>

`GroupType`  <a name="cfn-iottwinmaker-entity-propertygroup-grouptype"></a>
The group type.  
*Required*: No  
*Type*: String  
*Allowed values*: `TABULAR`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropertyNames`  <a name="cfn-iottwinmaker-entity-propertygroup-propertynames"></a>
The property names.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity Relationship
<a name="aws-properties-iottwinmaker-entity-relationship"></a>

The entity relationship.

## Syntax
<a name="aws-properties-iottwinmaker-entity-relationship-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-relationship-syntax.json"></a>

```
{
  "[RelationshipType](#cfn-iottwinmaker-entity-relationship-relationshiptype)" : String,
  "[TargetComponentTypeId](#cfn-iottwinmaker-entity-relationship-targetcomponenttypeid)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-relationship-syntax.yaml"></a>

```
  [RelationshipType](#cfn-iottwinmaker-entity-relationship-relationshiptype): String
  [TargetComponentTypeId](#cfn-iottwinmaker-entity-relationship-targetcomponenttypeid): String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-relationship-properties"></a>

`RelationshipType`  <a name="cfn-iottwinmaker-entity-relationship-relationshiptype"></a>
The relationship type.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetComponentTypeId`  <a name="cfn-iottwinmaker-entity-relationship-targetcomponenttypeid"></a>
the component type Id target.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\.\-0-9:]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity RelationshipValue
<a name="aws-properties-iottwinmaker-entity-relationshipvalue"></a>

The entity relationship.

## Syntax
<a name="aws-properties-iottwinmaker-entity-relationshipvalue-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-relationshipvalue-syntax.json"></a>

```
{
  "[TargetComponentName](#cfn-iottwinmaker-entity-relationshipvalue-targetcomponentname)" : String,
  "[TargetEntityId](#cfn-iottwinmaker-entity-relationshipvalue-targetentityid)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-relationshipvalue-syntax.yaml"></a>

```
  [TargetComponentName](#cfn-iottwinmaker-entity-relationshipvalue-targetcomponentname): String
  [TargetEntityId](#cfn-iottwinmaker-entity-relationshipvalue-targetentityid): String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-relationshipvalue-properties"></a>

`TargetComponentName`  <a name="cfn-iottwinmaker-entity-relationshipvalue-targetcomponentname"></a>
The target component name.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z_\-0-9]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetEntityId`  <a name="cfn-iottwinmaker-entity-relationshipvalue-targetentityid"></a>
The target entity Id.  
*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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTTwinMaker::Entity Status
<a name="aws-properties-iottwinmaker-entity-status"></a>

The current status of the entity.

## Syntax
<a name="aws-properties-iottwinmaker-entity-status-syntax"></a>

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

### JSON
<a name="aws-properties-iottwinmaker-entity-status-syntax.json"></a>

```
{
  "[Error](#cfn-iottwinmaker-entity-status-error)" : Error,
  "[State](#cfn-iottwinmaker-entity-status-state)" : String
}
```

### YAML
<a name="aws-properties-iottwinmaker-entity-status-syntax.yaml"></a>

```
  [Error](#cfn-iottwinmaker-entity-status-error): 
    Error
  [State](#cfn-iottwinmaker-entity-status-state): String
```

## Properties
<a name="aws-properties-iottwinmaker-entity-status-properties"></a>

`Error`  <a name="cfn-iottwinmaker-entity-status-error"></a>
The error message.  
*Required*: No  
*Type*: [Error](aws-properties-iottwinmaker-entity-error.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`State`  <a name="cfn-iottwinmaker-entity-status-state"></a>
The current state of the entity, component, component type, or workspace.  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)