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",
  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",
  },
  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",
    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",
    },
  },
  data_format_conversion_configuration: {
    schema_configuration: {
      role_arn: "NonEmptyStringWithoutWhitespace",
      catalog_id: "NonEmptyStringWithoutWhitespace",
      database_name: "NonEmptyStringWithoutWhitespace",
      table_name: "NonEmptyStringWithoutWhitespace",
      region: "NonEmptyStringWithoutWhitespace",
      version_id: "NonEmptyStringWithoutWhitespace",
    },
    input_format_configuration: {
      deserializer: {
        open_x_json_ser_de: {
          convert_dots_in_json_keys_to_underscores: false,
          case_insensitive: false,
          column_to_json_key_mappings: {
            "NonEmptyStringWithoutWhitespace" => "NonEmptyString",
          },
        },
        hive_json_ser_de: {
          timestamp_formats: ["NonEmptyString"],
        },
      },
    },
    output_format_configuration: {
      serializer: {
        parquet_ser_de: {
          block_size_bytes: 1,
          page_size_bytes: 1,
          compression: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, SNAPPY
          enable_dictionary_compression: false,
          max_padding_bytes: 1,
          writer_version: "V1", # accepts V1, V2
        },
        orc_ser_de: {
          stripe_size_bytes: 1,
          block_size_bytes: 1,
          row_index_stride: 1,
          enable_padding: false,
          padding_tolerance: 1.0,
          compression: "NONE", # accepts NONE, ZLIB, SNAPPY
          bloom_filter_columns: ["NonEmptyStringWithoutWhitespace"],
          bloom_filter_false_positive_probability: 1.0,
          dictionary_key_threshold: 1.0,
          format_version: "V0_11", # accepts V0_11, V0_12
        },
      },
    },
    enabled: false,
  },
}

Describes the configuration of 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.

Returns:

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:

#compression_format ⇒ String

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

Possible values:

  • UNCOMPRESSED
  • GZIP
  • ZIP
  • Snappy
  • HADOOP_SNAPPY

Returns:

  • (String) —

    The compression format.

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

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

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

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

#s3_backup_configuration ⇒ Types::S3DestinationConfiguration

The configuration for backup in Amazon S3.

Returns:

#s3_backup_mode ⇒ String

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can\'t update the delivery stream to disable it.

Possible values:

  • Disabled
  • Enabled

Returns:

  • (String) —

    The Amazon S3 backup mode.