AWS::IoTSiteWise::Asset AssetProperty - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTSiteWise::Asset AssetProperty

Contains asset property information.

Syntax

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

JSON

{
  "Alias" : String,
  "LogicalId" : String,
  "NotificationState" : String,
  "Unit" : String
}

YAML

  Alias: String
  LogicalId: String
  NotificationState: String
  Unit: String

Properties

Alias

The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the Amazon IoT SiteWise User Guide.

The property alias must have 1-1000 characters.

Required: No

Type: String

Update requires: No interruption

LogicalId

The LogicalID of the asset property.

The maximum length is 256 characters, with the pattern [^\u0000-\u001F\u007F]+.

Required: Yes

Type: String

Update requires: No interruption

NotificationState

The MQTT notification state (ENABLED or DISABLED) for this asset property. When the notification state is ENABLED, Amazon IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the Amazon IoT SiteWise User Guide.

If you omit this parameter, the notification state is set to DISABLED.

Note

You must use all caps for the NotificationState parameter. If you use lower case letters, you will receive a schema validation error.

Required: No

Type: String

Update requires: No interruption

Unit

The unit (such as Newtons or RPM) of the asset property.

Required: No

Type: String

Update requires: No interruption