Package software.amazon.awscdk.services.iot

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.IotAnalyticsActionProperty.Builder	builder()
default Object	getBatchMode()	Whether to process the action as a batch.
String	getChannelName()	The name of the IoT Analytics channel to which message data will be sent.
String	getRoleArn()	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

@Stability(Stable)
@NotNull
String getChannelName()

The name of the IoT Analytics channel to which message data will be sent.

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

See Also:

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

getBatchMode

@Stability(Stable)
@Nullable
default Object getBatchMode()

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

See Also:

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

builder

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

Returns:

a CfnTopicRule.IotAnalyticsActionProperty.Builder of CfnTopicRule.IotAnalyticsActionProperty