Update readme

aws · Jan 11, 2024 · 7375086 · 7375086
1 parent 64e4e9a
commit 7375086
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md
@@ -959,7 +959,8 @@ const cluster = new rds.DatabaseCluster(this, 'Database', {
   // ...
 });
 
-// You can get the log group of a cluster
+// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB cluster. 
+// Specify an export value to access its log group.
 const errorLogGroup = cluster.cloudwatchLogGroups['error'];
 const auditLogGroup = cluster.cloudwatchLogGroups.audit;
 
@@ -974,7 +975,8 @@ const instance = new rds.DatabaseInstance(this, 'Instance', {
   // ...
 });
 
-// You can get the log group of a cluster
+// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB instance. 
+// Specify an export value to access its log group.
 const errorLogGroup = instance.cloudwatchLogGroups['postgresql'];
 ```
 

diff --git a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts
@@ -503,7 +503,8 @@ abstract class DatabaseClusterNew extends DatabaseClusterBase {
   public readonly vpcSubnets?: ec2.SubnetSelection;
 
   /**
-   * The log groups created when cloudwatchLogsExports is set
+   * The log groups created when cloudwatchLogsExports is set. Each export value
+   * will create a separate log group.
    */
   public readonly cloudwatchLogGroups: {[engine: string]: logs.ILogGroup};
 

diff --git a/packages/aws-cdk-lib/aws-rds/lib/instance.ts b/packages/aws-cdk-lib/aws-rds/lib/instance.ts
@@ -744,7 +744,8 @@ abstract class DatabaseInstanceNew extends DatabaseInstanceBase implements IData
   public readonly connections: ec2.Connections;
 
   /**
-   * The cloudwatch log groups created when cloudwatchLogsExports is set
+   * The log groups created when cloudwatchLogsExports is set. Each export value
+   * will create a separate log group.
    */
   public readonly cloudwatchLogGroups: {[engine: string]: logs.ILogGroup};