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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAsset.AssetPropertyProperty
static final class
An implementation forCfnAsset.AssetPropertyProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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
The external ID of the property.default String
getId()
The ID of the asset property.default String
TheLogicalID
of the asset property.default String
The MQTT notification state (enabled or disabled) for this asset property.default String
getUnit()
The unit (such asNewtons
orRPM
) of the asset property.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
getExternalId
The external ID of the property.For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
- See Also:
-
getId
The ID of the asset property.This is a return value and can't be set.
- See Also:
-
getLogicalId
TheLogicalID
of the asset property.- See Also:
-
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:
-
getUnit
The unit (such asNewtons
orRPM
) of the asset property.- See Also:
-
builder
-