Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.IotEventsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.IotEventsActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.services.iot.*;
 IotEventsActionProperty iotEventsActionProperty = IotEventsActionProperty.builder()
         .batchMode(false)
         .inputName("inputName")
         .messageId("messageId")
         .roleArn("roleArn")
         .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	CfnTopicRulePropsMixin.IotEventsActionProperty.Builder	A builder for CfnTopicRulePropsMixin.IotEventsActionProperty
static final class	CfnTopicRulePropsMixin.IotEventsActionProperty.Jsii$Proxy	An implementation for CfnTopicRulePropsMixin.IotEventsActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRulePropsMixin.IotEventsActionProperty.Builder	builder()
default Object	getBatchMode()	Whether to process the event actions as a batch.
default Object	getInputName()	The name of the AWS IoT Events input.
default String	getMessageId()	The ID of the message.
default Object	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

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.

Returns union: either Boolean or IResolvable

See Also:

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

getInputName

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

The name of the AWS IoT Events input.

Returns union: either String or IInputRef

See Also:

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

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

getRoleArn

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

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

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

Returns union: either String or IRoleRef

See Also:

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

builder

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

Returns:

a CfnTopicRulePropsMixin.IotEventsActionProperty.Builder of CfnTopicRulePropsMixin.IotEventsActionProperty