AWS::IoT::TopicRule FirehoseAction

Describes an action that writes data to an Amazon Kinesis Firehose stream.

Syntax

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

JSON

{
  "BatchMode" : Boolean,
  "DeliveryStreamName" : String,
  "RoleArn" : String,
  "Separator" : String
}

YAML

  BatchMode: Boolean
  DeliveryStreamName: String
  RoleArn: String
  Separator: String

Properties

BatchMode

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch. The default value is false.

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can't have more than 500 records.

Required: No

Type: Boolean

Update requires: No interruption

DeliveryStreamName

The delivery stream name.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

The IAM role that grants access to the Amazon Kinesis Firehose stream.

Required: Yes

Type: String

Update requires: No interruption

Separator

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

Required: No

Type: String

Pattern: ([\n\t])|(\r\n)|(,)

Update requires: No interruption