AWS::DMS::Endpoint ElasticsearchSettings - AWS CloudFormation
SyntaxProperties

AWS::DMS::Endpoint ElasticsearchSettings

Provides information that defines an OpenSearch endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "EndpointUri" : String,
  "ErrorRetryDuration" : Integer,
  "FullLoadErrorPercentage" : Integer,
  "ServiceAccessRoleArn" : String
}

Properties

EndpointUri

The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.

Required: No

Type: String

Update requires: No interruption

ErrorRetryDuration

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

Required: No

Type: Integer

Update requires: No interruption

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 1,000 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.

Required: No

Type: Integer

Update requires: No interruption

ServiceAccessRoleArn

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

Required: No

Type: String

Update requires: No interruption