Interface CfnAsset.IAssetPropertyProperty
Contains asset property information.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public interface IAssetPropertyProperty
Syntax (vb)
Public Interface IAssetPropertyProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTSiteWise;
var assetPropertyProperty = new AssetPropertyProperty {
LogicalId = "logicalId",
// the properties below are optional
Alias = "alias",
NotificationState = "notificationState",
Unit = "unit"
};
Synopsis
Properties
Alias | The property alias that identifies the property, such as an OPC-UA server data stream path (for example, |
LogicalId | The |
NotificationState | The MQTT notification state ( |
Unit | The unit (such as |
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
).
virtual string Alias { get; }
Property Value
System.String
Remarks
For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
The property alias must have 1-1000 characters.
LogicalId
The LogicalID
of the asset property.
string LogicalId { get; }
Property Value
System.String
Remarks
The maximum length is 256 characters, with the pattern [^\ u0000-\ u001F\ u007F]+
.
NotificationState
The MQTT notification state ( ENABLED
or DISABLED
) for this asset property.
virtual string NotificationState { get; }
Property Value
System.String
Remarks
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
.
You must use all caps for the NotificationState parameter. If you use lower case letters, you will receive a schema validation error.
Unit
The unit (such as Newtons
or RPM
) of the asset property.
virtual string Unit { get; }
Property Value
System.String