Package software.amazon.awssdk.services.databasemigration.model

Interface ElasticsearchSettings.Builder

All Superinterfaces:

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

Enclosing class:

ElasticsearchSettings

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

Method Summary

Modifier and Type	Method	Description
ElasticsearchSettings.Builder	endpointUri(String endpointUri)	The endpoint for the OpenSearch cluster.
ElasticsearchSettings.Builder	errorRetryDuration(Integer errorRetryDuration)	The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
ElasticsearchSettings.Builder	fullLoadErrorPercentage(Integer fullLoadErrorPercentage)	The maximum percentage of records that can fail to be written before a full load operation stops.
ElasticsearchSettings.Builder	serviceAccessRoleArn(String serviceAccessRoleArn)	The Amazon Resource Name (ARN) used by the service to access the IAM role.
ElasticsearchSettings.Builder	useNewMappingType(Boolean useNewMappingType)	Set this option to true for DMS to migrate documentation using the documentation type _doc.

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 Detail

serviceAccessRoleArn

ElasticsearchSettings.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Parameters:

serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Returns:

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

endpointUri

ElasticsearchSettings.Builder endpointUri(String endpointUri)

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

Parameters:

endpointUri - The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

Returns:

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

fullLoadErrorPercentage

ElasticsearchSettings.Builder fullLoadErrorPercentage(Integer fullLoadErrorPercentage)

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

Parameters:

fullLoadErrorPercentage - The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

Returns:

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

errorRetryDuration

ElasticsearchSettings.Builder errorRetryDuration(Integer errorRetryDuration)

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

Parameters:

errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

Returns:

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

useNewMappingType

ElasticsearchSettings.Builder useNewMappingType(Boolean useNewMappingType)

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

Parameters:

useNewMappingType - Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

Returns:

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