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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
  error_output_prefix: "ErrorOutputPrefix",
  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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arn ⇒ String

The ARN of the S3 bucket. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#buffering_hints ⇒ Types::BufferingHints

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

Returns:



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Returns:



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#compression_format ⇒ String

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) 


3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#error_output_prefix ⇒ String

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.

Returns:

  • (String) 


3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#prefix ⇒ String

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon 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 Data Firehose Developer Guide*.

[1]: docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name

Returns:

  • (String) 


3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/aws-sdk-firehose/types.rb', line 3186

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