Class: Aws::Firehose::Types::ExtendedS3DestinationDescription

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::ExtendedS3DestinationDescription

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Describes a destination in Amazon S3.

See Also:

• AWS API Documentation

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 delivery stream.

• #compression_format ⇒ String

  The compression format.

• #data_format_conversion_configuration ⇒ Types::DataFormatConversionConfiguration

  The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  The encryption configuration.

• #error_output_prefix ⇒ String

  A prefix that Kinesis Data 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.

• #processing_configuration ⇒ Types::ProcessingConfiguration

  The data processing configuration.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the AWS credentials.

• #s3_backup_description ⇒ Types::S3DestinationDescription

  The configuration for backup in Amazon S3.

• #s3_backup_mode ⇒ String

  The Amazon S3 backup mode.

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)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#buffering_hints ⇒ Types::BufferingHints

The buffering option.

Returns:

• (Types::BufferingHints)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:

• (Types::CloudWatchLoggingOptions)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  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 1669

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#data_format_conversion_configuration ⇒ Types::DataFormatConversionConfiguration

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

Returns:

• (Types::DataFormatConversionConfiguration)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  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 1669

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  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)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  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)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  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)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#s3_backup_description ⇒ Types::S3DestinationDescription

The configuration for backup in Amazon S3.

Returns:

• (Types::S3DestinationDescription)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end

#s3_backup_mode ⇒ String

The Amazon S3 backup mode.

Returns:

• (String)

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

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_description,
  :data_format_conversion_configuration)
  include Aws::Structure
end