From 3909d7e71243c3df43ecc54a703cceae0c832008 Mon Sep 17 00:00:00 2001 From: Jonathan Colbert <8918726+epoctic@users.noreply.github.com> Date: Thu, 1 Aug 2024 19:24:45 -0400 Subject: [PATCH] add sources for RDS and Secrets Manager integrations Co-authored-by: Luca Pizzini --- packages/aws-cdk-lib/aws-rds/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index 31c38d956a07f..463b5a4f5f79e 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -76,9 +76,11 @@ const cluster = new rds.DatabaseCluster(this, 'Database', { }); ``` -The manageMasterUserPassword prop supports a custom username OR custom username with customer supplied AWS KMS key. -These values are passed in using the existing `credentials` property with only the `username` and `encryptionKey` props supported. -Note: `encryptionKey` cannot be set without `username` being set as well. +The `manageMasterUserPassword` property supports a custom username or a custom username with a customer supplied AWS KMS key. + +You can specify the `username` and the `encryptionKey` via the `credentials` property. + +**Note:** `username` must be specified if `encryptionKey` is set. ```ts declare const vpc: ec2.Vpc; @@ -92,6 +94,8 @@ const cluster = new rds.DatabaseCluster(this, 'Database', { }); ``` +> Visit [Password management with Amazon RDS and AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) or [Password management with Amazon Aurora and AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) for more details. + Your cluster will be empty by default. To add a default database upon construction, specify the `defaultDatabaseName` attribute.