Interface CfnTopicRule.IotEventsActionProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnTopicRule.IotEventsActionProperty extends
Sends an input to an AWS IoT Events detector.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 IotEventsActionProperty iotEventsActionProperty = IotEventsActionProperty.builder()
         // the properties below are optional
  • Method Details

    • getInputName

      @Stability(Stable) @NotNull String getInputName()
      The name of the AWS IoT Events input.
    • 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.


    • 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.

    • 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.

    • builder

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