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(core): set (default) stack termination protection on (parent) stage level #31450

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

Conversation

aripalo
Copy link

@aripalo aripalo commented Sep 15, 2024

Issue #31449

Closes #31449.

Reason for this change

New feature: Enable setting Stack (default) termination protection on (parent) Stage level.

Description of changes

  1. Introduce optional terminationProtection into StageProps
  2. In Stage constructor, either use the termination protection value from its props (if set) or inherit from parent stage
  3. In Stack constructor, either use the termination protection value from its props (if set), or inherit from parent stage, or finally default to false (as before)

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:

  • I've added new unit tests into:
    • packages/aws-cdk-lib/core/test/stage.test.ts
    • packages/aws-cdk-lib/core/test/stack.test.ts
  • I've added new integ-test into packages/@aws-cdk-testing/framework-integ/test/core/test/integ.stage-termination-protection.ts and updated the snapshots

Checklist

Disclaimers:

  • This is my first code contribution to aws-cdk, apologies if I've missed something important
  • I skipped the RFC process, because this is not a breaking change… but of course if required, I can open a new discussion too.

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

@github-actions github-actions bot added feature-request A feature should be added or improved. p2 labels Sep 15, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team September 15, 2024 18:15
@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Sep 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.

@aripalo aripalo changed the title Feature: Set (default) Stack Termination Protection on (parent) Stage level feat(core): Set (default) Stack Termination Protection on (parent) Stage level Sep 15, 2024
@aripalo aripalo changed the title feat(core): Set (default) Stack Termination Protection on (parent) Stage level feat(core): set (default) stack termination protection on (parent) stage level Sep 15, 2024
@aripalo
Copy link
Author

aripalo commented Sep 15, 2024

Well, now I've solved my integ-test setup, and it seems that the termination protection is not correctly inherit by the stack (from stage) yet – even though unit tests succeed. Will investigate.

Turns out I was looking the assertion stack data in the snapshot, not the test stack data which was correct (i.e. had a termination protection enabled) 😄

@aws-cdk-automation aws-cdk-automation dismissed their stale review September 15, 2024 19:38

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: c8f0540
  • Result: FAILED
  • 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
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(core): Ability to set Stack termination protection on Stage level (and inherit by Stacks within it)
2 participants