AWS CloudFormation
User Guide (Version )

AWS::KinesisFirehose::DeliveryStream ElasticsearchDestinationConfiguration

The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.

Syntax

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

Properties

BufferingHints

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Required: Yes

Type: ElasticsearchBufferingHints

Update requires: No interruption

CloudWatchLoggingOptions

The Amazon CloudWatch Logs logging options for the delivery stream.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

DomainARN

The Amazon Resource Name (ARN) of the Amazon ES domain that Kinesis Data Firehose delivers data to.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Pattern: arn:.*

Update requires: No interruption

IndexName

The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

Required: Yes

Type: String

Minimum: 1

Maximum: 80

Update requires: No interruption

IndexRotationPeriod

The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide.

Required: Yes

Type: String

Allowed Values: NoRotation | OneDay | OneHour | OneMonth | OneWeek

Update requires: No interruption

ProcessingConfiguration

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

Required: No

Type: ProcessingConfiguration

Update requires: No interruption

RetryOptions

The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Required: Yes

Type: ElasticsearchRetryOptions

Update requires: No interruption

RoleARN

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Pattern: arn:.*

Update requires: No interruption

S3BackupMode

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference.

Required: Yes

Type: String

Allowed Values: AllDocuments | FailedDocumentsOnly

Update requires: No interruption

S3Configuration

The S3 bucket where Kinesis Data Firehose backs up incoming data.

Required: Yes

Type: S3DestinationConfiguration

Update requires: No interruption

TypeName

The Elasticsearch type name that Amazon ES adds to documents when indexing data.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

On this page: