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

Class: Aws::Firehose::Types::S3DestinationDescription

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

Overview

Describes a destination in Amazon S3.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket.

Returns:

  • (String)


2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#buffering_hintsTypes::BufferingHints

The buffering option. If no value is specified, BufferingHints object default values are used.



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#compression_formatString

The compression format. If no value is specified, the default is UNCOMPRESSED.

Returns:

  • (String)


2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

The encryption configuration. If no value is specified, the default is no encryption.



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#prefixString

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

Returns:

  • (String)


2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#role_arnString

The ARN of the AWS credentials.

Returns:

  • (String)


2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2118

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end