AssetModelPropertyDefinition

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

Type: String

Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT

Required: Yes

The name of the property definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

The property definition type (see PropertyType). You can only specify one type in a property definition.

Type: PropertyType object

Required: Yes

The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the Amazon IoT SiteWise User Guide.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 128.

Pattern: [a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+

Required: No

The ID to assign to the asset model property, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: No

The unit of the property definition, such as Newtons or RPM.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: No