AWS AmazonRDS: RDS SQL Server BYOM guide: managed master password via Secrets Manager
Summary
Restructures the BYOM DB instance creation guide (console, AWS CLI, AWS Tools for PowerShell, API), updates example engine versions (17.00.5005.3.v1) and instance class (db.m8a.xlarge), adds region parameters and verification output, and replaces the plaintext `--master-user-password <password>` example with `--manage-master-user-password` / `-ManageMasterUserPassword $true` so the master password is stored in AWS Secrets Manager, with a note on how to set your own password instead.
Security assessment
The diff swaps a literal `--master-user-password <password>` argument for `--manage-master-user-password` (and `-ManageMasterUserPassword $true` in PowerShell), explicitly documenting that the master user password is stored in AWS Secrets Manager and linking to the RDS Secrets Manager password management page. This is credential-handling best-practice guidance rather than a fix for a specific vulnerability or incident, so it is security documentation of medium severity.
Evidence
+ --manage-master-user-password \
Diff
diff --git a/AmazonRDS/latest/UserGuide/sqlserver-byom-creating-instance.md b/AmazonRDS/latest/UserGuide/sqlserver-byom-creating-instance.md index 37e152e..96e7346 100644 --- a//AmazonRDS/latest/UserGuide/sqlserver-byom-creating-instance.md +++ b//AmazonRDS/latest/UserGuide/sqlserver-byom-creating-instance.md @@ -7 +7 @@ -PrerequisitesVerifyingConsiderations +PrerequisitesCreatingVerifyingConsiderations @@ -11 +11 @@ PrerequisitesVerifyingConsiderations -You can create BYOM instances through the Amazon RDS console or the AWS CLI. +Create a BYOM DB instance by using the AWS Management Console, the [AWS CLI](https://aws.amazon.com/cli/), [AWS Tools for PowerShell](https://aws.amazon.com/powershell/), or the [Amazon RDS API](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html). The AWS CLI and AWS Tools for PowerShell come preinstalled in [AWS CloudShell](https://aws.amazon.com/cloudshell/). @@ -13 +13 @@ You can create BYOM instances through the Amazon RDS console or the AWS CLI. -**Console:** From the Create database page, you can create a BYOM instance the same way you would create a License Included (LI) instance. The console creates the BYOM engine version behind the scenes on your behalf. Note that building the engine version from your provided installation media adds approximately 20 minutes to the overall instance creation time. +**Console** – From the Create database page, you can create a BYOM instance the same way you would create a License Included (LI) instance. The console creates the BYOM engine version behind the scenes on your behalf. Note that building the engine version from your provided installation media adds approximately 20 minutes to the overall instance creation time. @@ -17 +17 @@ To avoid this additional wait, you can pre-create the BYOM engine version from t -**CLI:** Through the AWS CLI, you first call `create-custom-db-engine-version` to create the BYOM engine version, then call `create-db-instance` to launch your database. This two-step process also applies when you modify existing BYOM instances to a new minor version: create the target BYOM engine version first, wait for it to reach `Available` status, and then call `modify-db-instance` to upgrade. +**AWS CLI and AWS Tools for PowerShell** – When you use the AWS CLI or AWS Tools for PowerShell, you first create the BYOM engine version (the `CreateCustomDBEngineVersion` operation), and then create your DB instance (the `CreateDBInstance` operation). The same two steps apply when you upgrade a BYOM DB instance to a new minor version. First, create the target BYOM engine version and wait for it to reach `available` status. Then, modify the DB instance (the `ModifyDBInstance` operation). @@ -28 +28 @@ Before you create a BYOM DB instance, verify the following: - 1. Sign in to the [AWS Management Console](https://console.aws.amazon.com/rds/) and open the Amazon RDS console. +## Creating your BYOM DB instance @@ -30 +30 @@ Before you create a BYOM DB instance, verify the following: - 2. In the navigation pane, choose **Databases** , then choose **Create database**. + 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console.aws.amazon.com/rds/](https://console.aws.amazon.com/rds/). @@ -32 +32 @@ Before you create a BYOM DB instance, verify the following: - 3. For **Choose a database creation method** , choose **Full configuration**. + 2. In the navigation pane, choose **Databases**. Choose **Create database** , and then choose **Full configuration**. @@ -34 +34 @@ Before you create a BYOM DB instance, verify the following: - 4. For **Engine options** , choose **Microsoft SQL Server**. + 3. On the **Create database** page, do the following: @@ -36 +36 @@ Before you create a BYOM DB instance, verify the following: - 5. For **Templates** , choose **Production** or **Dev/Test** based on your use case. + 1. For **Engine type** , choose **Microsoft SQL Server**. @@ -38 +38 @@ Before you create a BYOM DB instance, verify the following: - 6. For **Database management type** , choose **Amazon RDS**. + 2. For **Database management type** , choose **Amazon RDS**. @@ -40 +40 @@ Before you create a BYOM DB instance, verify the following: - 7. For **Edition** , choose **SQL Server Standard Edition** or **SQL Server Enterprise Edition**. + 3. For **Edition** , choose **SQL Server Enterprise Edition** or **SQL Server Standard Edition**. @@ -42 +42 @@ Before you create a BYOM DB instance, verify the following: - 8. For **License model** , choose **BYOM (Bring Your Own Media)**. + 4. Under **Templates** , confirm the template selection. When you choose an edition, the template options change. For Enterprise Edition and Standard Edition, the options are **Production** and **Dev/Test**. @@ -44 +44 @@ Before you create a BYOM DB instance, verify the following: - 9. For **Major engine version** , choose the SQL Server version that matches your installation media (for example, 2022 or 2025). + 5. For **License Model** , choose **BYOM (Bring Your Own Media)**. @@ -46 +46 @@ Before you create a BYOM DB instance, verify the following: - 10. For **Minor engine version** , choose the target minor version (for example, `16.00.4175.1.v1` for SQL Server 2022, or `17.00.4045.5.v1` for SQL Server 2025). + 6. For **Major engine version** , choose the major version that matches your installation media, for example **SQL Server 2025**. @@ -48 +48 @@ Before you create a BYOM DB instance, verify the following: - 11. For **DB instance identifier** , enter a unique name for your DB instance. + 7. For **Minor engine version** , choose the minor version, for example `17.00.5005.3.v1`. @@ -50 +50 @@ Before you create a BYOM DB instance, verify the following: - 12. Configure the remaining settings (DB instance class, storage, connectivity, authentication, backups, and maintenance) as you would for a License Included instance. + 8. For **DB instance identifier** , enter a unique name for your DB instance. @@ -52 +52,3 @@ Before you create a BYOM DB instance, verify the following: - 13. Choose **Create database**. + 9. Configure the remaining settings (DB instance class, storage, connectivity, authentication, backups, and maintenance) as you would for a License Included DB instance. + + 4. Choose **Create database**. @@ -59 +61 @@ Amazon RDS creates the BYOM engine version automatically and launches your insta -Use the `create-db-instance` command with `--license-model bring-your-own-media`: +Use the [create-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) command with `--license-model bring-your-own-media`. @@ -64 +66 @@ Use the `create-db-instance` command with `--license-model bring-your-own-media` - --engine-version 17.00.4045.5.v1 \ + --engine-version 17.00.5005.3.v1 \ @@ -67 +69 @@ Use the `create-db-instance` command with `--license-model bring-your-own-media` - --db-instance-class db.m7i.xlarge \ + --db-instance-class db.m8a.xlarge \ @@ -69 +71 @@ Use the `create-db-instance` command with `--license-model bring-your-own-media` - --master-user-password <password> \ + --manage-master-user-password \ @@ -72 +74,32 @@ Use the `create-db-instance` command with `--license-model bring-your-own-media` - --vpc-security-group-ids sg-0123456789abcdef0 + --vpc-security-group-ids sg-0123456789abcdef0 \ + --region us-west-2 + +This example uses `--manage-master-user-password` to store the master user password in AWS Secrets Manager. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](./rds-secrets-manager.html). + +To set your own password instead, replace `--manage-master-user-password` with the following: + + + --master-user-password password + +Use the [New-RDSDBInstance](https://docs.aws.amazon.com/powershell/latest/reference/items/New-RDSDBInstance.html) cmdlet with `-LicenseModel bring-your-own-media`. + + + New-RDSDBInstance ` + -Engine sqlserver-ee ` + -EngineVersion 17.00.5005.3.v1 ` + -LicenseModel bring-your-own-media ` + -DBInstanceIdentifier my-byom-instance ` + -DBInstanceClass db.m8a.xlarge ` + -MasterUsername admin ` + -ManageMasterUserPassword $true ` + -AllocatedStorage 200 ` + -DBSubnetGroupName my-subnet-group ` + -VpcSecurityGroupId sg-0123456789abcdef0 ` + -Region us-west-2 + +This example uses `-ManageMasterUserPassword $true` to store the master user password in AWS Secrets Manager. For more information, see [Password management with Amazon RDS and AWS Secrets Manager](./rds-secrets-manager.html). + +To set your own password instead, replace `-ManageMasterUserPassword $true` with the following: + + + -MasterUserPassword password @@ -76 +109,23 @@ Use the `create-db-instance` command with `--license-model bring-your-own-media` -After you create the instance, verify that it uses the BYOM license model: +After you create the instance, verify that it uses the BYOM license model. Confirm the following values: + + * `LicenseModel` is `bring-your-own-media` – The instance uses your own SQL Server license. + + * `Engine` is `sqlserver-ee` – The correct engine edition. + + * `EngineVersion` is `17.00.5005.3.v1` – The target engine version. + + + + + 1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console.aws.amazon.com/rds/](https://console.aws.amazon.com/rds/). + + 2. In the navigation pane, choose **Databases** , and then choose the name of your DB instance. + + 3. Choose the **Configuration** tab. + + + + +Confirm that **License model** shows **Bring Your Own Media** and **Engine version** shows the target engine version. The **Engine** field at the top of the page shows the edition. + +Use the [describe-db-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command. @@ -80 +135,5 @@ After you create the instance, verify that it uses the BYOM license model: - --db-instance-identifier my-byom-instance + --db-instance-identifier my-byom-instance \ + --region us-west-2 + +The output looks like the following. + @@ -82 +141,7 @@ After you create the instance, verify that it uses the BYOM license model: -In the response, confirm the following values: + ... + "Engine": "sqlserver-ee", + ... + "EngineVersion": "17.00.5005.3.v1", + ... + "LicenseModel": "bring-your-own-media", + ... @@ -84 +149 @@ In the response, confirm the following values: - * `"LicenseModel": "bring-your-own-media"` — The instance uses your own SQL Server license. +Use the [Get-RDSDBInstance](https://docs.aws.amazon.com/powershell/latest/reference/items/Get-RDSDBInstance.html) cmdlet. @@ -86 +150,0 @@ In the response, confirm the following values: - * `"Engine": "sqlserver-ee"` — The correct engine edition. @@ -88 +152,3 @@ In the response, confirm the following values: - * `"EngineVersion": "17.00.4045.5.v1"` — The target engine version. + Get-RDSDBInstance ` + -DBInstanceIdentifier my-byom-instance ` + -Region us-west-2 @@ -89,0 +156 @@ In the response, confirm the following values: +The output looks like the following. @@ -91,0 +159,7 @@ In the response, confirm the following values: + ... + Engine : sqlserver-ee + ... + EngineVersion : 17.00.5005.3.v1 + ... + LicenseModel : bring-your-own-media + ... @@ -95 +169 @@ In the response, confirm the following values: - * If you have existing automation that creates DB instances without specifying `--license-model`, those workflows fail after you create a BYOM engine version for that engine version. Update your automation to include the `--license-model` parameter before you activate a BYOM engine version. + * If you have existing automation that creates DB instances without specifying a license model, those workflows fail after you create a BYOM engine version for that engine version. Update your automation to specify the license model before you activate a BYOM engine version.