software.amazon.awscdk.services.iotsitewise

Interface CfnAsset.AssetPropertyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAsset.AssetPropertyProperty.Jsii$Proxy

Enclosing class:

CfnAsset

@Stability(value=Stable)
public static interface CfnAsset.AssetPropertyProperty
extends software.amazon.jsii.JsiiSerializable

Contains asset property information.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 AssetPropertyProperty assetPropertyProperty = AssetPropertyProperty.builder()
         .logicalId("logicalId")
         // the properties below are optional
         .alias("alias")
         .notificationState("notificationState")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAsset.AssetPropertyProperty.Builder A builder for CfnAsset.AssetPropertyProperty
static class	CfnAsset.AssetPropertyProperty.Jsii$Proxy An implementation for CfnAsset.AssetPropertyProperty

Method Summary

Modifier and Type	Method and Description
static CfnAsset.AssetPropertyProperty.Builder	builder()
default String	getAlias() The property alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature` ).
String	getLogicalId() The `LogicalID` of the asset property.
default String	getNotificationState() The MQTT notification state (enabled or disabled) for this asset property.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLogicalId

@Stability(value=Stable)
 @NotNull
String getLogicalId()

The `LogicalID` of the asset property.

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

getAlias

@Stability(value=Stable)
 @Nullable
default String getAlias()

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

The property alias must have 1-1000 characters.

getNotificationState

@Stability(value=Stable)
 @Nullable
default String getNotificationState()

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 .

builder

@Stability(value=Stable)
static CfnAsset.AssetPropertyProperty.Builder builder()

Returns:

a CfnAsset.AssetPropertyProperty.Builder of CfnAsset.AssetPropertyProperty