AWS CDK Reference

Appearance

v2.274.0

PerformanceInsightRetention Enum ​

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)
Source
aws-rds/lib/props.ts
Type last changed
v2.78.0 · 4 May 2023

Example ​

ts
declare const vpc: ec2.Vpc;
declare const kmsKey: kms.Key;
new rds.DatabaseCluster(this, 'Database', {
  engine: rds.DatabaseClusterEngine.AURORA,
  vpc: vpc,
  enablePerformanceInsights: true,
  performanceInsightRetention: rds.PerformanceInsightRetention.LONG_TERM,
  performanceInsightEncryptionKey: kmsKey,
  writer: rds.ClusterInstance.provisioned('Writer', {
    instanceType: ec2.InstanceType.of(ec2.InstanceClass.R7G, ec2.InstanceSize.LARGE),
  }),
});

Members ​

MemberDescription
DEFAULTDefault retention period of 7 days.
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_TERMLong term retention period of 2 years.

Referenced by ​

  • ClusterInstanceOptions.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • DatabaseCluster.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • DatabaseClusterFromSnapshot.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • DatabaseClusterFromSnapshotProps.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • DatabaseClusterProps.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • DatabaseInstanceNewProps.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • IAuroraClusterInstance.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention
  • InstanceProps.performanceInsightRetentionperformance_insight_retentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention