Skip to content

Commit

Permalink
docs(rds): typo in RDS prop docs (#28115)
Browse files Browse the repository at this point in the history
Fix typo found in RDS Performance Insights prop documentation.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
zerj9 authored Nov 27, 2023
1 parent 97fa162 commit 6c2d1b7
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ export interface ClusterInstanceOptions {
/**
* Whether to enable Performance Insights for the DB instance.
*
* @default - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
* @default - false, unless ``performanceInsightRetention`` or ``performanceInsightEncryptionKey`` is set.
*/
readonly enablePerformanceInsights?: boolean;

Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-rds/lib/instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ export interface DatabaseInstanceNewProps {
/**
* Whether to enable Performance Insights for the DB instance.
*
* @default - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
* @default - false, unless ``performanceInsightRetention`` or ``performanceInsightEncryptionKey`` is set.
*/
readonly enablePerformanceInsights?: boolean;

Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-rds/lib/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface InstanceProps {
/**
* Whether to enable Performance Insights for the DB instance.
*
* @default - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.
* @default - false, unless ``performanceInsightRetention`` or ``performanceInsightEncryptionKey`` is set.
*/
readonly enablePerformanceInsights?: boolean;

Expand Down

0 comments on commit 6c2d1b7

Please sign in to comment.