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

Interface AmazonOpenSearchServerlessDestinationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

AmazonOpenSearchServerlessDestinationConfiguration

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

Method Summary

Modifier and Type	Method	Description
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	bufferingHints(Consumer<AmazonOpenSearchServerlessBufferingHints.Builder> bufferingHints)	The buffering options.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	bufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)	The buffering options.
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	collectionEndpoint(String collectionEndpoint)	The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	indexName(String indexName)	The Serverless offering for Amazon OpenSearch Service index name.
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	retryOptions(Consumer<AmazonOpenSearchServerlessRetryOptions.Builder> retryOptions)	The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	retryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)	The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	s3BackupMode(String s3BackupMode)	Defines how documents should be delivered to Amazon S3.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	s3BackupMode(AmazonOpenSearchServerlessS3BackupMode s3BackupMode)	Defines how documents should be delivered to Amazon S3.
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)	Sets the value of the S3Configuration property for this object.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	s3Configuration(S3DestinationConfiguration s3Configuration)	Sets the value of the S3Configuration property for this object.
default AmazonOpenSearchServerlessDestinationConfiguration.Builder	vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)	Sets the value of the VpcConfiguration property for this object.
AmazonOpenSearchServerlessDestinationConfiguration.Builder	vpcConfiguration(VpcConfiguration vpcConfiguration)	Sets the value of the VpcConfiguration property for this object.

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

AmazonOpenSearchServerlessDestinationConfiguration.Builder roleARN(String roleARN)

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

Parameters:

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

Returns:

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

collectionEndpoint

AmazonOpenSearchServerlessDestinationConfiguration.Builder collectionEndpoint(String collectionEndpoint)

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Parameters:

collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Returns:

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

indexName

AmazonOpenSearchServerlessDestinationConfiguration.Builder indexName(String indexName)

The Serverless offering for Amazon OpenSearch Service index name.

Parameters:

indexName - The Serverless offering for Amazon OpenSearch Service index name.

Returns:

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

bufferingHints

AmazonOpenSearchServerlessDestinationConfiguration.Builder bufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)

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

Parameters:

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

Returns:

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

bufferingHints

default AmazonOpenSearchServerlessDestinationConfiguration.Builder bufferingHints(Consumer<AmazonOpenSearchServerlessBufferingHints.Builder> bufferingHints)

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

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

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

Parameters:

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

Returns:

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

See Also:

• bufferingHints(AmazonOpenSearchServerlessBufferingHints)

retryOptions

AmazonOpenSearchServerlessDestinationConfiguration.Builder retryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)

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

Parameters:

retryOptions - The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for 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 AmazonOpenSearchServerlessDestinationConfiguration.Builder retryOptions(Consumer<AmazonOpenSearchServerlessRetryOptions.Builder> retryOptions)

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

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

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

Parameters:

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

Returns:

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

See Also:

• retryOptions(AmazonOpenSearchServerlessRetryOptions)

s3BackupMode

AmazonOpenSearchServerlessDestinationConfiguration.Builder s3BackupMode(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.

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.

Returns:

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

See Also:

• AmazonOpenSearchServerlessS3BackupMode
• AmazonOpenSearchServerlessS3BackupMode

s3BackupMode

AmazonOpenSearchServerlessDestinationConfiguration.Builder s3BackupMode(AmazonOpenSearchServerlessS3BackupMode 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.

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.

Returns:

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

See Also:

• AmazonOpenSearchServerlessS3BackupMode
• AmazonOpenSearchServerlessS3BackupMode

s3Configuration

AmazonOpenSearchServerlessDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration)

Sets the value of the S3Configuration property for this object.

Parameters:

s3Configuration - The new value for the S3Configuration property for this object.

Returns:

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

s3Configuration

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

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

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

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

vpcConfiguration

AmazonOpenSearchServerlessDestinationConfiguration.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

Sets the value of the VpcConfiguration property for this object.

Parameters:

vpcConfiguration - The new value for the VpcConfiguration property for this object.

Returns:

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

vpcConfiguration

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

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