docs(aws-rds): Specify that grantConnect() does not work (aws#19290)

Add notes in the docs that `grantConnect()` does not work currently. Reference: aws#11851 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
steffeng · Mar 8, 2022 · e93e758 · e93e758
1 parent ffa9e0d
commit e93e758
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/@aws-cdk/aws-rds/README.md b/packages/@aws-cdk/aws-rds/README.md
@@ -326,6 +326,8 @@ You can also authenticate to a database instance using AWS Identity and Access M
 See <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html> for more information
 and a list of supported versions and limitations.
 
+**Note**: `grantConnect()` does not currently work - see [this GitHub issue](https://github.com/aws/aws-cdk/issues/11851).
+
 The following example shows enabling IAM authentication for a database instance and granting connection access to an IAM role.
 
 ```ts

diff --git a/packages/@aws-cdk/aws-rds/lib/instance.ts b/packages/@aws-cdk/aws-rds/lib/instance.ts
@@ -66,6 +66,8 @@ export interface IDatabaseInstance extends IResource, ec2.IConnectable, secretsm
 
   /**
    * Grant the given identity connection access to the database.
+   * **Note**: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.
+   * @see https://github.com/aws/aws-cdk/issues/11851
    */
   grantConnect(grantee: iam.IGrantable): iam.Grant;