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.

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 AWS Service Namespaces].

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

Returns:

  • (String)

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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.


4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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.


4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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)

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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.


4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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 Kinesis Data 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].

[1]: docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

Returns:

  • (String)

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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].

[1]: docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

Returns:

  • (String)

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'lib/aws-sdk-firehose/types.rb', line 4808

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