AWS::KinesisFirehose::DeliveryStream ExtendedS3DestinationConfiguration - AWS CloudFormation

AWS::KinesisFirehose::DeliveryStream ExtendedS3DestinationConfiguration

The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.

Syntax

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

Properties

BucketARN

The Amazon Resource Name (ARN) of the Amazon S3 bucket. For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference.

Required: Yes

Type: String

Pattern: arn:.*

Minimum: 1

Maximum: 2048

Update requires: No interruption

BufferingHints

The buffering option.

Required: No

Type: BufferingHints

Update requires: No interruption

CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

CompressionFormat

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

Required: No

Type: String

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

Update requires: No interruption

CustomTimeZone

The time zone you prefer. UTC is the default.

Required: No

Type: String

Minimum: 0

Maximum: 50

Update requires: No interruption

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.

Required: No

Type: DataFormatConversionConfiguration

Update requires: No interruption

DynamicPartitioningConfiguration

The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

Required: No

Type: DynamicPartitioningConfiguration

Update requires: No interruption

EncryptionConfiguration

The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is NoEncryption.

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

Update requires: No interruption

FileExtension

Specify a file extension. It will override the default file extension

Required: No

Type: String

Pattern: ^$|\.[0-9a-z!\-_.*'()]+

Minimum: 0

Maximum: 128

Update requires: No interruption

Prefix

The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files. For more information, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

ProcessingConfiguration

The data processing configuration for the Kinesis Data Firehose delivery stream.

Required: No

Type: ProcessingConfiguration

Update requires: No interruption

RoleARN

The Amazon Resource Name (ARN) of the AWS credentials. For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference.

Required: Yes

Type: String

Pattern: arn:.*

Minimum: 1

Maximum: 512

Update requires: No interruption

S3BackupConfiguration

The configuration for backup in Amazon S3.

Required: No

Type: S3DestinationConfiguration

Update requires: No interruption

S3BackupMode

The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

Required: No

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption