Class: Aws::Firehose::Types::ExtendedS3DestinationConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Describes the configuration of 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)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#buffering_hintsTypes::BufferingHints

The buffering option.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#compression_formatString

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

Returns:

  • (String)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#custom_time_zoneString

The time zone you prefer. UTC is the default.

Returns:

  • (String)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#data_format_conversion_configurationTypes::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.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#dynamic_partitioning_configurationTypes::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.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#encryption_configurationTypes::EncryptionConfiguration

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



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

class ExtendedS3DestinationConfiguration < 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_configuration,
  :data_format_conversion_configuration,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#file_extensionString

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

Returns:

  • (String)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

class ExtendedS3DestinationConfiguration < 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_configuration,
  :data_format_conversion_configuration,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

class ExtendedS3DestinationConfiguration < 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_configuration,
  :data_format_conversion_configuration,
  :dynamic_partitioning_configuration,
  :file_extension,
  :custom_time_zone)
  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)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#s3_backup_configurationTypes::S3DestinationConfiguration

The configuration for backup in Amazon S3.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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

#s3_backup_modeString

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Returns:

  • (String)


1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1823

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