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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::S3DestinationDescription

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Describes a destination in Amazon S3.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_arn ⇒ String

  The ARN of the S3 bucket.

• #buffering_hints ⇒ Types::BufferingHints

  The buffering option.

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  The Amazon CloudWatch logging options for your Firehose stream.

• #compression_format ⇒ String

  The compression format.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  The encryption configuration.

• #error_output_prefix ⇒ String

  A prefix that Firehose evaluates and adds to failed records before writing them to S3.

• #prefix ⇒ String

  The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

Instance Attribute Details

#bucket_arn ⇒ String

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

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_hints ⇒ Types::BufferingHints

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

Returns:

• (Types::BufferingHints)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

Returns:

• (Types::CloudWatchLoggingOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_format ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_configuration ⇒ Types::EncryptionConfiguration

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

Returns:

• (Types::EncryptionConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_prefix ⇒ String

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

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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

#prefix ⇒ String

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)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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_arn ⇒ String

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

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4314

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