(core): add setter for termination protection

[rittneje]

Please add a setter for the termination protection flag to the Stack class. https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Stack.html#terminationprotection

Use Case

We would like to be able to automatically enable termination protection to all of our stacks via an Aspect. However, since there is no setter for this property (it can only be set in the constructor), there's no way for that to work.

---

This is a 🚀 Feature Request

[jashgala]

Not sure if this will solve your problem, but have you considered creating an aspect that loops over your stacks and sets termination protection over them?

e.g.

export class DisableTerminationProtectionAspect implements IAspect {
  visit(construct: IConstruct): void {
    if (Stack.isStack(construct)) {
      (<any>construct).terminationProtection = false;
    }
  }
}

And then add the aspect to all your stacks which you are defining:

for (const stack of listOfStacks) {
      Aspects.of(stack).add(new DisableTerminationProtectionAspect());
}

[rittneje]

@jashgala That’s what we want to do, but it won’t work right now because the terminationProtection field is read-only, hence this request.

[jashgala]

@rittneje

I tried testing this behavior locally and here's a easy to re-produce example:
(Tested with AWS CDK version 1.102.0 build a75d52f - currently latest on NPM)

import * as cdk from '@aws-cdk/core';
import * as s3 from '@aws-cdk/aws-s3';
import { Aspects, IAspect, IConstruct, Stack } from '@aws-cdk/core';

export class DisableTerminationProtectionAspect implements IAspect {
  visit(construct: IConstruct): void {
    if (Stack.isStack(construct)) {
      (<any>construct).terminationProtection = false;
    }
  }
}

export class CdkPlaygroundStack extends cdk.Stack {
  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'Bucket');
  }
}

const app = new cdk.App();

const stack1 =new CdkPlaygroundStack(app, 'CdkPlaygroundStack1', {
  env: {
    account: process.env.ACCOUNT_ID,
    region: process.env.REGION,
  },
  terminationProtection: true
});


const stack2 = new CdkPlaygroundStack(app, 'CdkPlaygroundStack2', {
  env: {
    account: process.env.ACCOUNT_ID,
    region: process.env.REGION,
  },
  terminationProtection: true
});


Aspects.of(stack1).add(new DisableTerminationProtectionAspect());
Aspects.of(stack2).add(new DisableTerminationProtectionAspect());

When I deployed the above without the last two lines, the stacks deployed with termination protection enabled. However, after adding the last two lines and re-deploying, the stacks have their termination protection disabled.

Somehow the aspect is working fine without needing a separate setter.

[rittneje]

Then it sounds like there is a bug in CDK allowing you to set purportedly read-only fields.

For example, the Java documentation does not have a setter. https://docs.aws.amazon.com/cdk/api/latest/java/index.html?software/amazon/awscdk/core/Stack.html

Neither does the C# documentation. https://docs.aws.amazon.com/cdk/api/latest/dotnet/api/Amazon.CDK.Stack.html#Amazon_CDK_Stack_TerminationProtection

Even the TypeScript code claims it is read-only.

aws-cdk/packages/@aws-cdk/core/lib/stack.ts

Lines 132 to 137 in 283ed02

	/**
	* Whether to enable termination protection for this stack.
	*
	* @default false
	*/
	readonly terminationProtection?: boolean;

[rittneje]

ping @rix0rrr

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[rittneje]

Do not close.

[msambol]

@rittneje Can I take this?

[rittneje]

Go for it.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.