Serverless Stack Termination Protection Plugin


Table of Contents

1. Description
2. Requirements
3. Installation
4. Using the Plugin
5. Notes
6. License

Description

Following deployment, the Serverless Framework does not have the option to enable termination protection for the CloudFormation stack. This plugin will enable the termination protection. It can also disable it by using a command line option. This plugin is designed for the Serverless Framework 1.x and above.

Requirements

- Serverless Framework 3.x or greater.
- Node 8.x or greater.
- NPM 6.x or greater.

Use serverless-stack-termination-protection@1 if you need support for Serverless Framework 2.x or below.

Installation

$3

Visit the Getting Started with the Serverless Framework to get started with the Serverless Framework.

Install with npm:

``sh
npm install -g serverless
`

$3

Install with npm:

`sh
npm install --save-dev serverless-stack-termination-protection
`

And then add the plugin to your serverless.yml file:

`yaml
plugins:
- serverless-stack-termination-protection
`

See the example(s).

Using the Plugin

$3

This plugin enables termination protection automatically after the deployment. Simply run the deploy:

`sh
sls deploy
`

$3

This plugin can disable termination protection automatically after the deployment.

Simply run the deploy with the --param option:

`sh
sls deploy --param disable-termination-protection
`

If you are using multiple params, make sure to separate them:

`sh
sls deploy --param disable-termination-protection --param some-other-param
`

$3

You may apply protection for specific stages by listing the stages under a serverlessTerminationProtection custom property in the serverless yaml file.

`yaml
custom:
serverlessTerminationProtection:
stages:
- prod
`

$3

Future version will:

* Delete the stack forceably using sls remove --force`.

Please request features or report problems using the issues page.

License

See the included LICENSE for rights and limitations under the terms of the MIT license.