AWS::IoT::TopicRule IotEventsAction - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoT::TopicRule IotEventsAction

Sends an input to an Amazon IoT Events detector.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "BatchMode" : Boolean, "InputName" : String, "MessageId" : String, "RoleArn" : String }

YAML

BatchMode: Boolean InputName: String MessageId: String RoleArn: String

Properties

BatchMode

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.

Required: No

Type: Boolean

Update requires: No interruption

InputName

The name of the Amazon IoT Events input.

Required: Yes

Type: String

Update requires: No interruption

MessageId

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 Amazon IoT Events detector.

Required: No

Type: String

Update requires: No interruption

RoleArn

The ARN of the role that grants Amazon IoT permission to send an input to an Amazon IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Required: Yes

Type: String

Update requires: No interruption