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

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

Overview

Note:

When making an API call, you may pass S3DestinationUpdate 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",
  },
}

Describes an update for a destination in Amazon S3.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

The ARN of the S3 bucket. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)

4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#buffering_hintsTypes::BufferingHints

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


4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.


4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#compression_formatString

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.

Returns:

  • (String)

4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#encryption_configurationTypes::EncryptionConfiguration

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


4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#error_output_prefixString

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

[1]: docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

Returns:

  • (String)

4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#prefixString

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

[1]: docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

Returns:

  • (String)

4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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

#role_arnString

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)

4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/aws-sdk-firehose/types.rb', line 4914

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