Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rds): limitless database cluster #32151

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

badmintoncryer
Copy link
Contributor

@badmintoncryer badmintoncryer commented Nov 15, 2024

Issue # (if applicable)

None

Reason for this change

Amazon Aurora has released Postgres Limitless Database and AWS CDK does not support it.
https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless.html

Description of changes

  • Add clusterScailabilityType prop to clusterProps
  • Instance creation will only be executed during the creation of a standard Aurora cluster
  • Add some validations
    • Requirements for limitless database is documented at here.

Description of how you validated changes

Add both unit and integ tests

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team November 15, 2024 12:36
@github-actions github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Nov 15, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.46%. Comparing base (0153da4) to head (4ebc477).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32151   +/-   ##
=======================================
  Coverage   77.46%   77.46%           
=======================================
  Files         105      105           
  Lines        7168     7168           
  Branches     1314     1314           
=======================================
  Hits         5553     5553           
  Misses       1433     1433           
  Partials      182      182           
Flag Coverage Δ
suite.unit 77.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 77.46% <ø> (ø)

mergify bot pushed a commit that referenced this pull request Nov 22, 2024
…2157)

### Issue # (if applicable)

None

### Reason for this change

AWS RDS now supports the configuration of advanced monitoring at the cluster level.

<https://aws.amazon.com/about-aws/whats-new/2024/09/amazon-rds-performance-insights-supports-aurora-cluster-level-configuration/?nc1=h_ls>

This feature is essential for creating limitless database cluster. (#32151)

### Description of changes

I added `enableClusterLevelEnhancedMonitoring` prop to `ClusterProps`.
If this prop enabled, `monitoringInterval` and `monitoringRole` is applied to not the instances but the cluster.

Enhanced monitoring configuration for the cluster and instances has some restrictions.
- When setting the `monitoringRoleArn` for both the cluster and instances, the values must be identical.
- When setting the `monitoringInterval` for both the cluster and instances, the values must be identical.
- When the `monitoringInterval` or `monitoringRoleArn` is set at the cluster level, enhanced monitoring will be enabled even if the same values are not specified for the instances.

Based on the above, I decided to add a flag (`enableClusterLevelEnhancedMonitoring`) to switch the application of `monitoringInterval` and `monitoringRole` between the instance level and the cluster level to avoid breaking changes to the existing props.


#### Verification Results Memo

The value of the Enhanced Monitoring configuration must be the same for both the cluster level and the instance level.

```ts
  "DatabaseB269D8BB": {
   "Type": "AWS::RDS::DBCluster",
   "Properties": {
    ...,
    "Engine": "aurora-postgresql",
    "EngineVersion": "16.1",
    "MonitoringInterval": 5,
    "MonitoringRoleArn": {
     "Fn::GetAtt": [
      "DatabaseMonitoringRoleForCluster91F5067E",
      "Arn"
     ]
    },
  },
  "DatabasewriterInstanceEBFCC003": {
   "Type": "AWS::RDS::DBInstance",
   "Properties": {
    ...,
    "DBClusterIdentifier": {
     "Ref": "DatabaseB269D8BB"
    },
    "Engine": "aurora-postgresql",
    "MonitoringInterval": 1,
    "MonitoringRoleArn": {
     "Fn::GetAtt": [
      "DatabaseMonitoringRole576991DA",
      "Arn"
     ]
    },
  }
```

```sh
           | Database/writerInstance (DatabasewriterInstanceEBFCC003) Resource handler returned message: "MonitoringInterval conflicts with cluster level parameter. (Service: Rds, Status Code: 400, Request ID: 7c9d9023-fe2a-4b39-a939-22cec3595041)" (RequestToken: bc3e18eb-2daa-4f25-c205-11f1ec70fc15, HandlerErrorCode: InvalidRequest)
```

The monitoring role arn must be the same for both cluster and instance level.

```yaml
 "DatabaseB269D8BB": {
   "Type": "AWS::RDS::DBCluster",
   "Properties": {
    ...,
    "Engine": "aurora-postgresql",
    "EngineVersion": "16.1",
    "MonitoringInterval": 5,
    "MonitoringRoleArn": {
     "Fn::GetAtt": [
      "DatabaseMonitoringRoleForCluster91F5067E",
      "Arn"
     ]
    },
  },
  "DatabasewriterInstanceEBFCC003": {
   "Type": "AWS::RDS::DBInstance",
   "Properties": {
    ...,
    "DBClusterIdentifier": {
     "Ref": "DatabaseB269D8BB"
    },
    "Engine": "aurora-postgresql",
    "MonitoringInterval": 5,
    "MonitoringRoleArn": {
     "Fn::GetAtt": [
      "DatabaseMonitoringRole576991DA",
      "Arn"
     ]
    },
  }
```

```sh
Resource handler returned message: "MonitoringRoleArn conflicts with cluster level parameter. (Service: Rds, Status Code: 400, Request ID: 761a867d-409e-4208-a08e-5591607d0ed0)" (RequestToken: fb691324-f37c-405d-e5bd-447911f7664f, HandlerErrorCode: InvalidRequest)
```

### Description of how you validated changes

Add both unit and integ tests

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@badmintoncryer badmintoncryer marked this pull request as ready for review November 23, 2024 05:00
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 23, 2024 05:01

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 25, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 4ebc477
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants