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

Class: Aws::Firehose::Types::ExtendedS3DestinationConfiguration

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

Overview

Note:

When passing ExtendedS3DestinationConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  role_arn: "RoleARN", # required
  bucket_arn: "BucketARN", # required
  prefix: "Prefix",
  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_configuration: {
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    prefix: "Prefix",
    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",
    },
  },
}

Describes the configuration of a destination in Amazon S3.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket.

Returns:

  • (String)

    The ARN of the S3 bucket.

#buffering_hintsTypes::BufferingHints

The buffering option.

Returns:

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Returns:

#compression_formatString

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

Possible values:

  • UNCOMPRESSED
  • GZIP
  • ZIP
  • Snappy

Returns:

  • (String)

    The compression format.

#encryption_configurationTypes::EncryptionConfiguration

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

Returns:

#prefixString

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered 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 Firehose Developer Guide.

Returns:

  • (String)

    The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files.

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.

Returns:

#role_arnString

The ARN of the AWS credentials.

Returns:

  • (String)

    The ARN of the AWS credentials.

#s3_backup_configurationTypes::S3DestinationConfiguration

The configuration for backup in Amazon S3.

Returns:

#s3_backup_modeString

The Amazon S3 backup mode.

Possible values:

  • Disabled
  • Enabled

Returns:

  • (String)

    The Amazon S3 backup mode.