Skip to content

FirehoseAction

Source code in docs_src/capo_iot/types/firehose_action.py 
16
17
18
19
20
21
22
23
24
class FirehoseAction(TypedDict, closed=True):
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The IAM role that grants access to the Amazon Kinesis Firehose stream.</p>"""
    delivery_stream_name: "capo_iot.types.delivery_stream_name.DeliveryStreamName"
    """<p>The delivery stream name.</p>"""
    separator: NotRequired["capo_iot.types.firehose_separator.FirehoseSeparator"]
    r"""<p>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).</p>"""
    batch_mode: NotRequired["capo_iot.types.batch_mode.BatchMode"]
    """<p>Whether to deliver the Kinesis Data Firehose stream as a batch by using <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html"> <code>PutRecordBatch</code> </a>. The default value is <code>false</code>.</p> <p>When <code>batchMode</code> is <code>true</code> and the rule's SQL statement evaluates to an Array, each Array element forms one record in the <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html"> <code>PutRecordBatch</code> </a> request. The resulting array can't have more than 500 records.</p>"""

batch_mode instance-attribute 

batch_mode: NotRequired[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.

delivery_stream_name instance-attribute 

delivery_stream_name: DeliveryStreamName

The delivery stream name.

role_arn instance-attribute 

role_arn: AwsArn

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

separator instance-attribute 

separator: NotRequired[FirehoseSeparator]

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