Amazon Kinesis Firehose DeliveryStream ElasticsearchDestinationConfiguration

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

ElasticsearchDestinationConfiguration is a property of the AWS::KinesisFirehose::DeliveryStream resource.

Syntax

JSON

Copy
{
  "BufferingHints" : BufferingHints,
  "CloudWatchLoggingOptions" : CloudWatchLoggingOptions,
  "DomainARN" : String,
  "IndexName" : String,
  "IndexRotationPeriod" : String,
  "ProcessingConfiguration" : ProcessingConfiguration,
  "RetryOptions" : RetryOptions,
  "RoleARN" : String,
  "S3BackupMode" : String,
  "S3Configuration" : S3Configuration,
  "TypeName" : String
}

YAML

Copy
BufferingHints:
  BufferingHints
CloudWatchLoggingOptions:
  CloudWatchLoggingOptions
DomainARN: String
IndexName: String
IndexRotationPeriod: String
ProcessingConfiguration:
  ProcessingConfiguration,
RetryOptions:
  RetryOptions
RoleARN: String
S3BackupMode: String
S3Configuration:
  S3Configuration
TypeName: String

Properties

BufferingHints

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

Required: Yes

Type: Kinesis Firehose DeliveryStream ElasticsearchBufferingHints

CloudWatchLoggingOptions

The Amazon CloudWatch Logs logging options for the delivery stream.

Required: No

Type: Kinesis Firehose DeliveryStream CloudWatchLoggingOptions

DomainARN

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

Required: Yes

Type: String

IndexName

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

Required: Yes

Type: String

IndexRotationPeriod

The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis 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 Firehose Developer Guide.

Required: Yes

Type: String

ProcessingConfiguration

The data processing configuration for the Kinesis Firehose delivery stream.

Required: No

Type: Kinesis Firehose DeliveryStream ProcessingConfiguration

RetryOptions

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

Type: Kinesis Firehose DeliveryStream ElasticsearchRetryOptions

Type: String

RoleARN

The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Firehose access to your Amazon S3 bucket, AWS KMS (if you enable data encryption), and Amazon CloudWatch Logs (if you enable logging).

For more information, see Grant Kinesis Firehose Access to an Amazon Elasticsearch Service Destination in the Amazon Kinesis Firehose Developer Guide.

Required: Yes

Type: String

S3BackupMode

The condition under which Kinesis 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 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 Firehose API Reference.

Required: Yes

Type: String

S3Configuration