AWS::IoTTwinMaker::ComponentType PropertyDefinition

PropertyDefinition is an object that maps strings to the property definitions in the component type.

Syntax

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

JSON

{
  "Configurations" : {Key: Value, ...},
  "DataType" : DataType,
  "DefaultValue" : DataValue,
  "IsExternalId" : Boolean,
  "IsRequiredInEntity" : Boolean,
  "IsStoredExternally" : Boolean,
  "IsTimeSeries" : Boolean
}

YAML

  Configurations: 
    Key: Value
  DataType: 
    DataType
  DefaultValue: 
    DataValue
  IsExternalId: Boolean
  IsRequiredInEntity: Boolean
  IsStoredExternally: Boolean
  IsTimeSeries: Boolean

Properties

Configurations

A mapping that specifies configuration information about the property.

Required: No

Type: Object of String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

DataType

Required: No

Type: DataType

Update requires: No interruption

DefaultValue

A boolean value that specifies whether the property ID comes from an external data store.

Required: No

Type: DataValue

Update requires: No interruption

IsExternalId

A Boolean value that specifies whether the property ID comes from an external data source.

Required: No

Type: Boolean

Update requires: No interruption

IsRequiredInEntity

A boolean value that specifies whether the property is required in an entity.

Required: No

Type: Boolean

Update requires: No interruption

IsStoredExternally

A boolean value that specifies whether the property is stored externally.

Required: No

Type: Boolean

Update requires: No interruption

IsTimeSeries

A boolean value that specifies whether the property consists of time series data.

Required: No

Type: Boolean

Update requires: No interruption