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

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",
  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
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  s3_backup_mode: "Disabled", # accepts Disabled, Enabled
  s3_backup_update: {
    role_arn: "RoleARN",
    bucket_arn: "BucketARN",
    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 an update for a destination in Amazon S3.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#buffering_hintsTypes::BufferingHints

The buffering option.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#compression_formatString

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

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#encryption_configurationTypes::EncryptionConfiguration

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



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

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


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#role_arnString

The ARN of the AWS credentials.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#s3_backup_modeString

Enables or disables Amazon S3 backup mode.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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

#s3_backup_updateTypes::S3DestinationUpdate

The Amazon S3 destination for backup.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1349

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