AWS::IoTTwinMaker::Entity CompositeComponent - Amazon CloudFormation
SyntaxProperties
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoTTwinMaker::Entity CompositeComponent

Information about a composite component.

Syntax

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

JSON

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

YAML

  ComponentName: String
  ComponentPath: String
  ComponentTypeId: 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

ComponentPath

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

ComponentTypeId

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

Description

The description of the component type.

Required: No

Type: String

Minimum: 0

Maximum: 512

Update requires: No interruption

Properties

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

Update requires: No interruption

PropertyGroups

The property groups.

Required: No

Type: Object of PropertyGroup

Update requires: No interruption

Status

The current status of the composite component.

Required: No

Type: Status

Update requires: No interruption