AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Kinesis Resource Types Reference » AWS::KinesisFirehose::DeliveryStream » Amazon Kinesis Data Firehose DeliveryStream ElasticsearchDestinationConfiguration

Filter View: All JSON YAML

Amazon Kinesis Data Firehose 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.

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

Syntax

JSON

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

YAML

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 Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Required: Yes

Type: ElasticsearchBufferingHints

CloudWatchLoggingOptions

The Amazon CloudWatch Logs logging options for the delivery stream.

Required: No

Type: CloudWatchLoggingOptions

DomainARN

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

Required: Yes

Type: String

IndexName

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

Required: Yes

Type: String

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

ProcessingConfiguration

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

Required: No

Type: ProcessingConfiguration

RetryOptions

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

Required: Yes

Type: ElasticsearchRetryOptions

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 in the Amazon Kinesis Data Firehose Developer Guide and Amazon Resource Names (ARNs) and AWS Service Namespaces in the Amazon Web Services General Reference.

Required: Yes

Type: String

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: No

Type: String

S3Configuration

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

Required: Yes

Type: S3DestinationConfiguration

TypeName

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

Required: Yes

Type: String