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
fix(efs): enableAutomaticBackups property of FileSystem is always treated as if it is true (#29881) #29914
base: main
Are you sure you want to change the base?
Conversation
…ated as if it is true (aws#29881) Always set the backupPolicy property of CfnFileSystem instead of leaving it unset when enabledAutomaticBackups is false, because backups default to being enabled when not explicitly disabled in CloudFormation.
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.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
@@ -586,7 +586,7 @@ export class FileSystem extends FileSystemBase { | |||
performanceMode: props.performanceMode, | |||
throughputMode: props.throughputMode, | |||
provisionedThroughputInMibps: props.provisionedThroughputPerSecond?.toMebibytes(), | |||
backupPolicy: props.enableAutomaticBackups ? { status: 'ENABLED' } : undefined, | |||
backupPolicy: { status: props.enableAutomaticBackups ? 'ENABLED' : 'DISABLED' }, |
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.
Will this cause a breaking change where backupPolicy
was undefined
before?
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.
Can we also have unit test and integ test for this change?
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.
Yes, it will cause a breaking change. The documentation says it's false by default, but it actually is always treated as true (see #29881).
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.
Yeah, Since this involves a breaking change, we need to handle via the feature flag. CDK Feature Flags are a mechanism that allows the CDK to evolve and change the behavior of certain classes and methods, without causing disruption to existing deployed infrastructure.
Below are the steps on adding a feature flag:
- Define the feature flag in features.ts
- Update the new feature flag in FEATURE_FLAGS.md
- Implement the feature flag. For reference here
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
1 similar comment
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
Always set the backupPolicy property of CfnFileSystem instead of leaving it unset when enabledAutomaticBackups is false, because backups default to being enabled when not explicitly disabled in CloudFormation.
Issue # (if applicable)
Closes #29881.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license