Automate creation of multiple Amazon Web Services DMS endpoints and replication tasks using the Amazon Web Services CLI

by Wajid Ali Mir , Dean Capps , Feng Cai , and Baji Shaik | on

July 2023: This post was reviewed for accuracy.

Amazon Web Services Database Migration Service (Amazon Web Services DMS) is a managed migration and replication service that helps move your database and analytics workloads to Amazon Web Services quickly, securely, and with minimal downtime and zero data loss. Amazon Web Services DMS can migrate your data from Amazon Web Services DMS supported sources to Amazon Web Services DMS supported targets , including most widely used commercial and open-source databases. The automation of Amazon Web Services DMS migration tasks offers the following benefits:

  • Reduced manual effort
  • Reduced time due to automation
  • Repeatable
  • Easier testing and validation process

At a high level, Amazon Web Services DMS requires the following:

  • Endpoints that identify the source and target platforms together with the required information to successfully connect to the databases
  • An Amazon Web Services DMS task that maps the objects being migrated together with any special handling required at the individual object level

In this post, we show you a solution to automate the creation of Amazon Web Services DMS endpoints and Amazon Web Services DMS tasks.

Solution overview

Our use case consists of migrating from a Microsoft SQL Server database to an Amazon Aurora PostgreSQL-Compatible Edition database. The solution consists of scripts contained in a GitHub repository that runs Amazon Web Services Command Line Interface (Amazon Web Services CLI) commands based on parameters and passwords stored in Amazon Web Services Secrets Manager . The architecture of the solution is diagrammatically represented in the following flowchart, which walks you through the process of automating and validating the creation of Amazon Web Services DMS endpoints and tasks.

The flowchart includes the following steps:

  1. Start the script blog_createdmsall.sh in the GitHub repository .
  2. Determine if database secrets exist.
    1. If no, proceed to Step 3.
    2. If yes, proceed to Step 4.
  3. Prompt for user ID and password, and create secrets.
  4. Read database information from a CSV file.
  5. Create endpoints by retrieving credentials from Secrets Manager.
  6. Generate the Amazon Web Services DMS data replication task creation script.
  7. Generate the Amazon Web Services DMS data validation task creation script with the RUNNOW option:
    1. If NO , modify the table mapping or task setting JSON for specific databases.
    2. If YES , proceed to Step 9.
  8. Test the endpoint connection.
  9. Create the Amazon Web Services DMS data replication task.
  10. Create the Amazon Web Services DMS data validation task.

Prerequisites

The following prerequisites are required to utilize this solution:

  • Existing source and target databases.
  • An existing Amazon Web Services DMS replication instance .
  • An existing certificate if TLS connection is required for on-premises databases.
  • The Amazon Web Services CLI installed and configured on a server.
  • An Amazon Web Services DMS instance with connectivity to both the source and target databases.
  • The database ID and password used by Amazon Web Services DMS are pre-created in the source and target databases. This solution requires two user account and password pairs: the first pair is used for the source database, and the second pair is used for the target database. For the purpose of automation, all the source databases share the same set of credentials, as do the target databases.
  • The Amazon Web Services DMS endpoints settings are identical for the same DBMS engine. However, each engine can have its own settings.
  • All Amazon Web Services DMS tasks share the same table mapping and task settings to simplify the logic. However, the solution incorporates a RUNNOW option to save the scripts for manual runs. With this option, you can modify the script to use a different setting JSON file.
  • The parameters required by the script are set in the DMSPROFILE.ini input file.
  • All the source and target database information is in DMSDB.ini text file, which contains five fields: EndpointType , Engine-name , DBname , Port IP , and Hostname .

The contents of the DMSPROFILE.ini input file look like the following code: 

PROFILE: default
REPLINSTANCEARN: arn:aws:dms:us-west-1:111122223333:rep: RL4OKQYFQ5WQJPBECVIN26I67MS2FFZ53GMALHY
CERTIFICATEARN: arn:aws:dms:us-west-1:111122223333:cert:TIY44ZWDPJ6ORJNJ2XQWO66RGRZN5Y2LFZKTC3A
LINEBREAK: \
SOURCENAMEPREFIX: dmsblog-s
TARGETNAMEPREFIX: dmsblog-t
MIGRATIONTYPE: full-load-and-cdc
DBLISTFILE: DMSDB.ini
CUSTOMERKEY: NO
RUNNOW: NO
VERSION: 1
REGION: us-west-1

The following is sample content of DMSDB.ini : 

----RecordFormat "EndpointType Engine-name DBname Port IP/Hostname"
source sqlserver Adventure 1433 sqlserver-ca.cj3oksygvtvq.us-west-1.rds.amazonaws.com
target aurora-postgresql adventure 5432 ab3-db-dms-rauroradbcluster-1au8tsk10jn5k.cluster-cj3oksygvtvq.us-west-1.rds.amazonaws.com

Implement the solution

This section contains the steps required to utilize this solution:

  1. Identify a server with connectivity to both the source and target databases and the Amazon Web Services CLI installed.
  2. Download the scripts contained in the GitHub repository in a new folder on the server.
  3. The process starts by running the main script blog_createdmsall.sh , which loads all the parameters from the configuration file.
  4. If the DMSSECRET.INI file doesn’t exist, the script blog_createdmsall.sh calls blog_create_secret.sh in Step 3. If the DMSSECRET.INI file exists, the script skips Step 4 and proceeds to Step 5.
  5. The secret creation script, blog_create_secret.sh , prompts the user to enter a user ID and password combination for both the source and target databases. This information is used to create secrets in Secrets Manager. The secrets are utilized when the endpoints are created. The secret isn’t referred to at run time. Two pairs of secrets (one user account and pair per secret) are created: one for the source and the other for the target.

