Class: Aws::Firehose::Types::ExtendedS3DestinationUpdate

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

Overview

Note:

When making an API call, you may pass ExtendedS3DestinationUpdate data as a 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",
  },
  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_update: {
    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",
    },
  },
  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 an update for a destination in Amazon S3.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#buffering_hints ⇒ Types::BufferingHints

The buffering option.

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#compression_format ⇒ String

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

Returns:

  • (String) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  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.

Returns:

  • (String) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  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.

Returns:

  • (String) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  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.

Returns:

  • (String) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_mode ⇒ String

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Returns:

  • (String) 


2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_update ⇒ Types::S3DestinationUpdate

The Amazon S3 destination for backup.

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2204

class ExtendedS3DestinationUpdate < Struct.new(
  :role_arn,
  :bucket_arn,
  :prefix,
  :error_output_prefix,
  :buffering_hints,
  :compression_format,
  :encryption_configuration,
  :cloud_watch_logging_options,
  :processing_configuration,
  :s3_backup_mode,
  :s3_backup_update,
  :data_format_conversion_configuration)
  SENSITIVE = []
  include Aws::Structure
end