Interface CfnTopicRule.IotAnalyticsActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTopicRule.IotAnalyticsActionProperty.Jsii$Proxy
- Enclosing class:
- CfnTopicRule
@Stability(Stable)
public static interface CfnTopicRule.IotAnalyticsActionProperty
extends software.amazon.jsii.JsiiSerializable
Sends message data to an AWS IoT Analytics channel.
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.*; IotAnalyticsActionProperty iotAnalyticsActionProperty = IotAnalyticsActionProperty.builder() .channelName("channelName") .roleArn("roleArn") // the properties below are optional .batchMode(false) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTopicRule.IotAnalyticsActionProperty
static final class
An implementation forCfnTopicRule.IotAnalyticsActionProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Whether to process the action as a batch.The name of the IoT Analytics channel to which message data will be sent.The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getChannelName
The name of the IoT Analytics channel to which message data will be sent. -
getRoleArn
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage). -
getBatchMode
Whether to process the action as a batch. The default value isfalse
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages. -
builder
-