AWS::IoTSiteWise::Asset AssetProperty

Filter View

All

Contains asset property information.

Syntax

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

JSON

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

YAML

  Alias: String
  ExternalId: String
  Id: String
  LogicalId: String
  NotificationState: String
  Unit: String

Properties

Alias

The 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 AWS IoT SiteWise User Guide.

Required: No

Type: String

Update requires: No interruption

ExternalId

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

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

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

NotificationState

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

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

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

Unit

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

Required: No

Type: String

Update requires: No interruption