How can I add or modify extra connection attributes for an AWS DMS endpoint?

Last updated: 2019-10-03

How can I add or modify extra connection attributes for an AWS Database Migration Service (AWS DMS) endpoint?

Short Description

Extra connection attributes define the additional endpoint-specific settings for AWS DMS. For example, you can use extra connection attributes to control the timeout settings or time zone settings of your endpoint. To add or modify extra connection attributes for your AWS DMS endpoint, you can use the AWS DMS console or the AWS Command Line Interface (AWS CLI).

Resolution

Create a new endpoint with extra connection attributes using the AWS DMS console

1.    Open the AWS DMS console and choose the AWS Region that you want to create the endpoint in.

2.    Choose Endpoints from the navigation pane.

3.    Choose Create endpoint.

4.    Choose the Endpoint type and enter the Endpoint configuration details.

5.    Expand the Endpoint-specific settings section.

6.    In the Extra connection attributes field, enter the name of the extra connection attribute.
Note: For multiple extra connection attributes, enter the name and value of each attribute separated with a semicolon and no spaces, for example: encryptionMode=SSE_KMS;maxFileSize=512

7.    Optionally, choose a KMS master key.

8.    Expand the Test endpoint connection section.

9.    Choose your VPC and Replication instance.

9.    Choose Run test.

10.    After the test is successful, choose Create endpoint.

Add extra connection attributes to an existing endpoint using the AWS DMS console

1.    Open the AWS DMS console, and select the AWS Region that the endpoint is in.

2.    Choose Endpoints from the navigation pane, and select the endpoint that you want to modify.

3.    Choose Actions, and then choose Modify.

4.    Expand the Endpoint-specific settings section, and enter the extra connection attributes.

5.    Choose Save.

6.    From the Endpoints pane, select the endpoint again.

7.    Choose Actions, and then choose Test connection.

8.    Select your Replication instance, and choose Run test.

Create a new endpoint with extra connection attributes using the AWS CLI

1.    Install and configure the AWS CLI. Be sure to set the AWS Region that you want to create the endpoint in.

2.    Run the create-endpoint command similar to the following:

aws dms create-endpoint
--endpoint-identifier <value>
--endpoint-type <value>
--engine-name <value>
--username <value>
--password <value>
--server-name <value>
--port <value>
--extra-connection-attributes
    encryptionMode=SSE_KMS;maxFileSize=512

3.    Test the connectivity of the new endpoint with the replication instance:

aws dms test-connection
--replication-instance-arn <value>
--endpoint-arn <value>

Add extra connection attributes to an existing endpoint using the AWS CLI

1.    Install and configure the AWS CLI. Be sure to set the AWS Region that the endpoint is in.

2.    Run the modify-endpoint command similar to the following:

aws dms modify-endpoint
--endpoint-arn <value>
--extra-connection-attributes encryptionMode=SSE_KMS;maxFileSize=512

3.    Test the connectivity of the modified endpoint with the replication instance:

aws dms test-connection
--replication-instance-arn <value>
--endpoint-arn <value>

Did this article help you?

Anything we could improve?


Need more help?