-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Conversation
There was a problem hiding this 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.
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 |
I'm okay with no integration changes. But IMO we should add this property to |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
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 |
There was a problem hiding this 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
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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). |
@rjjaisim-at-amazon Thank you for this fix. I was wondering why this change utilized |
@Konosh93 Thanks for pointing that out, I wasn't aware of the writer and reader props - thanks for adding it |
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 theCfnDBInstance
. Also added a quick unit testDescription of how you validated changes
Added a unit test, did not add integ tests. Ran
yarn build
andyarn test
Callout: I was unable to run integration tests locally, kept getting errors with
yarn integ --directory packages/aws-cdk-lib/aws-rds
andyarn integ-runner --directory packages/aws-cdk-lib/aws-rds
-Error: Cannot find module './integ-runner.js'
, not sure if I'm missing somethingChecklist
No breaking changes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license