Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iottwinmaker-componenttype.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS::IoTTwinMaker::ComponentType. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker

Properties

WorkspaceId string | Aws_CF_FunctionString required

The ID of the workspace that contains the component type.

ComponentTypeId string | Aws_CF_FunctionString required

The ID of the component type.

Description string | Aws_CF_FunctionString

The description of the component type.

ExtendsFrom ParentComponentType[]

Specifies the parent component type to extend.

minItems=1maxItems=256uniqueItems=true
Functions object

a Map of functions in the component type. Each function's key must be unique to this map.

IsSingleton boolean

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

PropertyDefinitions object

An map of the property definitions in the component type. Each property definition's key must be unique to this map.

PropertyGroups object

An map of the property groups in the component type. Each property group's key must be unique to this map.

Tags object

A map of key-value pairs to associate with a resource.

Definitions

DateTimeFormat string | Aws_CF_FunctionString
ParentComponentType string | Aws_CF_FunctionString
PropertyName string | Aws_CF_FunctionString
RequiredProperty string | Aws_CF_FunctionString
LambdaFunction object
Arn string | Aws_CF_FunctionString required
DataConnector object

The data connector.

IsNative boolean

A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

Lambda object
1 nested properties
Arn string | Aws_CF_FunctionString required
Function object

The function of component type.

ImplementedBy object

The data connector.

2 nested properties
IsNative boolean

A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

Lambda object
1 nested properties
Arn string | Aws_CF_FunctionString required
RequiredProperties RequiredProperty[]

The required properties of the function.

minItems=1maxItems=256uniqueItems=true
Scope string | Aws_CF_FunctionString

The scope of the function.

DataValue object

An object that specifies a value for a property.

BooleanValue boolean

A Boolean value.

DoubleValue number

A double value.

Expression string | Aws_CF_FunctionString

An expression that produces the value.

IntegerValue integer

An integer value.

ListValue DataValue[]

A list of multiple values.

minItems=0maxItems=50
LongValue number

A long value.

StringValue string | Aws_CF_FunctionString

A string value.

MapValue object

An object that maps strings to multiple DataValue objects.

RelationshipValue object

A value that relates a component to another component.

2 nested properties
TargetComponentName string | Aws_CF_FunctionString
TargetEntityId string | Aws_CF_FunctionString
Relationship object

The type of the relationship.

RelationshipType string | Aws_CF_FunctionString

The type of the relationship.

TargetComponentTypeId string | Aws_CF_FunctionString

The ID of the target component type associated with this relationship.

DataType object

An object that specifies the data type of a property.

Type string | Aws_CF_FunctionString required

The underlying type of the data type.

AllowedValues DataValue[]

The allowed values for this data type.

minItems=0maxItems=50
NestedType object

An object that specifies the data type of a property.

5 nested properties
Type string | Aws_CF_FunctionString required

The underlying type of the data type.

AllowedValues DataValue[]

The allowed values for this data type.

minItems=0maxItems=50
NestedType object

An object that specifies the data type of a property.

5 nested properties
Type string | Aws_CF_FunctionString required

The underlying type of the data type.

AllowedValues DataValue[]

The allowed values for this data type.

minItems=0maxItems=50
NestedType object

An object that specifies the data type of a property.

Relationship object

The type of the relationship.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

Relationship object

The type of the relationship.

2 nested properties
RelationshipType string | Aws_CF_FunctionString

The type of the relationship.

TargetComponentTypeId string | Aws_CF_FunctionString

The ID of the target component type associated with this relationship.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

Relationship object

The type of the relationship.

2 nested properties
RelationshipType string | Aws_CF_FunctionString

The type of the relationship.

TargetComponentTypeId string | Aws_CF_FunctionString

The ID of the target component type associated with this relationship.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

PropertyDefinition object

An object that sets information about a property.

Configurations object

An object that specifies information about a property.

DataType object

An object that specifies the data type of a property.

5 nested properties
Type string | Aws_CF_FunctionString required

The underlying type of the data type.

AllowedValues DataValue[]

The allowed values for this data type.

minItems=0maxItems=50
NestedType object

An object that specifies the data type of a property.

5 nested properties
Type string | Aws_CF_FunctionString required

The underlying type of the data type.

AllowedValues DataValue[]

The allowed values for this data type.

minItems=0maxItems=50
NestedType object

An object that specifies the data type of a property.

Relationship object

The type of the relationship.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

Relationship object

The type of the relationship.

2 nested properties
RelationshipType string | Aws_CF_FunctionString

The type of the relationship.

TargetComponentTypeId string | Aws_CF_FunctionString

The ID of the target component type associated with this relationship.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

DefaultValue object

An object that specifies a value for a property.

9 nested properties
BooleanValue boolean

A Boolean value.

DoubleValue number

A double value.

Expression string | Aws_CF_FunctionString

An expression that produces the value.

IntegerValue integer

An integer value.

ListValue DataValue[]

A list of multiple values.

minItems=0maxItems=50
LongValue number

A long value.

StringValue string | Aws_CF_FunctionString

A string value.

MapValue object

An object that maps strings to multiple DataValue objects.

RelationshipValue object

A value that relates a component to another component.

2 nested properties
TargetComponentName string | Aws_CF_FunctionString
TargetEntityId string | Aws_CF_FunctionString
IsExternalId boolean

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

IsRequiredInEntity boolean

A Boolean value that specifies whether the property is required.

IsStoredExternally boolean

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

IsTimeSeries boolean

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

PropertyGroup object

An object that sets information about a property group.

GroupType string | Aws_CF_FunctionString

The type of property group.

PropertyNames PropertyName[]

The list of property names in the property group.

minItems=1maxItems=256uniqueItems=true
Status object
State string | Aws_CF_FunctionString
Error object
Any of: object object, object object