Skip to content

/AWS1/CL_IOTFIREHOSEACTION

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_rolearn TYPE /AWS1/IOTAWSARN /AWS1/IOTAWSARN

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

iv_deliverystreamname TYPE /AWS1/IOTDELIVERYSTREAMNAME /AWS1/IOTDELIVERYSTREAMNAME

The delivery stream name.

Optional arguments:

iv_separator TYPE /AWS1/IOTFIREHOSESEPARATOR /AWS1/IOTFIREHOSESEPARATOR

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

iv_batchmode TYPE /AWS1/IOTBATCHMODE /AWS1/IOTBATCHMODE

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.

Queryable Attributes

roleArn

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

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

deliveryStreamName

The delivery stream name.

Accessible with the following methods

Method Description
GET_DELIVERYSTREAMNAME() Getter for DELIVERYSTREAMNAME, with configurable default
ASK_DELIVERYSTREAMNAME() Getter for DELIVERYSTREAMNAME w/ exceptions if field has no
HAS_DELIVERYSTREAMNAME() Determine if DELIVERYSTREAMNAME has a value

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

Accessible with the following methods

Method Description
GET_SEPARATOR() Getter for SEPARATOR, with configurable default
ASK_SEPARATOR() Getter for SEPARATOR w/ exceptions if field has no value
HAS_SEPARATOR() Determine if SEPARATOR has a value

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.

Accessible with the following methods

Method Description
GET_BATCHMODE() Getter for BATCHMODE, with configurable default
ASK_BATCHMODE() Getter for BATCHMODE w/ exceptions if field has no value
HAS_BATCHMODE() Determine if BATCHMODE has a value