feat(core): set (default) stack termination protection on (parent) stage level #33239
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
effort/medium
github-actions
bot
added
the
beginning-contributor
aws-cdk-automation
previously requested changes
Jan 30, 2025
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
2 tasks
aws-cdk-automation
added
the
pr/needs-community-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
lpizzinidev
suggested changes
Feb 1, 2025
There was a problem hiding this comment.
This is a new pull request, since the #31450 did not receive any activity/communication and had some CI quality gate check issues, so trying again if this time there's a change for getting this merged!
Sorry for that 😢 Left comments for minor adjustments. Otherwise LGTM!
Comment on lines
+1316
to
+1322
| You can also set termination protection via any parent stage and it will be inherit by all child stacks (unless overridden on stack level): | ||
| ```ts | ||
| const stage = new Stage(app, 'StageName', { | ||
| terminationProtection: true, | ||
| }); | ||
| const stack = new Stack(stage, 'StackName', {}); | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| You can also set termination protection via any parent stage and it will be inherit by all child stacks (unless overridden on stack level): | |
| ```ts | |
| const stage = new Stage(app, 'StageName', { | |
| terminationProtection: true, | |
| }); | |
| const stack = new Stack(stage, 'StackName', {}); | |
| ``` | |
| You can also set termination protection via any parent stage and it will be inherited by all child stacks (unless overridden on stack level): | |
| ```ts | |
| const stage = new Stage(app, 'StageName', { | |
| terminationProtection: true, | |
| }); | |
| const stack = new Stack(stage, 'StackName', {}); |
| /** | ||
| * Whether to enable termination protection for stacks in this stage. | ||
| * | ||
| * @default - The termination protection should be configured on the `Stack`s. |
There was a problem hiding this comment.
Suggested change
| * @default - The termination protection should be configured on the `Stack`s. | |
| * @default - The termination protection configured on the child `Stack`s. |
| @@ -337,6 +337,64 @@ describe('stage', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| test('Stack inherits termination protection from Stage', () => { | |||
There was a problem hiding this comment.
Can you please move these to the describe('stage') section?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Closes #31449.
This is a new pull request, since the previous one did not receive any activity/communication and had some CI quality gate check issues, so trying again if this time there's a change for getting this merged!
Reason for this change
New feature: Enable setting Stack (default) termination protection on (parent)
Stagelevel.Description of changes
Changes to
cdk.Stage:terminationProtectionintoStagePropsterminationProtectionproperty from parent stage, but also it can be overriden by child StagesChanges to
cdk.Stack:terminationProtectionfrom parent Stage – unless overriden on Stack levelterminationProtectionis not set in the Stack level or in any of its parent Stages, the value will default tofalseas before – hence this is NOT a breaking change.Describe any new or updated permissions being added
None.
Description of how you validated changes
I've originally done a PoC in my own codebase (by extending
cdk.Stage).After modifications into aws-cdk codebase:
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license