Class: Aws::Firehose::Types::ExtendedS3DestinationUpdate

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

Overview

Describes an update for a destination in Amazon S3.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#buffering_hints ⇒ Types::BufferingHints

The buffering option.

Returns:



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#compression_format ⇒ String

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

Returns:

  • (String) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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,
  :dynamic_partitioning_configuration)
  SENSITIVE = []
  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. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

Returns:

  • (String) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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,
  :dynamic_partitioning_configuration)
  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.

Returns:

  • (String) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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,
  :dynamic_partitioning_configuration)
  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.

Returns:

  • (String) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#s3_backup_mode ⇒ String

You can update a delivery stream 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) 


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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

#s3_backup_update ⇒ Types::S3DestinationUpdate

The Amazon S3 destination for backup.

Returns:



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1927

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