Class: Aws::Firehose::Types::S3DestinationConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::S3DestinationConfiguration
- Defined in:
- gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass S3DestinationConfiguration data as a hash:
{
role_arn: "RoleARN", # required
bucket_arn: "BucketARN", # required
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, HADOOP_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",
},
}
Describes the configuration of a destination in Amazon S3.
Constant Summary collapse
- SENSITIVE =
[]
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 CloudWatch logging options for your delivery stream.
-
#compression_format ⇒ String
The compression format.
-
#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.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS credentials.
Instance Attribute Details
#bucket_arn ⇒ String
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#buffering_hints ⇒ Types::BufferingHints
The buffering option. If no value is specified, BufferingHints
object default values are used.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#compression_format ⇒ String
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be specified for
Amazon Redshift destinations because they are not supported by the
Amazon Redshift COPY
operation that reads from the S3 bucket.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#encryption_configuration ⇒ Types::EncryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) 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.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) 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.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] 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.
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4732 class S3DestinationConfiguration < Struct.new( :role_arn, :bucket_arn, :prefix, :error_output_prefix, :buffering_hints, :compression_format, :encryption_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |