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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTopicRule.IotEventsActionProperty
static final class
An implementation forCfnTopicRule.IotEventsActionProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInputName
The name of the AWS IoT Events input.- See Also:
-
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:
-
getBatchMode
Whether to process the event actions as a batch. The default value isfalse
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- See Also:
-
getMessageId
The ID of the message. The defaultmessageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--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:
-
builder
-