ElasticsearchSettings - Amazon Database Migration Service
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ElasticsearchSettings

Provides information that defines an OpenSearch endpoint.

Contents

EndpointUri

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

Type: String

Required: Yes

ServiceAccessRoleArn

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

Type: String

Required: Yes

ErrorRetryDuration

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

Type: Integer

Required: No

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.

Type: Integer

Required: No

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.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: