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

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

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

Overview

Note:

When making an API call, you may pass FirehoseAction data as a hash:

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_stream_nameString

The delivery stream name.

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1620

class FirehoseAction < Struct.new(
  :role_arn,
  :delivery_stream_name,
  :separator)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1620

class FirehoseAction < Struct.new(
  :role_arn,
  :delivery_stream_name,
  :separator)
  include Aws::Structure
end

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


1620
1621
1622
1623
1624
1625
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1620

class FirehoseAction < Struct.new(
  :role_arn,
  :delivery_stream_name,
  :separator)
  include Aws::Structure
end