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

Class: Aws::Firehose::Types::S3DestinationUpdate

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing S3DestinationUpdate as input to an Aws::Client method, you can use a vanilla 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, 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 an update for a destination in Amazon S3.

Returned by:

See Also:

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 AWS Service Namespaces.

Returns:

  • (String) —

    The ARN of the S3 bucket.

#buffering_hints ⇒ Types::BufferingHints

The buffering option. If no value is specified, BufferingHints object default values are used.

Returns:

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Returns:

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

Possible values:

  • UNCOMPRESSED
  • GZIP
  • ZIP
  • Snappy
  • HADOOP_SNAPPY

Returns:

  • (String) —

    The compression format.

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:

#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) —

    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. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

Returns:

  • (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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS credentials.