View a markdown version of this page

AWS::IoTSiteWise::AssetModel AssetModelProperty - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoTSiteWise::AssetModel AssetModelProperty

Contains information about an asset model property.

Syntax

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

JSON

{
  "DataType" : String,
  "DataTypeSpec" : String,
  "ExternalId" : String,
  "Id" : String,
  "LogicalId" : String,
  "Name" : String,
  "Type" : PropertyType,
  "Unit" : String
}

YAML

  DataType: String
  DataTypeSpec: String
  ExternalId: String
  Id: String
  LogicalId: String
  Name: String
  Type: 
    PropertyType
  Unit: String

Properties

DataType

The data type of the asset model property.

The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.

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

Required: Yes

Type: String

Allowed values: STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT

Update requires: No interruption

DataTypeSpec

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

Required: No

Type: String

Allowed values: AWS/ALARM_STATE

Update requires: No interruption

ExternalId

The external ID of the asset property. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

Note

One of ExternalId or LogicalId must be specified.

Required: No

Type: String

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

Minimum: 2

Maximum: 128

Update requires: No interruption

Id

The ID of the property.

Note

This is a return value and can't be set.

Required: No

Type: String

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

Minimum: 36

Maximum: 36

Update requires: No interruption

LogicalId

The LogicalID of the asset model property.

Note

One of ExternalId or LogicalId must be specified.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

Name

The name of the asset model property.

Required: Yes

Type: String

Update requires: No interruption

Type

Contains a property type, which can be one of attribute, measurement, metric, or transform.

Required: Yes

Type: PropertyType

Update requires: No interruption

Unit

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

Required: No

Type: String

Update requires: No interruption