# ElasticsearchDestinationDescription


The destination description in Amazon OpenSearch Service.

## Contents


 ** BufferingHints **   <a name="Firehose-Type-ElasticsearchDestinationDescription-BufferingHints"></a>
The buffering options.  
Type: [ElasticsearchBufferingHints](API_ElasticsearchBufferingHints.md) object  
Required: No

 ** CloudWatchLoggingOptions **   <a name="Firehose-Type-ElasticsearchDestinationDescription-CloudWatchLoggingOptions"></a>
The Amazon CloudWatch logging options.  
Type: [CloudWatchLoggingOptions](API_CloudWatchLoggingOptions.md) object  
Required: No

 ** ClusterEndpoint **   <a name="Firehose-Type-ElasticsearchDestinationDescription-ClusterEndpoint"></a>
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

 ** DocumentIdOptions **   <a name="Firehose-Type-ElasticsearchDestinationDescription-DocumentIdOptions"></a>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.  
Type: [DocumentIdOptions](API_DocumentIdOptions.md) object  
Required: No

 ** DomainARN **   <a name="Firehose-Type-ElasticsearchDestinationDescription-DomainARN"></a>
The ARN of the Amazon OpenSearch Service domain. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).  
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

 ** IndexName **   <a name="Firehose-Type-ElasticsearchDestinationDescription-IndexName"></a>
The Elasticsearch index name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `.*`   
Required: No

 ** IndexRotationPeriod **   <a name="Firehose-Type-ElasticsearchDestinationDescription-IndexRotationPeriod"></a>
The Elasticsearch index rotation period  
Type: String  
Valid Values: `NoRotation | OneHour | OneDay | OneWeek | OneMonth`   
Required: No

 ** ProcessingConfiguration **   <a name="Firehose-Type-ElasticsearchDestinationDescription-ProcessingConfiguration"></a>
The data processing configuration.  
Type: [ProcessingConfiguration](API_ProcessingConfiguration.md) object  
Required: No

 ** RetryOptions **   <a name="Firehose-Type-ElasticsearchDestinationDescription-RetryOptions"></a>
The Amazon OpenSearch Service retry options.  
Type: [ElasticsearchRetryOptions](API_ElasticsearchRetryOptions.md) object  
Required: No

 ** RoleARN **   <a name="Firehose-Type-ElasticsearchDestinationDescription-RoleARN"></a>
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).  
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

 ** S3BackupMode **   <a name="Firehose-Type-ElasticsearchDestinationDescription-S3BackupMode"></a>
The Amazon S3 backup mode.  
Type: String  
Valid Values: `FailedDocumentsOnly | AllDocuments`   
Required: No

 ** S3DestinationDescription **   <a name="Firehose-Type-ElasticsearchDestinationDescription-S3DestinationDescription"></a>
The Amazon S3 destination.  
Type: [S3DestinationDescription](API_S3DestinationDescription.md) object  
Required: No

 ** TypeName **   <a name="Firehose-Type-ElasticsearchDestinationDescription-TypeName"></a>
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

 ** VpcConfigurationDescription **   <a name="Firehose-Type-ElasticsearchDestinationDescription-VpcConfigurationDescription"></a>
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.  
Type: [VpcConfigurationDescription](API_VpcConfigurationDescription.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/firehose-2015-08-04/ElasticsearchDestinationDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/firehose-2015-08-04/ElasticsearchDestinationDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/firehose-2015-08-04/ElasticsearchDestinationDescription)