Class CfnAsset.AssetPropertyProperty.Builder
java.lang.Object
software.amazon.awscdk.services.iotsitewise.CfnAsset.AssetPropertyProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAsset.AssetPropertyProperty>
- Enclosing interface:
CfnAsset.AssetPropertyProperty
@Stability(Stable)
public static final class CfnAsset.AssetPropertyProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAsset.AssetPropertyProperty>
A builder for
CfnAsset.AssetPropertyProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnAsset.AssetPropertyProperty.getAlias()
build()
Builds the configured instance.Sets the value ofCfnAsset.AssetPropertyProperty.getLogicalId()
notificationState
(String notificationState) Sets the value ofCfnAsset.AssetPropertyProperty.getNotificationState()
Sets the value ofCfnAsset.AssetPropertyProperty.getUnit()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
logicalId
Sets the value ofCfnAsset.AssetPropertyProperty.getLogicalId()
- Parameters:
logicalId
- TheLogicalID
of the asset property. This parameter is required. The maximum length is 256 characters, with the pattern[^\ u0000-\ u001F\ u007F]+
.- Returns:
this
-
alias
Sets the value ofCfnAsset.AssetPropertyProperty.getAlias()
- Parameters:
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
). 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.
- Returns:
this
-
notificationState
@Stability(Stable) public CfnAsset.AssetPropertyProperty.Builder notificationState(String notificationState) Sets the value ofCfnAsset.AssetPropertyProperty.getNotificationState()
- Parameters:
notificationState
- The MQTT notification state (ENABLED
orDISABLED
) for this asset property. When the notification state isENABLED
, 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.
- Returns:
this
-
unit
Sets the value ofCfnAsset.AssetPropertyProperty.getUnit()
- Parameters:
unit
- The unit (such asNewtons
orRPM
) of the asset property.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAsset.AssetPropertyProperty>
- Returns:
- a new instance of
CfnAsset.AssetPropertyProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-