# FirehoseAction


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

## Contents


 ** deliveryStreamName **   <a name="iot-Type-FirehoseAction-deliveryStreamName"></a>
The delivery stream name.  
Type: String  
Required: Yes

 ** roleArn **   <a name="iot-Type-FirehoseAction-roleArn"></a>
The IAM role that grants access to the Amazon Kinesis Firehose stream.  
Type: String  
Required: Yes

 ** batchMode **   <a name="iot-Type-FirehoseAction-batchMode"></a>
Whether to deliver the Kinesis Data Firehose stream as a batch by using [https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html). 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 [https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) request. The resulting array can't have more than 500 records.  
Type: Boolean  
Required: No

 ** separator **   <a name="iot-Type-FirehoseAction-separator"></a>
A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\$1n' (newline), '\$1t' (tab), '\$1r\$1n' (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 AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/FirehoseAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/FirehoseAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iot-2015-05-28/FirehoseAction)