The following screenshot is the sample output of the blog_createdmsall.sh script.

You can verify via the Secrets Manager console that the secret has been created.

  1. Retrieve the user ID and password from Secrets Manager and start a loop to read the database information contained in the DMSDB.ini file.

The database information consists of pairs of lines such that the first one is for the source and the second one is for the target. The following screenshot shows the script retrieving the database credentials from Secrets Manager.

  1. Create source and target endpoints and generate the test connection script.

You can verify via the Amazon Web Services DMS console that the endpoints have been successfully created.

  1. Generate the Amazon Web Services DMS replication task creation script.

  1. Generate the Amazon Web Services DMS data verification task creation script.

In this example, the RUNNOW option is set to NO , therefore the script names are displayed and the main script ends. This provides you an opportunity to customize the Amazon Web Services DMS task definition properties like the table mapping or task setting JSON file. If RUNNOW is set to YES , Steps 8–10 run in the main script, which provides full automation.

The following screenshot displays the instructions to run the scripts manually.

  1. Test the Amazon Web Services DMS endpoint connection and display the connection results.

It runs in parallel for all endpoints and takes about 60 seconds to complete.

You can verify via the Amazon Web Services DMS endpoints console that the connections are successful.

  1. Run the create-DMS-replications-Task.sh script to create the Amazon Web Services DMS replication task.

  1. Run the create-DMS-validation-full-load-Task.sh script to create both the full load task and the change data capture (CDC) task.

  1. Run the create-DMS-validation-cdc-Task.sh script to create the Amazon Web Services DMS validation task.

You can verify that the tasks have been successfully created via the Amazon Web Services DMS console.

You have the option to make data validation part of a replication task by modifying the task setting JSON in Step 11. If you create a validation-only task, you don’t have the option to specify full load plus CDC, unlike a replication task. Our experience shows that a CDC-only validation task performs a full table validation. This strategy provides you with the flexibility to decide how you want to run the tasks.

If you have a large number of tasks, you can load balance them across multiple replication instances to have greater throughput.

You can also use blog_create_operation.sh to generate operation scripts:

  • start-DMS-task.sh
  • stop-DMS-task.sh
  • delete-DMS-task.sh

Clean up

This section contains the steps required to clean up the artifacts created by this solution after the project is complete and no resources need to be retained. If there is a possible requirement to rerun the replication or validation, do not perform these steps.

There are two methods to clean up resources: via scripts or via the Amazon Web Services Management Console .

Clean up via scripts

You can delete all the resources we created by running the cleanup scripts:

  1. Sign in to the server you used to run the scripts.
  2. Navigate to the folder that contains the code.
  3. Run the following scripts in order:
    1. delete-DMS-task.sh
    2. delete-DMS-endpoint.sh
    3. delete-DMS-secret.sh

These scripts are created during the implementation of the solution.

Clean up via the console

You can delete all the resources we created via the console with the following steps:

  1. On the Amazon Web Services DMS console, stop all the Amazon Web Services DMS tasks.
  2. Delete the Amazon Web Services DMS tasks and endpoints.
  3. On the Secrets Manager console, delete the secrets you created.

Conclusion

Automating the creation and validation of endpoints reduces the level of effort needed to establish the Amazon Web Services DMS structures required to migrate databases for large-scale organization. Additionally, automation eliminates any errors introduced by manual migration.

If you have any questions or suggestions about this post, leave a comment. We hope the information we have shared helps!

About the Authors

Feng Cai is a Database Consultant at Amazon Web Services. He has a wide background in providing database services to clients. Feng is currently a member of the Amazon Web Services Global Competency Centre, providing homogeneous and heterogenous database migration support to public sector clients.

Wajid Ali Mir is a Database Consultant at Amazon Web Services. He has extensive database experience with customers ranging from banking, telecom, and cloud consultancy. Wajid is currently a member of the Amazon Web Services Global Competency Centre, providing homogeneous and heterogenous database migration support to commercial clients.

Dean Capps is a Database Consultant at Amazon Web Services. He has experience providing database support on legacy, open systems, and cloud platforms. Dean is currently a member of the Amazon Web Services Global Competency Centre, providing homogeneous and heterogenous database migration support to public sector clients.

Baji Shaik is a Sr. Lead Consultant with Amazon Web Services ProServe, Global Competency Centre. His background spans a wide depth and breadth of expertise and experience in SQL and NoSQL database technologies. He is a Database Migration Expert and has developed many successful database solutions addressing challenging business requirements for moving databases from on premises to Amazon RDS and Amazon Aurora PostgreSQL/MySQL. He is an eminent author, having written several books on PostgreSQL. A few of his recent works include “PostgreSQL Configuration,” “Beginning PostgreSQL on the Cloud,” and “PostgreSQL Development Essentials.” Furthermore, he has delivered several conference and workshop sessions.

The mentioned AWS GenAI Services service names relating to generative AI are only available or previewed in the Global Regions. Amazon Web Services China promotes AWS GenAI Services relating to generative AI solely for China-to-global business purposes and/or advanced technology introduction.