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

Properties

EntityName string | Aws_CF_FunctionString required

The name of the entity.

WorkspaceId string | Aws_CF_FunctionString required

The ID of the workspace.

EntityId string | Aws_CF_FunctionString

The ID of the entity.

ParentEntityId string | Aws_CF_FunctionString

The ID of the parent entity.

Description string | Aws_CF_FunctionString

The description of the entity.

Tags object

A key-value pair to associate with a resource.

Components object

A map that sets information about a component type.

Definitions

DateTimeFormat 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.

PropertyDefinitionConfiguration object

An object that specifies information about a property.

DataType object

An object that specifies the data type of a property.

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
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
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.

Type string | Aws_CF_FunctionString

The underlying type of the data type.

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.

Type string | Aws_CF_FunctionString

The underlying type of the data type.

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.

Type string | Aws_CF_FunctionString

The underlying type of the data type.

UnitOfMeasure string | Aws_CF_FunctionString

The unit of measure used in this data type.

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
Property object
Definition object

An object that specifies information about a property.

10 nested properties
Configuration object

An object that specifies information about a property.

DataType object

An object that specifies the data type of a property.

5 nested properties
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.

Type string | Aws_CF_FunctionString

The underlying type of the data type.

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.

IsExternalId boolean

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

IsFinal boolean

A Boolean value that specifies whether the property definition can be updated.

IsImported boolean

A Boolean value that specifies whether the property definition is imported from an external data store.

IsInherited boolean

A Boolean value that specifies whether the property definition is inherited from a parent entity.

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.

Value 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
PropertyName string | Aws_CF_FunctionString
PropertyGroup object

An object that specifies 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
Component object
ComponentName string | Aws_CF_FunctionString

The name of the component.

ComponentTypeId string | Aws_CF_FunctionString

The ID of the component type.

Description string | Aws_CF_FunctionString

The description of the component.

DefinedIn string | Aws_CF_FunctionString

The name of the property definition set in the component.

Properties object

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.

PropertyGroups object

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

Status object
2 nested properties
State string | Aws_CF_FunctionString
Error object
Any of: object object, object object
Status object
State string | Aws_CF_FunctionString
Error object
Any of: object object, object object