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

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.

• #custom_time_zone ⇒ String

  The time zone you prefer.

• #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.

• #dynamic_partitioning_configuration ⇒ Types::DynamicPartitioningConfiguration

  The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys.

• #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.

• #file_extension ⇒ String

  Specify a file extension.

• #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 Amazon Web Services 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 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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#buffering_hints ⇒ Types::BufferingHints

The buffering option.

Returns:

• (Types::BufferingHints)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#custom_time_zone ⇒ String

The time zone you prefer. UTC is the default.

Returns:

• (String)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#dynamic_partitioning_configuration ⇒ Types::DynamicPartitioningConfiguration

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

Returns:

• (Types::DynamicPartitioningConfiguration)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#file_extension ⇒ String

Specify a file extension. It will override the default file extension

Returns:

• (String)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  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 2291

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_mode ⇒ String

The Amazon S3 backup mode.

Returns:

• (String)

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

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,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  SENSITIVE = []
  include Aws::Structure
end