Amazon Kinesis Data Firehose API Reference
API Reference (API Version 2015-08-04)

S3DestinationUpdate

Describes an update for a destination in Amazon S3.

Contents

BucketARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:.*

Required: No

BufferingHints

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

Type: BufferingHints object

Required: No

CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Type: CloudWatchLoggingOptions object

Required: No

CompressionFormat

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.

Type: String

Valid Values: UNCOMPRESSED | GZIP | ZIP | Snappy

Required: No

EncryptionConfiguration

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

Type: EncryptionConfiguration object

Required: No

ErrorOutputPrefix

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.

Type: String

Required: No

Prefix

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.

Type: String

Required: No

RoleARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: