Menu
Amazon Kinesis Firehose API Reference
API Reference (API Version 2015-08-04)

ElasticsearchDestinationConfiguration

Describes the configuration of a destination in Amazon ES.

Contents

BufferingHints

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Type: ElasticsearchBufferingHints object

Required: No

CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Type: CloudWatchLoggingOptions object

Required: No

DomainARN

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

IndexName

The Elasticsearch index name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Required: Yes

IndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. The default value is OneDay.

Type: String

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

Required: No

ProcessingConfiguration

The data processing configuration.

Type: ProcessingConfiguration object

Required: No

RetryOptions

The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Type: ElasticsearchRetryOptions object

Required: No

RoleARN

The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

S3BackupMode

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

Type: String

Valid Values: FailedDocumentsOnly | AllDocuments

Required: No

S3Configuration

The configuration for the backup Amazon S3 location.

Type: S3DestinationConfiguration object

Required: Yes

TypeName

The Elasticsearch type name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: