Class: Aws::IoTEvents::Types::FirehoseAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb

Overview

Note:

When making an API call, you may pass FirehoseAction data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_stream_nameString

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

Returns:

  • (String)


2172
2173
2174
2175
2176
2177
2178
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2172

class FirehoseAction < Struct.new(
  :delivery_stream_name,
  :separator,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#payloadTypes::Payload

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

Returns:



2172
2173
2174
2175
2176
2177
2178
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2172

class FirehoseAction < Struct.new(
  :delivery_stream_name,
  :separator,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#separatorString

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)


2172
2173
2174
2175
2176
2177
2178
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2172

class FirehoseAction < Struct.new(
  :delivery_stream_name,
  :separator,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end