AWS prescriptive-guidance documentation change
Summary
Added 'Best practices' and 'Troubleshooting' sections, updated terminology for consistency (e.g., 'S3 bucket' to 'Amazon S3 bucket'), enhanced Secrets Manager description, and expanded related resources.
Security assessment
The changes focus on general documentation improvements and added operational guidance. While security best practices are referenced (e.g., avoiding public S3 buckets and restricting RDS access), these are pre-existing recommendations. No specific security vulnerability or incident is addressed.
Diff
diff --git a/prescriptive-guidance/latest/patterns/export-amazon-rds-for-sql-server-tables-to-an-s3-bucket-by-using-aws-dms.md b/prescriptive-guidance/latest/patterns/export-amazon-rds-for-sql-server-tables-to-an-s3-bucket-by-using-aws-dms.md index fffb5fab9..49fb0ac4b 100644 --- a//prescriptive-guidance/latest/patterns/export-amazon-rds-for-sql-server-tables-to-an-s3-bucket-by-using-aws-dms.md +++ b//prescriptive-guidance/latest/patterns/export-amazon-rds-for-sql-server-tables-to-an-s3-bucket-by-using-aws-dms.md @@ -7 +7 @@ -SummaryPrerequisites and limitationsArchitectureToolsEpicsRelated resourcesAdditional information +SummaryPrerequisites and limitationsArchitectureToolsBest practicesEpicsTroubleshootingRelated resourcesAdditional information @@ -15 +15 @@ SummaryPrerequisites and limitationsArchitectureToolsEpicsRelated resourcesAddit -Amazon Relational Database Service (Amazon RDS) for SQL Server doesn’t support loading data onto other DB engine linked servers on the Amazon Web Services (AWS) Cloud. Instead, you can use AWS Database Migration Service (AWS DMS) to export Amazon RDS for SQL Server tables to an Amazon Simple Storage Service (Amazon S3) bucket, where the data is available to other DB engines. +Amazon Relational Database Service (Amazon RDS) for SQL Server doesn’t support loading data onto other database (DB) engine linked servers on the Amazon Web Services (AWS) Cloud. Instead, you can use AWS Database Migration Service (AWS DMS) to export Amazon RDS for SQL Server tables to an Amazon Simple Storage Service (Amazon S3) bucket, where the data is available to other DB engines. @@ -19 +19 @@ AWS DMS helps you migrate databases to AWS quickly and securely. The source data -This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. Secrets Manager helps you protect secrets needed to access your applications, services, and IT resources. You can use the service to rotate, manage, and retrieve database credentials, API keys, and other secrets throughout their lifecycle. Users and applications retrieve secrets with a call to Secrets Manager, reducing the need to hardcode sensitive information. Secrets Manager offers secret rotation with built-in integration for Amazon RDS, Amazon Redshift, and Amazon DocumentDB. Also, the service is extensible to other types of secrets, including API keys and OAuth tokens. With Secrets Manager, you can control access to secrets by using fine-grained permissions and audit secret rotation centrally for resources in the AWS Cloud, third-party services, and on premises. +This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. Secrets Manager helps you protect secrets needed to access your applications, services, and IT resources. You can use the service to rotate, manage, and retrieve database credentials, API keys, and other secrets throughout their lifecycle. Users and applications retrieve secrets with a call to Secrets Manager, reducing the need to hardcode sensitive information. Secrets Manager offers secret rotation with built-in integration for Amazon RDS, Amazon Redshift, and Amazon DocumentDB (with MongoDB compatibility). Also, the service is extensible to other types of secrets, including API keys and OAuth tokens. With Secrets Manager, you can control access to secrets by using fine-grained permissions and audit secret rotation centrally for resources in the AWS Cloud, third-party services, and on premises. @@ -27 +27 @@ This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. S - * An S3 bucket + * An Amazon S3 bucket @@ -35 +35 @@ This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. S - * An AWS Identity and Access Management (IAM) role with access (list, get, and put objects) to the S3 bucket on behalf of the Amazon RDS instance. + * An AWS Identity and Access Management (IAM) role with access (list, get, and put objects) to the S3 bucket on behalf of the Amazon RDS instance @@ -37 +37 @@ This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. S - * Secrets Manager to store the RDS instance credentials. + * Secrets Manager to store the Amazon RDS instance credentials @@ -59 +59 @@ This pattern uses AWS Secrets Manager while configuring the AWS DMS endpoints. S -The following diagram shows the architecture for importing data from the Amazon RDS instance to the S3 bucket with the help of AWS DMS. +The following diagram shows the architecture for exporting data from the Amazon RDS instance to the Amazon S3 bucket with the help of AWS DMS. @@ -67 +67 @@ The following diagram shows the architecture for importing data from the Amazon - 3. The AWS DMS migration task connecting to the target S3 bucket through the target endpoint + 3. The AWS DMS migration task connecting to the target Amazon S3 bucket through the target endpoint @@ -69 +69 @@ The following diagram shows the architecture for importing data from the Amazon - 4. Exporting copied data to the S3 bucket in comma-separated values (CSV) format + 4. Exporting copied data to the Amazon S3 bucket in comma-separated values (CSV) format @@ -91 +91 @@ The following diagram shows the architecture for importing data from the Amazon -**Other services** +**Other tools** @@ -97,0 +98,13 @@ The following diagram shows the architecture for importing data from the Amazon +## Best practices + + * Run a proof of concept with a subset of tables before the full migration to benchmark performance and identify issues. + + * Avoid running AWS DMS tasks during peak database hours to reduce load on the source Amazon RDS instance. + + * Follow the [best practices for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.html). + + * Follow the [security best practices for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/security-best-practices.html). + + + + @@ -104 +117 @@ Create the Amazon RDS for SQL Server instance.| - 1. Open the AWS Management Console, choose **RDS** , and use the **Standard create** option to create an **Amazon RDS** instance with the required edition, such as SQL Server Express Edition, SQL Server Standard Edition, or SQL Server Enterprise Edition. For the version, choose 2016 or later. + 1. Open the AWS Management Console, choose **RDS** , and use the **Standard create** option to create an Amazon RDS instance with the required edition, such as SQL Server Express Edition, SQL Server Standard Edition, or SQL Server Enterprise Edition. For the version, choose 2016 or later. @@ -111 +124 @@ Set up credentials for the instance.| - 2. Provide a **username** and password for the Amazon RDS instance. + 2. Provide a username and password for the Amazon RDS instance. @@ -117 +130 @@ Configure the instance class, storage, auto scaling, and availability.| - 2. Select the Storage Type from the list: **General Purpose SSD** , **Provisioned IOPS SSD** , or **Magnetic**. Allocate the default storage size as required. + 2. Select the **Storage Type** from the list: **General Purpose SSD** , **Provisioned IOPS SSD** , or **Magnetic**. Allocate the default storage size as required. @@ -124 +137 @@ Specify the VPC, subnet group, public access, and security group.| Select the ** - * Do not enable public access to the RDS DB instance. + * Do not enable public access to the Amazon RDS instance. @@ -126 +139 @@ Specify the VPC, subnet group, public access, and security group.| Select the ** - * Use only the required IP address and port details to access the RDS instance. + * Use only the required IP address and port details to access the Amazon RDS instance. @@ -145 +158 @@ Create the secret.| - 1. On the console, choose **Secrets Manager** , and choose **Store a new secret**. + 1. On the console, choose **Secrets Manager** , and then choose **Store a new secret**. @@ -161 +174 @@ Task| Description| Skills required -Create the S3 bucket.| To save the data from Amazon RDS for SQL Server, on the console, choose **S3** , and then choose **Create bucket**. Make sure that the S3 bucket is not publicly available.| DBA, DevOps engineer +Create the Amazon S3 bucket.| To save the data from Amazon RDS for SQL Server, on the console, choose **S3** , and then choose **Create bucket**. Make sure that the Amazon S3 bucket is not publicly available.| DBA, DevOps engineer @@ -165 +178 @@ Task| Description| Skills required -Create an IAM role for AWS DMS to access Amazon S3.| Create an IAM role that allows AWS DMS to list, get, and put objects from the S3 bucket.| DBA, DevOps engineer +Create an IAM role for AWS DMS to access Amazon S3.| Create an IAM role that allows AWS DMS to list, get, and put objects from the Amazon S3 bucket.| DBA, DevOps engineer @@ -177 +190 @@ Create the AWS DMS source endpoint.| -Create the AWS DMS target endpoint.| Create the **Target endpoint,** selecting Amazon S3 as the **Target engine**.Provide the S3 bucket name and folder name for the IAM role that you created previously.| DBA, DevOps engineer +Create the AWS DMS target endpoint.| Create the **Target endpoint,** selecting Amazon S3 as the **Target engine**.Provide the Amazon S3 bucket name and folder name for the IAM role that you created previously.| DBA, DevOps engineer @@ -179 +192 @@ Create the AWS DMS replication instance.| In the same VPC, subnet, and security -Create the AWS DMS migration task.| To export the data from Amazon RDS for SQL Server to the S3 bucket, create a database migration task. For the migration type, choose **Migrate existing data**. Select the AWS DMS endpoints and replication instance that you created.| DBA, DevOps engineer +Create the AWS DMS migration task.| To export the data from Amazon RDS for SQL Server to the Amazon S3 bucket, create a database migration task. For the migration type, choose **Migrate existing data**. Select the AWS DMS endpoints and replication instance that you created.| DBA, DevOps engineer @@ -183 +196 @@ Task| Description| Skills required -Run the database migration task.| To export the SQL Server table data, start the database migration task. The task will export the data from Amazon RDS for SQL Server to the S3 bucket in CSV format.| DBA, DevOps engineer +Run the database migration task.| To export the SQL Server table data, start the database migration task. The task will export the data from Amazon RDS for SQL Server to the Amazon S3 bucket in CSV format.| DBA, DevOps engineer @@ -192 +205 @@ Delete the resources.| To avoid incurring extra costs, use the console to delete - 4. S3 bucket + 4. Amazon S3 bucket @@ -196,0 +210,7 @@ Delete the resources.| To avoid incurring extra costs, use the console to delete +## Troubleshooting + +Issue| Solution +---|--- +Troubleshooting issues with Microsoft SQL Server| For more information about resolving issues with Microsoft SQL Server while using AWS DMS, see [Troubleshooting issues with Microsoft SQL Server](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Troubleshooting.html#CHAP_Troubleshooting.SQLServer). +Troubleshooting migration tasks| For more information about resolving migration issues when using AWS DMS, see [Troubleshooting migration tasks in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Troubleshooting.html). + @@ -205 +225,5 @@ Delete the resources.| To avoid incurring extra costs, use the console to delete - * [Amazon S3 integration](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html) + * [Amazon S3 integration](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html) + + * [Using a Microsoft SQL Server database as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html) + + * [Using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html) @@ -212 +236 @@ Delete the resources.| To avoid incurring extra costs, use the console to delete -To create the database and table, and to load the example data, use the following code. +To create the database and table, and to load the example data, use the following code: