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

Class: Aws::IoTEvents::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:

{
  delivery_stream_name: "DeliveryStreamName", # required
  separator: "FirehoseSeparator",
  payload: {
    content_expression: "ContentExpression", # required
    type: "STRING", # required, accepts STRING, JSON
  },
}

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_stream_name ⇒ String

The name of the Kinesis Data Firehose delivery stream where the data is written.

Returns:

  • (String) —

    The name of the Kinesis Data Firehose delivery stream where the data is written.

#payload ⇒ Types::Payload

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

Returns:

  • (Types::Payload) —

    You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

#separator ⇒ String

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: \'\n\' (newline), \'\t\' (tab), \'\r\n\' (Windows newline), \',\' (comma).

Returns:

  • (String) —

    A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.