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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

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

Returns:

  • (String)


3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#buffering_hintsTypes::BufferingHints

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



3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#compression_formatString

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

Returns:

  • (String)


3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#encryption_configurationTypes::EncryptionConfiguration

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



3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#error_output_prefixString

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

Returns:

  • (String)


3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#prefixString

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

Returns:

  • (String)


3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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

#role_arnString

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

Returns:

  • (String)


3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3645

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