Package Exports

serverless-aws-nested-stacks

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serverless-aws-nested-stacks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serverless-plugin-nested-stacks

Nested stacks for the Serverless Framework!

Installation

Run npm install in your Serverless project.

$ npm install serverless-aws-nested-stacks --save-dev

Intro

Write your nested stacks as regular cloudformation and easily integrate them with the Serverless Framework!

This plugin handles:

Adding the appropriate AWS::Cloudformation::Stack type resources to the generated sls cloudformation template.
Uploading your nested stacks to your designated S3 deployment bucket.

Configuration Reference

plugins:
  - serverless-aws-nested-stacks

custom:
  nested-stacks:
    location: nested-stacks                      # Where do you keep your nested stacks?
    stacks:
      - id: MyGroovyNestedStack                  # Logical ID (Required)
        template: nested-template.yml            # Template file name (Required)
        enabled: true                            # optional flag for enabled/disabling substack
        timeout: 60                              # Minutes before stack creation times out.
        parameters:                              # Stack parameters as key value pairs
          - InstanceType: t1.micro
          - BlahBlah: abc123
        tags:                                    # Stack tags
          - ${file(nested-stacks/core-tags.yml)} # Load tags from a file?
          - CustomTag: Yolo
        notifications:                           # Notification ARN's for SNS
          - arn:aws:sns:region:account-id:topicname

custom.nested-stacks.location - (Required) Organisation is important. Keep all your nested stacks in one place and use this attribute to define where that place is.
custom.nested-stacks.stacks - (Required) Your very own list of nested stack definitions!
custom.nested-stacks.stacks.id - (Required) The logical ID of the nested stack resource.
custom.nested-stacks.stacks.template - (Required) The file name of the nested stack. Remember, this file must exist in the directory defined by custom.nested-stacks.location.
custom.nested-stacks.stacks.timeout - Time in minutes before the stack creation times out.
custom.nested-stacks.stacks.parameters - A list of key value pairs to be passed into the nested stack as parameters.
custom.nested-stacks.stacks.tags - A list of key value pairs to be passed into the nested stack as its tags.
custom.nested-stacks.stacks.notifications - A list of existing Amazon SNS topics where notifications about stack events are sent.
custom.nested-stacks.stacks.dependson - The ID of another CloudFormation resource. Specify another stack ID to order the application of nested stacks.

Want to know more?

Read the AWS Cloudformation documentation for AWS::Cloudformation::Stack resources!