AWS dms documentation change
Summary
Restructured documentation for creating data providers in DMS Schema Conversion, added CLI examples, and clarified virtual mode usage for offline sources and virtual targets.
Security assessment
The changes focus on workflow improvements and CLI command additions. While SSL mode configuration is mentioned, it's existing functionality without new security context. No vulnerabilities, incidents, or security enhancements are referenced.
Diff
diff --git a/dms/latest/userguide/getting-started-data-providers.md b/dms/latest/userguide/getting-started-data-providers.md index 63fd53a16..842d15a53 100644 --- a//dms/latest/userguide/getting-started-data-providers.md +++ b//dms/latest/userguide/getting-started-data-providers.md @@ -7 +7 @@ -# Configure your data providers for DMS Schema Conversion +# Create data providers for DMS Schema Conversion @@ -11 +11,4 @@ Next, you create data providers that describe your source and target databases. -###### To create a data provider for an on-premises database +AWS Management Console + + +###### To create a data provider @@ -23 +26 @@ Next, you create data providers that describe your source and target databases. - 6. Turn on **Virtual mode** if you want to use schema conversion without connecting to a target database. For more information, see [Virtual data provider](./virtual-data-provider.html). + 6. To use this data provider for Schema Conversion without connecting to a database, turn on **Virtual Mode**. @@ -25 +28 @@ Next, you create data providers that describe your source and target databases. - 7. If **Virtual Mode** is turned on, connection information will be preset automatically using defaults. Note that a virtual data provider can only be used as a target in a migration project or in schema conversion. For more information on virtual mode, see [Virtual data provider](./virtual-data-provider.html). +There are two use cases where **Virtual Mode** applies: @@ -27 +30 @@ Next, you create data providers that describe your source and target databases. -If **Virtual mode** is off, provide your connection information for the source database. The connection parameters depend on your database engine. For more information, see [ Creating data providers](./data-providers-create.html). + * Offline source – Convert schemas from exported script files without connecting to the source database. Offline source is currently available for Microsoft SQL Server. @@ -29 +32 @@ If **Virtual mode** is off, provide your connection information for the source d - 8. Select **Engine configuration**. Then select **Enter manually**. Provide your connection information for the source database. The connection parameters depend on your source database engine. For more information, see [ Creating data providers](./data-providers-create.html). + * Virtual target – Convert schemas without provisioning target infrastructure. Available for all supported target databases. @@ -31 +34 @@ If **Virtual mode** is off, provide your connection information for the source d - 9. For **Secure Socket Layer (SSL) mode** , choose the type of SSL enforcement. +When **Virtual Mode** is on, the console automatically sets connection information using defaults. @@ -33 +36 @@ If **Virtual mode** is off, provide your connection information for the source d - 10. Choose **Create data provider**. +For more information about using **Virtual Mode** , see [Virtual mode for offline source and virtual target](./virtual-data-provider.html). @@ -34,0 +38 @@ If **Virtual mode** is off, provide your connection information for the source d + 7. For **Engine configuration** , choose one of the following: @@ -35,0 +40 @@ If **Virtual mode** is off, provide your connection information for the source d + * **Choose RDS database instance from list** – Choose **Browse** , and then choose your Amazon RDS database. DMS Schema Conversion automatically retrieves the engine type, server name, and port. For **Database name** , enter the name of your database. @@ -36,0 +42 @@ If **Virtual mode** is off, provide your connection information for the source d + * **Enter manually** – Enter the connection information for your database. The connection parameters depend on your database engine. For more information, see [ Creating data providers](./data-providers-create.html). @@ -38 +44 @@ If **Virtual mode** is off, provide your connection information for the source d -###### To create a data provider for an Amazon RDS database + 8. For **Secure Socket Layer (SSL) mode** , choose the type of SSL enforcement. @@ -40 +46 @@ If **Virtual mode** is off, provide your connection information for the source d - 1. Sign in to the AWS Management Console, and open the AWS DMS console. + 9. Choose **Create data provider**. @@ -42 +47,0 @@ If **Virtual mode** is off, provide your connection information for the source d - 2. In the navigation pane, choose **Data providers** , and then choose **Create data provider**. @@ -44 +48,0 @@ If **Virtual mode** is off, provide your connection information for the source d - 3. For **Name** , enter a unique name for your source data provider. For example, enter `sc-dp`. @@ -46 +49,0 @@ If **Virtual mode** is off, provide your connection information for the source d - 4. For **Purpose** , select **Schema Conversion**. @@ -48 +51,53 @@ If **Virtual mode** is off, provide your connection information for the source d - 5. For **Engine type** , choose the type of database engine for your data provider. +AWS CLI + + +To create a data provider, use the [create-data-provider](https://docs.aws.amazon.com/cli/latest/reference/dms/create-data-provider.html) command. + + + aws dms create-data-provider \ + --data-provider-name my-data-provider \ + --engine engine-type \ + --settings '{"EngineSettings":{ + "ServerName":"server-name", + "Port":port, + "DatabaseName":"database-name", + "SslMode":"ssl-mode" + }}' + +Replace the following: + + * `my-data-provider` – A unique name for your data provider. + + * `engine-type` – The database engine. Valid values include `sqlserver`, `postgres`, `oracle`, `mysql`, `aurora`, `aurora-postgresql`. + + * `EngineSettings` – The engine-specific settings object, for example `MicrosoftSqlServerSettings`, `PostgreSqlSettings`, or `OracleSettings`. + + * `server-name` – The DNS name or IP address of your database server. This value becomes the `server-name` in selection rules. + + * `port` – The port used to connect to the database server. + + * `database-name` – The name of the database. + + * `ssl-mode` – The SSL mode. Valid values: `none`, `require`, `verify-ca`, `verify-full`. + + + + +**Create an offline source** + +To create an offline source data provider, use the [create-data-provider](https://docs.aws.amazon.com/cli/latest/reference/dms/create-data-provider.html) command with the `--virtual` flag and the S3 settings in the engine configuration. + + + aws dms create-data-provider \ + --data-provider-name my-offline-source \ + --engine sqlserver \ + --settings '{"MicrosoftSqlServerSettings": + {"ServerName": "my-source-server", + "Port": 1433, + "DatabaseName": "MyDatabase", + "SslMode": "none", + "S3Path": "s3://amzn-s3-demo-bucket/my-prefix", + "S3AccessRoleArn": "arn:aws:iam::111122223333:role/my-s3-read-role"}}' \ + --virtual + +The following table describes each setting. All settings are required for an offline source. @@ -50 +105,8 @@ If **Virtual mode** is off, provide your connection information for the source d - 6. Turn **Virtual Mode** on, if you intend to use this data provider for schema conversion without connecting to a target database. For more information on virtual mode, see [Virtual data provider](./virtual-data-provider.html). +Offline source settings Setting | Required | Description +---|---|--- +`ServerName`| Yes| An identifier for this data provider. Used as `server-name` in selection rules. Does not need to be a real hostname. +`Port`| Yes| Standard port for the engine (1433 for SQL Server). No connection is made. +`DatabaseName`| Yes| A database name value. No connection is made. +`SslMode`| Yes| Use `none`. No connection is made. +`S3Path`| Yes| S3 URI prefix containing your exported DDL scripts (for example, `s3://amzn-s3-demo-bucket/my-prefix`). +`S3AccessRoleArn`| Yes| ARN of the IAM role that grants DMS read access to the S3 bucket. For more information, see [Configure S3 access permissions for an offline source](./virtual-source-s3-permissions.html). @@ -52 +114 @@ If **Virtual mode** is off, provide your connection information for the source d - 7. Select **Engine configuration**. Select **Choose RDS database instance from list**. +For more information about offline source prerequisites and S3 permissions, see [Offline source](./virtual-data-provider.html#virtual-source-data-provider). @@ -54 +116 @@ If **Virtual mode** is off, provide your connection information for the source d - 8. For **Database from RDS** , choose **Browse** , and choose your database. DMS Schema Conversion automatically retrieves the information about the engine type, server name, and port. +**Create a virtual target** @@ -56 +118 @@ If **Virtual mode** is off, provide your connection information for the source d - 9. For **Database name** , enter the name of your database. +To create a virtual target data provider, use the [create-data-provider](https://docs.aws.amazon.com/cli/latest/reference/dms/create-data-provider.html) command with the `--virtual` flag. Do not include `S3Path` or `S3AccessRoleArn` – these settings are rejected for a virtual target. @@ -58 +119,0 @@ If **Virtual mode** is off, provide your connection information for the source d - 10. For **Secure Socket Layer (SSL) mode** , choose the type of SSL enforcement. @@ -60 +121,9 @@ If **Virtual mode** is off, provide your connection information for the source d - 11. Choose **Create data provider**. + aws dms create-data-provider \ + --data-provider-name my-virtual-target \ + --engine postgres \ + --settings '{"PostgreSqlSettings": + {"ServerName": "my-target-server", + "Port": 5432, + "DatabaseName": "postgres", + "SslMode": "none"}}' \ + --virtual @@ -61,0 +131 @@ If **Virtual mode** is off, provide your connection information for the source d +The following table describes each setting. @@ -62,0 +133,8 @@ If **Virtual mode** is off, provide your connection information for the source d +Virtual target settings Setting | Required | Description +---|---|--- +`ServerName`| Yes| An identifier for this data provider. Used as `server-name` in selection rules. Does not need to be a real hostname. +`Port`| Yes| Standard port for the engine (5432 for PostgreSQL, 3306 for MySQL). No connection is made. +`DatabaseName`| Yes| A database name placeholder. No connection is made. +`SslMode`| Yes| Use `none`. No connection is made. +`S3Path`| N/A| **Do not include.** Rejected for virtual targets. +`S3AccessRoleArn`| N/A| **Do not include.** Rejected for virtual targets. @@ -63,0 +142 @@ If **Virtual mode** is off, provide your connection information for the source d +For more information about virtual mode, see [Virtual target](./virtual-data-provider.html#virtual-target-data-provider).