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): add ability to specify PreferredMaintenanceWindow to RDS cluster database instances #29033

Merged
merged 7 commits into from Mar 6, 2024

Conversation

rjjaisim-at-amazon
Copy link
Contributor

Issue # (if applicable)

Closes #16954

Reason for this change

Noticed that we were able to specify preferredMaintenanceWindow for a cluster, but unable to do so for the instances created under the cluster. Instead, AWS (semi-)randomly assigns a maintenance window (doc) for the instances, which leads to things being out of sync b/w the cluster and its child instances

There are some workarounds as mentioned in the issue above, but those are a little hacky (imo) and I figured adding the preferredMaintenanceWindow as an instance prop is a better long-term solution. Also, it might be hard for other developers to find the workarounds as they are only mentioned in the above issue and aren't available through normal channels (Stack overflow/official CDK docs)

Description of changes

Added optional preferredMaintenanceWindow field under InstanceProps, and passed that field in during the creation of the CfnDBInstance. Also added a quick unit test

Description of how you validated changes

Added a unit test, did not add integ tests. Ran yarn build and yarn test

Callout: I was unable to run integration tests locally, kept getting errors with yarn integ --directory packages/aws-cdk-lib/aws-rds and yarn integ-runner --directory packages/aws-cdk-lib/aws-rds - Error: Cannot find module './integ-runner.js', not sure if I'm missing something

Checklist

No breaking changes

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

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.

@rjjaisim-at-amazon
Copy link
Contributor Author

Exemption Request: This is a small change, so I figured integration tests weren't necessary (there are also no integration tests for the other props). Likewise for the README.md requirement, as far as I can tell, there is no README that documents every single prop in a table that I could easily append this new prop to. IMO, addtition to README.md should be done as part of a larger chore and is out of scope for this.

Please let me know your thoughts

@aws-cdk-automation aws-cdk-automation added pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Feb 8, 2024
@xazhao
Copy link
Contributor

xazhao commented Feb 26, 2024

I'm okay with no integration changes. But IMO we should add this property to README to give customers a better idea how to use it. We can add a small section specify preferred maintenance window and provide a simple example.

@xazhao xazhao added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Feb 28, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review February 28, 2024 21:48

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

@rjjaisim-at-amazon
Copy link
Contributor Author

Added details to README.md.

As for validation of the string, I believe that is done at runtime when the stacks are deployed. This has always been the case for CfnDBInstances - the preferredMaintenanceWindow prop has always existed for CfnDBInstances, but has always been set to undefined when these instances were created under a cluster (and therefore AWS would semi-randomly set a value for it on creation). My PR only allows the ability to pass in preferredMaintenanceWindow prop when creating CfnDBInstances under a cluster instead of it being undefined. We should keep the validation as is IMO and it doesn't fall under the purview of my PR

xazhao
xazhao previously approved these changes Mar 1, 2024
Copy link
Contributor

@xazhao xazhao left a comment

Choose a reason for hiding this comment

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

Looks good to me

@mergify mergify bot dismissed xazhao’s stale review March 1, 2024 20:37

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Mar 6, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 9c82bca into aws:main Mar 6, 2024
10 checks passed
@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 6, 2024
@Konosh93
Copy link
Contributor

Konosh93 commented Apr 2, 2024

@rjjaisim-at-amazon Thank you for this fix. I was wondering why this change utilized instanceProps and not writer and readers props instead, given that instanceProps is deprecated?
I tried to fix this in a new PR:

@rjjaisim-at-amazon rjjaisim-at-amazon deleted the maintenance-window branch April 2, 2024 15:05
@rjjaisim-at-amazon
Copy link
Contributor Author

@Konosh93 Thanks for pointing that out, I wasn't aware of the writer and reader props - thanks for adding it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RDS: support passing PreferredMaintenanceWindow to Cluster database instances
4 participants