Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.IotEventsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.IotEventsActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

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

Sends an input to an AWS IoT Events detector.

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.*;
 IotEventsActionProperty iotEventsActionProperty = IotEventsActionProperty.builder()
         .inputName("inputName")
         .roleArn("roleArn")
         // the properties below are optional
         .batchMode(false)
         .messageId("messageId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.IotEventsActionProperty.Builder	builder()
default Object	getBatchMode()	Whether to process the event actions as a batch.
String	getInputName()	The name of the AWS IoT Events input.
default String	getMessageId()	The ID of the message.
String	getRoleArn()	The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputName

@Stability(Stable)
@NotNull
String getInputName()

The name of the AWS IoT Events input.

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.

("Action":"iotevents:BatchPutMessage").

See Also:

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

getBatchMode

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

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

When batchMode is true , you can't specify a messageId .

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

See Also:

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

getMessageId

@Stability(Stable)
@Nullable
default String getMessageId()

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

See Also:

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

builder

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

Returns:

a CfnTopicRule.IotEventsActionProperty.Builder of CfnTopicRule.IotEventsActionProperty