Class: Aws::Firehose::Types::ExtendedS3DestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::ExtendedS3DestinationUpdate
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass ExtendedS3DestinationUpdate data as a hash:
{
role_arn: "RoleARN",
bucket_arn: "BucketARN",
prefix: "Prefix",
error_output_prefix: "ErrorOutputPrefix",
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
encryption_configuration: {
no_encryption_config: "NoEncryption", # accepts NoEncryption
kms_encryption_config: {
awskms_key_arn: "AWSKMSKeyARN", # required
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
processing_configuration: {
enabled: false,
processors: [
{
type: "Lambda", # required, accepts Lambda
parameters: [
{
parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds
parameter_value: "ProcessorParameterValue", # required
},
],
},
],
},
s3_backup_mode: "Disabled", # accepts Disabled, Enabled
s3_backup_update: {
role_arn: "RoleARN",
bucket_arn: "BucketARN",
prefix: "Prefix",
error_output_prefix: "ErrorOutputPrefix",
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
encryption_configuration: {
no_encryption_config: "NoEncryption", # accepts NoEncryption
kms_encryption_config: {
awskms_key_arn: "AWSKMSKeyARN", # required
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
},
data_format_conversion_configuration: {
schema_configuration: {
role_arn: "NonEmptyStringWithoutWhitespace",
catalog_id: "NonEmptyStringWithoutWhitespace",
database_name: "NonEmptyStringWithoutWhitespace",
table_name: "NonEmptyStringWithoutWhitespace",
region: "NonEmptyStringWithoutWhitespace",
version_id: "NonEmptyStringWithoutWhitespace",
},
input_format_configuration: {
deserializer: {
open_x_json_ser_de: {
convert_dots_in_json_keys_to_underscores: false,
case_insensitive: false,
column_to_json_key_mappings: {
"NonEmptyStringWithoutWhitespace" => "NonEmptyString",
},
},
hive_json_ser_de: {
timestamp_formats: ["NonEmptyString"],
},
},
},
output_format_configuration: {
serializer: {
parquet_ser_de: {
block_size_bytes: 1,
page_size_bytes: 1,
compression: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, SNAPPY
enable_dictionary_compression: false,
max_padding_bytes: 1,
writer_version: "V1", # accepts V1, V2
},
orc_ser_de: {
stripe_size_bytes: 1,
block_size_bytes: 1,
row_index_stride: 1,
enable_padding: false,
padding_tolerance: 1.0,
compression: "NONE", # accepts NONE, ZLIB, SNAPPY
bloom_filter_columns: ["NonEmptyStringWithoutWhitespace"],
bloom_filter_false_positive_probability: 1.0,
dictionary_key_threshold: 1.0,
format_version: "V0_11", # accepts V0_11, V0_12
},
},
},
enabled: false,
},
}
Describes an update for a destination in Amazon S3.
Instance Attribute Summary collapse
-
#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_mode ⇒ String
Enables or disables Amazon S3 backup mode.
-
#s3_backup_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination for backup.
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
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#buffering_hints ⇒ Types::BufferingHints
The buffering option.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#compression_format ⇒ String
The compression format. If no value is specified, the default is ‘UNCOMPRESSED`.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :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.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :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.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :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.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :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
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :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
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#s3_backup_mode ⇒ String
Enables or disables Amazon S3 backup mode.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |
#s3_backup_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination for backup.
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/aws-sdk-firehose/types.rb', line 1875 class ExtendedS3DestinationUpdate < 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_update, :data_format_conversion_configuration) include Aws::Structure end |