software.amazon.awssdk.services.firehose.model

Interface AmazonopensearchserviceDestinationUpdate.Builder

All Superinterfaces:

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

Enclosing class:

AmazonopensearchserviceDestinationUpdate

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

Method Summary

Modifier and Type	Method and Description
AmazonopensearchserviceDestinationUpdate.Builder	bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints) The buffering options.
default AmazonopensearchserviceDestinationUpdate.Builder	bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints) The buffering options.
AmazonopensearchserviceDestinationUpdate.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.
default AmazonopensearchserviceDestinationUpdate.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.
AmazonopensearchserviceDestinationUpdate.Builder	clusterEndpoint(String clusterEndpoint) The endpoint to use when communicating with the cluster.
AmazonopensearchserviceDestinationUpdate.Builder	domainARN(String domainARN) The ARN of the Amazon OpenSearch Service domain.
AmazonopensearchserviceDestinationUpdate.Builder	indexName(String indexName) The Amazon OpenSearch Service index name.
AmazonopensearchserviceDestinationUpdate.Builder	indexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod) The Amazon OpenSearch Service index rotation period.
AmazonopensearchserviceDestinationUpdate.Builder	indexRotationPeriod(String indexRotationPeriod) The Amazon OpenSearch Service index rotation period.
default AmazonopensearchserviceDestinationUpdate.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.
AmazonopensearchserviceDestinationUpdate.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.
AmazonopensearchserviceDestinationUpdate.Builder	retryOptions(AmazonopensearchserviceRetryOptions retryOptions) The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
default AmazonopensearchserviceDestinationUpdate.Builder	retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions) The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
AmazonopensearchserviceDestinationUpdate.Builder	roleARN(String roleARN) The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
default AmazonopensearchserviceDestinationUpdate.Builder	s3Update(Consumer<S3DestinationUpdate.Builder> s3Update) Sets the value of the S3Update property for this object.
AmazonopensearchserviceDestinationUpdate.Builder	s3Update(S3DestinationUpdate s3Update) Sets the value of the S3Update property for this object.
AmazonopensearchserviceDestinationUpdate.Builder	typeName(String typeName) The Amazon OpenSearch Service type name.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

roleARN

AmazonopensearchserviceDestinationUpdate.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

Parameters:

roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

Returns:

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

domainARN

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

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.

Returns:

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

clusterEndpoint

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

AmazonopensearchserviceDestinationUpdate.Builder indexName(String indexName)

The Amazon OpenSearch Service index name.

Parameters:

indexName - The Amazon OpenSearch Service index name.

Returns:

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

typeName

AmazonopensearchserviceDestinationUpdate.Builder typeName(String typeName)

The Amazon OpenSearch Service 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 runtime.

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

Parameters:

typeName - The Amazon OpenSearch Service 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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery 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

AmazonopensearchserviceDestinationUpdate.Builder indexRotationPeriod(String indexRotationPeriod)

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

Parameters:

indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

Returns:

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

See Also:

AmazonopensearchserviceIndexRotationPeriod, AmazonopensearchserviceIndexRotationPeriod

indexRotationPeriod

AmazonopensearchserviceDestinationUpdate.Builder indexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

Parameters:

indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

Returns:

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

See Also:

AmazonopensearchserviceIndexRotationPeriod, AmazonopensearchserviceIndexRotationPeriod

bufferingHints

AmazonopensearchserviceDestinationUpdate.Builder bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)

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

Parameters:

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

Returns:

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

bufferingHints

default AmazonopensearchserviceDestinationUpdate.Builder bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints)

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

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

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

Parameters:

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

Returns:

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

See Also:

bufferingHints(AmazonopensearchserviceBufferingHints)

retryOptions

AmazonopensearchserviceDestinationUpdate.Builder retryOptions(AmazonopensearchserviceRetryOptions retryOptions)

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

Parameters:

retryOptions - The retry behavior in case Kinesis Data 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 AmazonopensearchserviceDestinationUpdate.Builder retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions)

The retry behavior in case Kinesis Data 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 AmazonopensearchserviceRetryOptions.Builder avoiding the need to create one manually via AmazonopensearchserviceRetryOptions.builder().

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

Parameters:

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

Returns:

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

See Also:

retryOptions(AmazonopensearchserviceRetryOptions)

s3Update

AmazonopensearchserviceDestinationUpdate.Builder s3Update(S3DestinationUpdate s3Update)

Sets the value of the S3Update property for this object.

Parameters:

s3Update - The new value for the S3Update property for this object.

Returns:

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

s3Update

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

Sets the value of the S3Update property for this object. 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

AmazonopensearchserviceDestinationUpdate.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)

Sets the value of the ProcessingConfiguration property for this object.

Parameters:

processingConfiguration - The new value for the ProcessingConfiguration property for this object.

Returns:

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

processingConfiguration

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

Sets the value of the ProcessingConfiguration property for this object. 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

AmazonopensearchserviceDestinationUpdate.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

Sets the value of the CloudWatchLoggingOptions property for this object.

Parameters:

cloudWatchLoggingOptions - The new value for the CloudWatchLoggingOptions property for this object.

Returns:

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

cloudWatchLoggingOptions

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

Sets the value of the CloudWatchLoggingOptions property for this object. 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)