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

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


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_hintsTypes::BufferingHints

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



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_formatString

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

Returns:

  • (String)


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_configurationTypes::EncryptionConfiguration

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



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_prefixString

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)


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_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 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)


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

class S3DestinationDescription < 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_arnString

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)


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
# File 'lib/aws-sdk-firehose/types.rb', line 3259

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