AWS::IoTTwinMaker::Entity Component

The entity component.

Syntax

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

JSON

{ "ComponentName" : String, "ComponentTypeId" : String, "DefinedIn" : String, "Description" : String, "Properties" : {Key : Value, ...}, "PropertyGroups" : {Key : Value, ...}, "Status" : Status }

YAML

ComponentName: String ComponentTypeId: String DefinedIn: String Description: String Properties: Key : Value PropertyGroups: Key : Value Status: Status

Properties

ComponentName

The name of the component.

Required: No

Type: String

Update requires: No interruption

ComponentTypeId

The ID of the ComponentType.

Required: No

Type: String

Update requires: No interruption

DefinedIn

The name of the property definition set in the request.

Required: No

Type: String

Update requires: No interruption

Description

The description of the component.

Required: No

Type: String

Update requires: No interruption

Properties

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: Map of Property

Update requires: No interruption

PropertyGroups

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: Map of PropertyGroup

Update requires: No interruption

Status

The status of the component.

Required: No

Type: Status

Update requires: No interruption