feat(rds): add missing PerformanceInsightRetention options (#25347)

We have a requirement to set PerformanceInsights retention to 2 months. Cfn supports it. Cdk should, too.

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: ahammond

packages/aws-cdk-lib/aws-rds/lib/instance.ts

@@ -538,7 +538,7 @@ export interface DatabaseInstanceNewProps {
   /**
    * The amount of time, in days, to retain Performance Insights data.
    *
-   * @default 7
+   * @default 7 this is the free tier
    */
   readonly performanceInsightRetention?: PerformanceInsightRetention;
 

packages/aws-cdk-lib/aws-rds/lib/props.ts

@@ -529,16 +529,46 @@ export interface RotationMultiUserOptions extends CommonRotationUserOptions {
 }
 
 /**
- * The retention period for Performance Insight.
+ * The retention period for Performance Insight data, in days.
+ *
+ * Per https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod
+ * This must be either
+ * - 7 days (the default, free tier)
+ * - month * 31, where month is a number of months from 1-23
+ * - 731 (2 years)
  */
 export enum PerformanceInsightRetention {
   /**
    * Default retention period of 7 days.
    */
   DEFAULT = 7,
 
+  MONTHS_1 = 31,
+  MONTHS_2 = 31 * 2,
+  MONTHS_3 = 31 * 3,
+  MONTHS_4 = 31 * 4,
+  MONTHS_5 = 31 * 5,
+  MONTHS_6 = 31 * 6,
+  MONTHS_7 = 31 * 7,
+  MONTHS_8 = 31 * 8,
+  MONTHS_9 = 31 * 9,
+  MONTHS_10 = 31 * 10,
+  MONTHS_11 = 31 * 11,
+  MONTHS_12 = 31 * 12,
+  MONTHS_13 = 31 * 13,
+  MONTHS_14 = 31 * 14,
+  MONTHS_15 = 31 * 15,
+  MONTHS_16 = 31 * 16,
+  MONTHS_17 = 31 * 17,
+  MONTHS_18 = 31 * 18,
+  MONTHS_19 = 31 * 19,
+  MONTHS_20 = 31 * 20,
+  MONTHS_21 = 31 * 21,
+  MONTHS_22 = 31 * 22,
+  MONTHS_23 = 31 * 23,
+
   /**
    * Long term retention period of 2 years.
    */
-  LONG_TERM = 731
+  LONG_TERM = 731,
 }

packages/aws-cdk-lib/aws-rds/test/instance.test.ts

@@ -1349,6 +1349,44 @@ describe('instance', () => {
       });
     });
 
+    test.each<keyof typeof rds.PerformanceInsightRetention>([
+      'DEFAULT',
+      'MONTHS_1',
+      'MONTHS_2',
+      'MONTHS_3',
+      'MONTHS_4',
+      'MONTHS_5',
+      'MONTHS_6',
+      'MONTHS_7',
+      'MONTHS_8',
+      'MONTHS_9',
+      'MONTHS_10',
+      'MONTHS_11',
+      'MONTHS_12',
+      'MONTHS_13',
+      'MONTHS_14',
+      'MONTHS_15',
+      'MONTHS_16',
+      'MONTHS_17',
+      'MONTHS_18',
+      'MONTHS_19',
+      'MONTHS_20',
+      'MONTHS_21',
+      'MONTHS_22',
+      'MONTHS_23',
+      'LONG_TERM',
+    ])('performance insights retention of %s', (performanceInsightRetentionKey) => {
+      new rds.DatabaseInstance(stack, 'Instance', {
+        engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),
+        vpc,
+        performanceInsightRetention: rds.PerformanceInsightRetention[performanceInsightRetentionKey],
+      });
+
+      Template.fromStack(stack).hasResourceProperties('AWS::RDS::DBInstance', {
+        PerformanceInsightsRetentionPeriod: rds.PerformanceInsightRetention[performanceInsightRetentionKey],
+      });
+    });
+
     test('throws if performance insights fields are set but performance insights is disabled', () => {
       expect(() => {
         new rds.DatabaseInstance(stack, 'Instance', {