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

ElasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

Contents

BufferingHints

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values 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 IAM role specified in RoleARN.

Type: String

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

Pattern: arn:.*

Required: No

IndexName

The Elasticsearch index name.

Type: String

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

Required: No

IndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. 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: No

S3Update

The Amazon S3 destination.

Type: S3DestinationUpdate object

Required: No

TypeName

The Elasticsearch type name.

Type: String

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

Required: No

See Also

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

On this page: