Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.IotSiteWiseActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.IotSiteWiseActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.IotSiteWiseActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

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.iot.*;
 IotSiteWiseActionProperty iotSiteWiseActionProperty = IotSiteWiseActionProperty.builder()
         .putAssetPropertyValueEntries(List.of(PutAssetPropertyValueEntryProperty.builder()
                 .propertyValues(List.of(AssetPropertyValueProperty.builder()
                         .timestamp(AssetPropertyTimestampProperty.builder()
                                 .timeInSeconds("timeInSeconds")
                                 // the properties below are optional
                                 .offsetInNanos("offsetInNanos")
                                 .build())
                         .value(AssetPropertyVariantProperty.builder()
                                 .booleanValue("booleanValue")
                                 .doubleValue("doubleValue")
                                 .integerValue("integerValue")
                                 .stringValue("stringValue")
                                 .build())
                         // the properties below are optional
                         .quality("quality")
                         .build()))
                 // the properties below are optional
                 .assetId("assetId")
                 .entryId("entryId")
                 .propertyAlias("propertyAlias")
                 .propertyId("propertyId")
                 .build()))
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.IotSiteWiseActionProperty.Builder	builder()
Object	getPutAssetPropertyValueEntries()	A list of asset property value entries.
String	getRoleArn()	The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPutAssetPropertyValueEntries

@Stability(Stable)
@NotNull
Object getPutAssetPropertyValueEntries()

A list of asset property value entries.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-putassetpropertyvalueentries

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise.

( "Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-rolearn

builder

@Stability(Stable)
static CfnTopicRule.IotSiteWiseActionProperty.Builder builder()

Returns:

a CfnTopicRule.IotSiteWiseActionProperty.Builder of CfnTopicRule.IotSiteWiseActionProperty