You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Describes a destination in Amazon S3.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String)


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_hintsTypes::BufferingHints

The buffering option.



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_formatString

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

Returns:

  • (String)


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_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.



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_configurationTypes::EncryptionConfiguration

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



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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

#prefixString

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.

Returns:

  • (String)


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_configurationTypes::ProcessingConfiguration

The data processing configuration.



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_arnString

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String)


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_descriptionTypes::S3DestinationDescription

The configuration for backup in Amazon S3.



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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_modeString

The Amazon S3 backup mode.

Returns:

  • (String)


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1601

class ExtendedS3DestinationDescription < Struct.new(
  :role_arn,
  :bucket_arn,
  :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