Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.37 KB

README.md

File metadata and controls

31 lines (18 loc) · 1.37 KB

serverless-plugin-bootstrap

This plugin helps with ensuring that CloudFormation stacks that need to exist before your Serverless application are deployed and up-to-date.

Usage

Within your serverless.yml you can configure bootstrap behavior:

service: foo

custom:
  bootstrap:
    file: "cloudformation/bootstrap.json"

During a serverless deploy, this plugin will ensure that the stack foo-bootstrap exists and is up to date. If not, the deploy will fail. Upon failure, a CloudFormation Change Set will be left that you can review in the AWS console and execute. It's also possible your local copy of bootsrap.json is out of date, and you need to git pull/rebase.

This plugin also adds a command, bootstrap, which does the check without a deploy:

serverless bootstrap

The bootstrap command supports an optional --execute option, which will immediately apply the changes. This is most useful for the first time you are deploying, the rest of the time you should probably review the change set!

Options

The bootstrap config block supports the following additional keys as options:

stack: this overrides the stack name, which defaults to ${service}-${fileBaseNameWithoutExtension}

capabilities: this is an array of capabilities, such as CAPABILITY_IAM or CAPABILITY_NAMED_IAM which may be required depending on the resources in your bootstrap template.