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

Class: Aws::Firehose::Types::S3DestinationConfiguration

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

Overview

Note:

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

{
  role_arn: "RoleARN", # required
  bucket_arn: "BucketARN", # required
  prefix: "Prefix",
  buffering_hints: {
    size_in_m_bs: 1,
    interval_in_seconds: 1,
  },
  compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
  encryption_configuration: {
    no_encryption_config: "NoEncryption", # accepts NoEncryption
    kms_encryption_config: {
      awskms_key_arn: "AWSKMSKeyARN", # required
    },
  },
  cloud_watch_logging_options: {
    enabled: false,
    log_group_name: "LogGroupName",
    log_stream_name: "LogStreamName",
  },
}

Describes the configuration of a destination in Amazon S3.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket.

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

class S3DestinationConfiguration < 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.



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

class S3DestinationConfiguration < 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.



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

class S3DestinationConfiguration < 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.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

class S3DestinationConfiguration < 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.



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

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


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

class S3DestinationConfiguration < 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)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2205

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