ElasticsearchDestinationConfiguration (AWS Java SDK for Amazon Kinesis 1.12.697 API)

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ElasticsearchDestinationConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the configuration of a destination in Amazon ES.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ElasticsearchDestinationConfiguration()

Constructors
Constructor and Description
`ElasticsearchDestinationConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElasticsearchDestinationConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`ElasticsearchBufferingHints`	`getBufferingHints()` The buffering options.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()` The Amazon CloudWatch logging options for your delivery stream.
`String`	`getClusterEndpoint()` The endpoint to use when communicating with the cluster.
`DocumentIdOptions`	`getDocumentIdOptions()` Indicates the method for setting up document ID.
`String`	`getDomainARN()` The ARN of the Amazon ES domain.
`String`	`getIndexName()` The Elasticsearch index name.
`String`	`getIndexRotationPeriod()` The Elasticsearch index rotation period.
`ProcessingConfiguration`	`getProcessingConfiguration()` The data processing configuration.
`ElasticsearchRetryOptions`	`getRetryOptions()` The retry behavior in case Firehose is unable to deliver documents to Amazon ES.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.
`String`	`getS3BackupMode()` Defines how documents should be delivered to Amazon S3.
`S3DestinationConfiguration`	`getS3Configuration()` The configuration for the backup Amazon S3 location.
`String`	`getTypeName()` The Elasticsearch type name.
`VpcConfiguration`	`getVpcConfiguration()` The details of the VPC of the Amazon destination.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBufferingHints(ElasticsearchBufferingHints bufferingHints)` The buffering options.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options for your delivery stream.
`void`	`setClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`void`	`setDocumentIdOptions(DocumentIdOptions documentIdOptions)` Indicates the method for setting up document ID.
`void`	`setDomainARN(String domainARN)` The ARN of the Amazon ES domain.
`void`	`setIndexName(String indexName)` The Elasticsearch index name.
`void`	`setIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)` The Elasticsearch index rotation period.
`void`	`setIndexRotationPeriod(String indexRotationPeriod)` The Elasticsearch index rotation period.
`void`	`setProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`void`	`setRetryOptions(ElasticsearchRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to Amazon ES.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.
`void`	`setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`void`	`setS3BackupMode(String s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`void`	`setS3Configuration(S3DestinationConfiguration s3Configuration)` The configuration for the backup Amazon S3 location.
`void`	`setTypeName(String typeName)` The Elasticsearch type name.
`void`	`setVpcConfiguration(VpcConfiguration vpcConfiguration)` The details of the VPC of the Amazon destination.
`String`	`toString()` Returns a string representation of this object.
`ElasticsearchDestinationConfiguration`	`withBufferingHints(ElasticsearchBufferingHints bufferingHints)` The buffering options.
`ElasticsearchDestinationConfiguration`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options for your delivery stream.
`ElasticsearchDestinationConfiguration`	`withClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`ElasticsearchDestinationConfiguration`	`withDocumentIdOptions(DocumentIdOptions documentIdOptions)` Indicates the method for setting up document ID.
`ElasticsearchDestinationConfiguration`	`withDomainARN(String domainARN)` The ARN of the Amazon ES domain.
`ElasticsearchDestinationConfiguration`	`withIndexName(String indexName)` The Elasticsearch index name.
`ElasticsearchDestinationConfiguration`	`withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)` The Elasticsearch index rotation period.
`ElasticsearchDestinationConfiguration`	`withIndexRotationPeriod(String indexRotationPeriod)` The Elasticsearch index rotation period.
`ElasticsearchDestinationConfiguration`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`ElasticsearchDestinationConfiguration`	`withRetryOptions(ElasticsearchRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to Amazon ES.
`ElasticsearchDestinationConfiguration`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.
`ElasticsearchDestinationConfiguration`	`withS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`ElasticsearchDestinationConfiguration`	`withS3BackupMode(String s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`ElasticsearchDestinationConfiguration`	`withS3Configuration(S3DestinationConfiguration s3Configuration)` The configuration for the backup Amazon S3 location.
`ElasticsearchDestinationConfiguration`	`withTypeName(String typeName)` The Elasticsearch type name.
`ElasticsearchDestinationConfiguration`	`withVpcConfiguration(VpcConfiguration vpcConfiguration)` The details of the VPC of the Amazon destination.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ElasticsearchDestinationConfiguration
```
public ElasticsearchDestinationConfiguration()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
  - withRoleARN
```
public ElasticsearchDestinationConfiguration withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomainARN
```
public void setDomainARN(String domainARN)
```
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
  - getDomainARN
```
public String getDomainARN()
```
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
    
    Returns:
    
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
  - withDomainARN
```
public ElasticsearchDestinationConfiguration withDomainARN(String domainARN)
```
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Specify either ClusterEndpoint or DomainARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterEndpoint
```
public void setClusterEndpoint(String clusterEndpoint)
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
  - getClusterEndpoint
```
public String getClusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
  - withClusterEndpoint
```
public ElasticsearchDestinationConfiguration withClusterEndpoint(String clusterEndpoint)
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The Elasticsearch index name.
    
    Parameters:
    
    indexName - The Elasticsearch index name.
  - getIndexName
```
public String getIndexName()
```
    The Elasticsearch index name.
    
    Returns:
    
    The Elasticsearch index name.
  - withIndexName
```
public ElasticsearchDestinationConfiguration withIndexName(String indexName)
```
    The Elasticsearch index name.
    
    Parameters:
    
    indexName - The Elasticsearch index name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTypeName
```
public void setTypeName(String typeName)
```
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
    
    Parameters:
    
    typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
  - getTypeName
```
public String getTypeName()
```
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
    
    Returns:
    
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
  - withTypeName
```
public ElasticsearchDestinationConfiguration withTypeName(String typeName)
```
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
    
    Parameters:
    
    typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
    
    For Elasticsearch 7.x, don't specify a TypeName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexRotationPeriod
```
public void setIndexRotationPeriod(String indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - getIndexRotationPeriod
```
public String getIndexRotationPeriod()
```
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Returns:
    
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationConfiguration withIndexRotationPeriod(String indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - setIndexRotationPeriod
```
public void setIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationConfiguration withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - setBufferingHints
```
public void setBufferingHints(ElasticsearchBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
  - getBufferingHints
```
public ElasticsearchBufferingHints getBufferingHints()
```
    The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
    
    Returns:
    
    The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
  - withBufferingHints
```
public ElasticsearchDestinationConfiguration withBufferingHints(ElasticsearchBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryOptions
```
public void setRetryOptions(ElasticsearchRetryOptions retryOptions)
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
  - getRetryOptions
```
public ElasticsearchRetryOptions getRetryOptions()
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Returns:
    
    The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
  - withRetryOptions
```
public ElasticsearchDestinationConfiguration withRetryOptions(ElasticsearchRetryOptions retryOptions)
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BackupMode
```
public void setS3BackupMode(String s3BackupMode)
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Parameters:
    
    s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly , Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - getS3BackupMode
```
public String getS3BackupMode()
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Returns:
    
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - withS3BackupMode
```
public ElasticsearchDestinationConfiguration withS3BackupMode(String s3BackupMode)
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Parameters:
    
    s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly , Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - setS3BackupMode
```
public void setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Parameters:
    
    s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly , Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - withS3BackupMode
```
public ElasticsearchDestinationConfiguration withS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Parameters:
    
    s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly , Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
    
    You can't change this backup mode after you create the delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - setS3Configuration
```
public void setS3Configuration(S3DestinationConfiguration s3Configuration)
```
    The configuration for the backup Amazon S3 location.
    
    Parameters:
    
    s3Configuration - The configuration for the backup Amazon S3 location.
  - getS3Configuration
```
public S3DestinationConfiguration getS3Configuration()
```
    The configuration for the backup Amazon S3 location.
    
    Returns:
    
    The configuration for the backup Amazon S3 location.
  - withS3Configuration
```
public ElasticsearchDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
```
    The configuration for the backup Amazon S3 location.
    
    Parameters:
    
    s3Configuration - The configuration for the backup Amazon S3 location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProcessingConfiguration
```
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
  - getProcessingConfiguration
```
public ProcessingConfiguration getProcessingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - withProcessingConfiguration
```
public ElasticsearchDestinationConfiguration withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLoggingOptions
```
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    The Amazon CloudWatch logging options for your delivery stream.
  - withCloudWatchLoggingOptions
```
public ElasticsearchDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    The details of the VPC of the Amazon destination.
    
    Parameters:
    
    vpcConfiguration - The details of the VPC of the Amazon destination.
  - getVpcConfiguration
```
public VpcConfiguration getVpcConfiguration()
```
    The details of the VPC of the Amazon destination.
    
    Returns:
    
    The details of the VPC of the Amazon destination.
  - withVpcConfiguration
```
public ElasticsearchDestinationConfiguration withVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    The details of the VPC of the Amazon destination.
    
    Parameters:
    
    vpcConfiguration - The details of the VPC of the Amazon destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentIdOptions
```
public void setDocumentIdOptions(DocumentIdOptions documentIdOptions)
```
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
    
    Parameters:
    
    documentIdOptions - Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
  - getDocumentIdOptions
```
public DocumentIdOptions getDocumentIdOptions()
```
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
    
    Returns:
    
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
  - withDocumentIdOptions
```
public ElasticsearchDestinationConfiguration withDocumentIdOptions(DocumentIdOptions documentIdOptions)
```
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
    
    Parameters:
    
    documentIdOptions - Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ElasticsearchDestinationConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ElasticsearchDestinationConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ElasticsearchDestinationConfiguration

Method Detail

setRoleARN

getRoleARN

withRoleARN

setDomainARN

getDomainARN

withDomainARN

setClusterEndpoint

getClusterEndpoint

withClusterEndpoint

setIndexName

getIndexName

withIndexName

setTypeName

getTypeName

withTypeName

setIndexRotationPeriod

getIndexRotationPeriod

withIndexRotationPeriod

setIndexRotationPeriod

withIndexRotationPeriod

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3BackupMode

getS3BackupMode

withS3BackupMode

setS3BackupMode

withS3BackupMode

setS3Configuration

getS3Configuration

withS3Configuration

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

setDocumentIdOptions

getDocumentIdOptions

withDocumentIdOptions

toString

equals

hashCode

clone

marshall