AWS::IoT::TopicRule IotEventsAction - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoT::TopicRule IotEventsAction

Sends an input to an AWS IoT Events detector.

Syntax

To declare this entity in your AWS 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 AWS IoT Events input.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

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

Required: No

Type: String

Maximum: 128

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Update requires: No interruption