AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::FirehoseAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FirehoseAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  role_arn: "AwsArn", # required
  delivery_stream_name: "DeliveryStreamName", # required
  separator: "FirehoseSeparator",
  batch_mode: false,
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_modeBoolean

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.

Returns:

  • (Boolean)

    Whether to deliver the Kinesis Data Firehose stream as a batch by using [ PutRecordBatch ][1].

#delivery_stream_nameString

The delivery stream name.

Returns:

  • (String)

    The delivery stream name.

#role_arnString

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

Returns:

  • (String)

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

#separatorString

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

Returns:

  • (String)

    A character separator that will be used to separate records written to the Firehose stream.