FirehoseAction - Amazon IoT
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.

FirehoseAction

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

Contents

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.

Type: Boolean

Required: No

deliveryStreamName

The delivery stream name.

Type: String

Required: Yes

roleArn

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

Type: String

Required: Yes

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

Type: String

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

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: