AWS::KinesisFirehose::DeliveryStream S3DestinationConfiguration

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BucketARN" : String,
  "BufferingHints" : BufferingHints,
  "CloudWatchLoggingOptions" : CloudWatchLoggingOptions,
  "CompressionFormat" : String,
  "EncryptionConfiguration" : EncryptionConfiguration,
  "ErrorOutputPrefix" : String,
  "Prefix" : String,
  "RoleARN" : String
}

YAML

  BucketARN: String
  BufferingHints: 
    BufferingHints
  CloudWatchLoggingOptions: 
    CloudWatchLoggingOptions
  CompressionFormat: String
  EncryptionConfiguration: 
    EncryptionConfiguration
  ErrorOutputPrefix: String
  Prefix: String
  RoleARN: String

Properties

BucketARN

The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: arn:.*

Update requires: No interruption

BufferingHints

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.

Required: No

Type: BufferingHints

Update requires: No interruption

CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

CompressionFormat

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference.

Required: No

Type: String

Allowed values: GZIP | HADOOP_SNAPPY | Snappy | UNCOMPRESSED | ZIP

Update requires: No interruption

EncryptionConfiguration

Configures Amazon Simple Storage Service (Amazon S3) server-side encryption. Kinesis Data Firehose uses AWS Key Management Service (AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.

Required: No

Type: EncryptionConfiguration

Update requires: No interruption

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.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Pattern: .*

Update requires: No interruption

Prefix

A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Pattern: .*

Update requires: No interruption

RoleARN

The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Pattern: arn:.*

Update requires: No interruption