Package 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(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()
         .alias("alias")
         .externalId("externalId")
         .id("id")
         .logicalId("logicalId")
         .notificationState("notificationState")
         .unit("unit")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

The external ID of the property.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid

getId

@Stability(Stable)
@Nullable
default String getId()

The ID of the asset property.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id

getLogicalId

@Stability(Stable)
@Nullable
default String getLogicalId()

The LogicalID of the asset property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid

getNotificationState

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate

getUnit

@Stability(Stable)
@Nullable
default String getUnit()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-unit

builder

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

Returns:

a CfnAsset.AssetPropertyProperty.Builder of CfnAsset.AssetPropertyProperty