AWS::IoT::TopicRule IotAnalyticsAction - 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 IotAnalyticsAction

Sends message data to an Amazon IoT Analytics channel.

Syntax

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

JSON

{ "BatchMode" : Boolean, "ChannelName" : String, "RoleArn" : String }

YAML

BatchMode: Boolean ChannelName: String RoleArn: String

Properties

BatchMode

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

Required: No

Type: Boolean

Update requires: No interruption

ChannelName

The name of the IoT Analytics channel to which message data will be sent.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Required: Yes

Type: String

Update requires: No interruption

See also