AWS::IoTTwinMaker::Entity Component - AWS CloudFormation (original) (raw)

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

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

Minimum: 1

Maximum: 256

Update requires: No interruption

ComponentTypeId

The ID of the component type.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

DefinedIn

The name of the property definition set in the request.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Description

The description of the component.

Required: No

Type: String

Minimum: 0

Maximum: 512

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

Update requires: No interruption

Status

The status of the component.

Required: No

Type: Status

Update requires: No interruption

AWS::IoTTwinMaker::Entity

CompositeComponent

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.