ElasticsearchDestinationDescription

The buffering options.

Type: ElasticsearchBufferingHints object

Required: No

The Amazon CloudWatch logging options.

Type: CloudWatchLoggingOptions object

Required: No

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

Type: String

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

Pattern: https:.*

Required: No

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Type: DocumentIdOptions object

Required: No

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

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon OpenSearch Service.

Type: String

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

Pattern: arn:.*:es:[a-zA-Z0-9\-]+:\d{12}:domain/[a-z][-0-9a-z]{2,27}

Required: No

The Elasticsearch index name.

Type: String

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

Pattern: .*

Required: No

The Elasticsearch index rotation period

Type: String

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

Required: No

The data processing configuration.

Type: ProcessingConfiguration object

Required: No

The Amazon OpenSearch Service retry options.

Type: ElasticsearchRetryOptions object

Required: No

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:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: No

The Amazon S3 backup mode.

Type: String

Valid Values: FailedDocumentsOnly | AllDocuments

Required: No

The Amazon S3 destination.

Type: S3DestinationDescription object

Required: No

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

Type: String

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

Pattern: .*

Required: No

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Type: VpcConfigurationDescription object

Required: No