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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ElasticsearchDestinationDescription

The destination description in Amazon ES.

Contents

BufferingHints

The buffering options.

Type: ElasticsearchBufferingHints object

Required: No

CloudWatchLoggingOptions

The Amazon CloudWatch logging options.

Type: CloudWatchLoggingOptions object

Required: No

ClusterEndpoint

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

Type: String

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

Pattern: https:.*

Required: No

DomainARN

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

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

Type: String

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

Required: No

ProcessingConfiguration

The data processing configuration.

Type: ProcessingConfiguration object

Required: No

RetryOptions

The Amazon ES retry options.

Type: ElasticsearchRetryOptions object

Required: No

RoleARN

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Type: String

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

Pattern: arn:.*

Required: No

S3BackupMode

The Amazon S3 backup mode.

Type: String

Valid Values: FailedDocumentsOnly | AllDocuments

Required: No

S3DestinationDescription

The Amazon S3 destination.

Type: S3DestinationDescription object

Required: No

TypeName

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.

Type: String

Length Constraints: Minimum length of 0. 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: