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

Interface ElasticsearchDestinationUpdate.Builder

All Superinterfaces:

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

Enclosing class:

ElasticsearchDestinationUpdate

@Mutable
@NotThreadSafe
public static interface ElasticsearchDestinationUpdate.Builder
extends SdkPojo, CopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>

Method Summary

Modifier and Type	Method	Description
default ElasticsearchDestinationUpdate.Builder	bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints)	The buffering options.
ElasticsearchDestinationUpdate.Builder	bufferingHints(ElasticsearchBufferingHints bufferingHints)	The buffering options.
default ElasticsearchDestinationUpdate.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The CloudWatch logging options for your Firehose stream.
ElasticsearchDestinationUpdate.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The CloudWatch logging options for your Firehose stream.
ElasticsearchDestinationUpdate.Builder	clusterEndpoint(String clusterEndpoint)	The endpoint to use when communicating with the cluster.
default ElasticsearchDestinationUpdate.Builder	documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationUpdate.Builder	documentIdOptions(DocumentIdOptions documentIdOptions)	Indicates the method for setting up document ID.
ElasticsearchDestinationUpdate.Builder	domainARN(String domainARN)	The ARN of the Amazon OpenSearch Service domain.
ElasticsearchDestinationUpdate.Builder	indexName(String indexName)	The Elasticsearch index name.
ElasticsearchDestinationUpdate.Builder	indexRotationPeriod(String indexRotationPeriod)	The Elasticsearch index rotation period.
ElasticsearchDestinationUpdate.Builder	indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)	The Elasticsearch index rotation period.
default ElasticsearchDestinationUpdate.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
ElasticsearchDestinationUpdate.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default ElasticsearchDestinationUpdate.Builder	retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions)	The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
ElasticsearchDestinationUpdate.Builder	retryOptions(ElasticsearchRetryOptions retryOptions)	The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
ElasticsearchDestinationUpdate.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
default ElasticsearchDestinationUpdate.Builder	s3Update(Consumer<S3DestinationUpdate.Builder> s3Update)	The Amazon S3 destination.
ElasticsearchDestinationUpdate.Builder	s3Update(S3DestinationUpdate s3Update)	The Amazon S3 destination.
ElasticsearchDestinationUpdate.Builder	typeName(String typeName)	The Elasticsearch type name.

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, sdkFieldNameToField, sdkFields

Method Details

roleARN

ElasticsearchDestinationUpdate.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service 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 OpenSearch Service 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.

domainARN

ElasticsearchDestinationUpdate.Builder domainARN(String domainARN)

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM 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 OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM 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

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

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

ElasticsearchDestinationUpdate.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, Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for 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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.

Returns:

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

indexRotationPeriod

ElasticsearchDestinationUpdate.Builder indexRotationPeriod(String indexRotationPeriod)

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. Default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. Default value is OneDay.

Returns:

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

See Also:

• ElasticsearchIndexRotationPeriod
• ElasticsearchIndexRotationPeriod

indexRotationPeriod

ElasticsearchDestinationUpdate.Builder indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. Default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. Default value is OneDay.

Returns:

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

See Also:

• ElasticsearchIndexRotationPeriod
• ElasticsearchIndexRotationPeriod

bufferingHints

ElasticsearchDestinationUpdate.Builder bufferingHints(ElasticsearchBufferingHints bufferingHints)

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

Parameters:

bufferingHints - The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

Returns:

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

bufferingHints

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

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values 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

ElasticsearchDestinationUpdate.Builder retryOptions(ElasticsearchRetryOptions retryOptions)

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

Parameters:

retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

Returns:

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

retryOptions

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

The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. 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)

s3Update

ElasticsearchDestinationUpdate.Builder s3Update(S3DestinationUpdate s3Update)

The Amazon S3 destination.

Parameters:

s3Update - The Amazon S3 destination.

Returns:

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

s3Update

default ElasticsearchDestinationUpdate.Builder s3Update(Consumer<S3DestinationUpdate.Builder> s3Update)

The Amazon S3 destination.

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

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

Parameters:

s3Update - a consumer that will call methods on S3DestinationUpdate.Builder

Returns:

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

See Also:

• s3Update(S3DestinationUpdate)

processingConfiguration

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

ElasticsearchDestinationUpdate.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The CloudWatch logging options for your Firehose stream.

Parameters:

cloudWatchLoggingOptions - The CloudWatch logging options for your Firehose stream.

Returns:

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

cloudWatchLoggingOptions

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

The CloudWatch logging options for your Firehose 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)

documentIdOptions

ElasticsearchDestinationUpdate.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 ElasticsearchDestinationUpdate.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)