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

Interface ElasticsearchDestinationDescription.Builder

All Superinterfaces:

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

Enclosing class:

ElasticsearchDestinationDescription

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

Method Summary

Modifier and Type	Method	Description
default ElasticsearchDestinationDescription.Builder	bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints)	The buffering options.
ElasticsearchDestinationDescription.Builder	bufferingHints(ElasticsearchBufferingHints bufferingHints)	The buffering options.
default ElasticsearchDestinationDescription.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options.
ElasticsearchDestinationDescription.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options.
ElasticsearchDestinationDescription.Builder	clusterEndpoint(String clusterEndpoint)	The endpoint to use when communicating with the cluster.
default ElasticsearchDestinationDescription.Builder	documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationDescription.Builder	documentIdOptions(DocumentIdOptions documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationDescription.Builder	domainARN(String domainARN)	The ARN of the Amazon ES domain.
ElasticsearchDestinationDescription.Builder	indexName(String indexName)	The Elasticsearch index name.
ElasticsearchDestinationDescription.Builder	indexRotationPeriod(String indexRotationPeriod)	The Elasticsearch index rotation period
ElasticsearchDestinationDescription.Builder	indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)	The Elasticsearch index rotation period
default ElasticsearchDestinationDescription.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
ElasticsearchDestinationDescription.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default ElasticsearchDestinationDescription.Builder	retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions)	The Amazon ES retry options.
ElasticsearchDestinationDescription.Builder	retryOptions(ElasticsearchRetryOptions retryOptions)	The Amazon ES retry options.
ElasticsearchDestinationDescription.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
ElasticsearchDestinationDescription.Builder	s3BackupMode(String s3BackupMode)	The Amazon S3 backup mode.
ElasticsearchDestinationDescription.Builder	s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)	The Amazon S3 backup mode.
default ElasticsearchDestinationDescription.Builder	s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)	The Amazon S3 destination.
ElasticsearchDestinationDescription.Builder	s3DestinationDescription(S3DestinationDescription s3DestinationDescription)	The Amazon S3 destination.
ElasticsearchDestinationDescription.Builder	typeName(String typeName)	The Elasticsearch type name.
default ElasticsearchDestinationDescription.Builder	vpcConfigurationDescription(Consumer<VpcConfigurationDescription.Builder> vpcConfigurationDescription)	The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
ElasticsearchDestinationDescription.Builder	vpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)	The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless 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 Details

roleARN

ElasticsearchDestinationDescription.Builder roleARN(String roleARN)

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

Parameters:

roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see 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

ElasticsearchDestinationDescription.Builder domainARN(String domainARN)

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

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

Parameters:

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

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

Returns:

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

clusterEndpoint

ElasticsearchDestinationDescription.Builder clusterEndpoint(String clusterEndpoint)

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

Parameters:

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

Returns:

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

indexName

ElasticsearchDestinationDescription.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

ElasticsearchDestinationDescription.Builder typeName(String typeName)

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.

Parameters:

typeName - 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.

Returns:

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

indexRotationPeriod

ElasticsearchDestinationDescription.Builder indexRotationPeriod(String indexRotationPeriod)

The Elasticsearch index rotation period

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period

Returns:

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

See Also:

• ElasticsearchIndexRotationPeriod
• ElasticsearchIndexRotationPeriod

indexRotationPeriod

ElasticsearchDestinationDescription.Builder indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)

The Elasticsearch index rotation period

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period

Returns:

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

See Also:

• ElasticsearchIndexRotationPeriod
• ElasticsearchIndexRotationPeriod

bufferingHints

ElasticsearchDestinationDescription.Builder bufferingHints(ElasticsearchBufferingHints bufferingHints)

The buffering options.

Parameters:

bufferingHints - The buffering options.

Returns:

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

bufferingHints

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

The buffering options.

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

ElasticsearchDestinationDescription.Builder retryOptions(ElasticsearchRetryOptions retryOptions)

The Amazon ES retry options.

Parameters:

retryOptions - The Amazon ES retry options.

Returns:

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

retryOptions

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

The Amazon ES retry options.

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

ElasticsearchDestinationDescription.Builder s3BackupMode(String s3BackupMode)

The Amazon S3 backup mode.

Parameters:

s3BackupMode - The Amazon S3 backup mode.

Returns:

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

See Also:

• ElasticsearchS3BackupMode
• ElasticsearchS3BackupMode

s3BackupMode

ElasticsearchDestinationDescription.Builder s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)

The Amazon S3 backup mode.

Parameters:

s3BackupMode - The Amazon S3 backup mode.

Returns:

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

See Also:

• ElasticsearchS3BackupMode
• ElasticsearchS3BackupMode

s3DestinationDescription

ElasticsearchDestinationDescription.Builder s3DestinationDescription(S3DestinationDescription s3DestinationDescription)

The Amazon S3 destination.

Parameters:

s3DestinationDescription - The Amazon S3 destination.

Returns:

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

s3DestinationDescription

default ElasticsearchDestinationDescription.Builder s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)

The Amazon S3 destination.

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

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

Parameters:

s3DestinationDescription - a consumer that will call methods on S3DestinationDescription.Builder

Returns:

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

See Also:

• s3DestinationDescription(S3DestinationDescription)

processingConfiguration

ElasticsearchDestinationDescription.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 ElasticsearchDestinationDescription.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

ElasticsearchDestinationDescription.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The Amazon CloudWatch logging options.

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch logging options.

Returns:

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

cloudWatchLoggingOptions

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

The Amazon CloudWatch logging options.

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)

vpcConfigurationDescription

ElasticsearchDestinationDescription.Builder vpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)

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

Parameters:

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

Returns:

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

vpcConfigurationDescription

default ElasticsearchDestinationDescription.Builder vpcConfigurationDescription(Consumer<VpcConfigurationDescription.Builder> vpcConfigurationDescription)

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

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

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

Parameters:

vpcConfigurationDescription - a consumer that will call methods on VpcConfigurationDescription.Builder

Returns:

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

See Also:

• vpcConfigurationDescription(VpcConfigurationDescription)

documentIdOptions

ElasticsearchDestinationDescription.Builder documentIdOptions(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.

documentIdOptions

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

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