AWS::IoTTwinMaker::ComponentType - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::IoTTwinMaker::ComponentType

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

Syntax

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

JSON

{
  "Type" : "AWS::IoTTwinMaker::ComponentType",
  "Properties" : {
      "ComponentTypeId" : String,
      "Description" : String,
      "ExtendsFrom" : [ String, ... ],
      "Functions" : {Key: Value, ...},
      "IsSingleton" : Boolean,
      "PropertyDefinitions" : {Key: Value, ...},
      "PropertyGroups" : {Key: Value, ...},
      "Tags" : {Key: Value, ...},
      "WorkspaceId" : String
    }
}

YAML

Type: AWS::IoTTwinMaker::ComponentType
Properties: 
  ComponentTypeId: String
  Description: String
  ExtendsFrom: 
    - String
  Functions: 
    Key: Value
  IsSingleton: Boolean
  PropertyDefinitions: 
    Key: Value
  PropertyGroups: 
    Key: Value
  Tags: 
    Key: Value
  WorkspaceId: String

Properties

ComponentTypeId

The ID of the component type.

Required: Yes

Type: String

Update requires: Replacement

Description

The description of the component type.

Required: No

Type: String

Update requires: No interruption

ExtendsFrom

The name of the parent component type that this component type extends.

Required: No

Type: List of String

Update requires: No interruption

Functions

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

For information on the FunctionResponse object see the FunctionResponse API reference.

Required: No

Type: Map of Function

Update requires: No interruption

IsSingleton

A boolean value that specifies whether an entity can have more than one component of this type.

Required: No

Type: Boolean

Update requires: No interruption

PropertyDefinitions

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

Required: No

Type: Map of PropertyDefinition

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

Tags

The ComponentType tags.

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 ComponentType 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 ARN of the component type.

CreationDateTime

The date and time when the component type was created.

IsAbstract

A boolean value that specifies whether the component type is abstract.

IsSchemaInitialized

A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

Status

The component type status.

Status.Error

The component type error.

Status.Error.Code

component type error code.

Status.Error.Message

The component type error message.

Status.State

The component type state.

UpdateDateTime

The component type the update time.