Package software.amazon.awssdk.services.firehose.model

Interface ElasticsearchDestinationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>, SdkBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>, SdkPojo

Enclosing class:

ElasticsearchDestinationConfiguration

public static interface ElasticsearchDestinationConfiguration.Builder
extends SdkPojo, CopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>

Method Summary

Modifier and Type	Method	Description
default ElasticsearchDestinationConfiguration.Builder	bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints)	The buffering options.
ElasticsearchDestinationConfiguration.Builder	bufferingHints(ElasticsearchBufferingHints bufferingHints)	The buffering options.
default ElasticsearchDestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
ElasticsearchDestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
ElasticsearchDestinationConfiguration.Builder	clusterEndpoint(String clusterEndpoint)	The endpoint to use when communicating with the cluster.
default ElasticsearchDestinationConfiguration.Builder	documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationConfiguration.Builder	documentIdOptions(DocumentIdOptions documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationConfiguration.Builder	domainARN(String domainARN)	The ARN of the Amazon ES domain.
ElasticsearchDestinationConfiguration.Builder	indexName(String indexName)	The Elasticsearch index name.
ElasticsearchDestinationConfiguration.Builder	indexRotationPeriod(String indexRotationPeriod)	The Elasticsearch index rotation period.
ElasticsearchDestinationConfiguration.Builder	indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)	The Elasticsearch index rotation period.
default ElasticsearchDestinationConfiguration.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
ElasticsearchDestinationConfiguration.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default ElasticsearchDestinationConfiguration.Builder	retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions)	The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
ElasticsearchDestinationConfiguration.Builder	retryOptions(ElasticsearchRetryOptions retryOptions)	The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
ElasticsearchDestinationConfiguration.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
ElasticsearchDestinationConfiguration.Builder	s3BackupMode(String s3BackupMode)	Defines how documents should be delivered to Amazon S3.
ElasticsearchDestinationConfiguration.Builder	s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)	Defines how documents should be delivered to Amazon S3.
default ElasticsearchDestinationConfiguration.Builder	s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)	The configuration for the backup Amazon S3 location.
ElasticsearchDestinationConfiguration.Builder	s3Configuration(S3DestinationConfiguration s3Configuration)	The configuration for the backup Amazon S3 location.
ElasticsearchDestinationConfiguration.Builder	typeName(String typeName)	The Elasticsearch type name.
default ElasticsearchDestinationConfiguration.Builder	vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)	The details of the VPC of the Amazon destination.
ElasticsearchDestinationConfiguration.Builder	vpcConfiguration(VpcConfiguration vpcConfiguration)	The details of the VPC of the Amazon destination.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

roleARN

ElasticsearchDestinationConfiguration.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data 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 Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data 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.

domainARN

ElasticsearchDestinationConfiguration.Builder domainARN(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.

clusterEndpoint

ElasticsearchDestinationConfiguration.Builder clusterEndpoint(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.

indexName

ElasticsearchDestinationConfiguration.Builder indexName(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.

typeName

ElasticsearchDestinationConfiguration.Builder typeName(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, Kinesis Data 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, Kinesis Data 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.

indexRotationPeriod

ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(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, ElasticsearchIndexRotationPeriod

indexRotationPeriod

ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(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, ElasticsearchIndexRotationPeriod

bufferingHints

ElasticsearchDestinationConfiguration.Builder bufferingHints(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.

bufferingHints

default ElasticsearchDestinationConfiguration.Builder bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints)

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

This is a convenience method that creates an instance of the ElasticsearchBufferingHints.Builder avoiding the need to create one manually via ElasticsearchBufferingHints.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bufferingHints(ElasticsearchBufferingHints).

Parameters:

bufferingHints - a consumer that will call methods on ElasticsearchBufferingHints.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bufferingHints(ElasticsearchBufferingHints)

retryOptions

ElasticsearchDestinationConfiguration.Builder retryOptions(ElasticsearchRetryOptions retryOptions)

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Parameters:

retryOptions - The retry behavior in case Kinesis Data 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.

retryOptions

default ElasticsearchDestinationConfiguration.Builder retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions)

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

This is a convenience method that creates an instance of the ElasticsearchRetryOptions.Builder avoiding the need to create one manually via ElasticsearchRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(ElasticsearchRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on ElasticsearchRetryOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retryOptions(ElasticsearchRetryOptions)

s3BackupMode

ElasticsearchDestinationConfiguration.Builder s3BackupMode(String s3BackupMode)

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data 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, Kinesis Data 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, Kinesis Data 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, ElasticsearchS3BackupMode

s3BackupMode

ElasticsearchDestinationConfiguration.Builder s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data 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, Kinesis Data 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, Kinesis Data 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, ElasticsearchS3BackupMode

s3Configuration

ElasticsearchDestinationConfiguration.Builder s3Configuration(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.

s3Configuration

default ElasticsearchDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)

The configuration for the backup Amazon S3 location.

This is a convenience method that creates an instance of the S3DestinationConfiguration.Builder avoiding the need to create one manually via S3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Configuration(S3DestinationConfiguration).

Parameters:

s3Configuration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3Configuration(S3DestinationConfiguration)

processingConfiguration

ElasticsearchDestinationConfiguration.Builder processingConfiguration(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.

processingConfiguration

default ElasticsearchDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)

The data processing configuration.

This is a convenience method that creates an instance of the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

processingConfiguration(ProcessingConfiguration)

cloudWatchLoggingOptions

ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(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.

cloudWatchLoggingOptions

default ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your delivery stream.

This is a convenience method that creates an instance of the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cloudWatchLoggingOptions(CloudWatchLoggingOptions)

vpcConfiguration

ElasticsearchDestinationConfiguration.Builder vpcConfiguration(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.

vpcConfiguration

default ElasticsearchDestinationConfiguration.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

The details of the VPC of the Amazon destination.

This is a convenience method that creates an instance of the VpcConfiguration.Builder avoiding the need to create one manually via VpcConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(VpcConfiguration).

Parameters:

vpcConfiguration - a consumer that will call methods on VpcConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

vpcConfiguration(VpcConfiguration)

documentIdOptions

ElasticsearchDestinationConfiguration.Builder documentIdOptions(DocumentIdOptions documentIdOptions)

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

Parameters:

documentIdOptions - Indicates the method for setting up document ID. The supported methods are Kinesis Data 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.

documentIdOptions

default ElasticsearchDestinationConfiguration.Builder documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)

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

This is a convenience method that creates an instance of the DocumentIdOptions.Builder avoiding the need to create one manually via DocumentIdOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentIdOptions(DocumentIdOptions).

Parameters:

documentIdOptions - a consumer that will call methods on DocumentIdOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

documentIdOptions(DocumentIdOptions)