https://github.com/concon121/serverless-plugin-nested-stacks

Nested stacks for sls
https://github.com/concon121/serverless-plugin-nested-stacks

Last synced: 2 months ago
JSON representation

Nested stacks for sls

• Host: GitHub
• URL: https://github.com/concon121/serverless-plugin-nested-stacks
• Owner: concon121
• License: mit
• Created: 2017-11-12T13:19:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-23T09:03:41.000Z (about 2 years ago)
• Last Synced: 2024-10-30T12:47:57.494Z (2 months ago)
• Language: JavaScript
• Size: 152 KB
• Stars: 15
• Watchers: 2
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# serverless-plugin-nested-stacks

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![npm](https://img.shields.io/npm/v/serverless-aws-nested-stacks.svg)](https://www.npmjs.com/package/serverless-aws-nested-stacks)

[![Build Status](https://travis-ci.org/concon121/serverless-plugin-nested-stacks.svg?branch=master)](https://travis-ci.org/concon121/serverless-plugin-nested-stacks)

[![codecov](https://codecov.io/gh/concon121/serverless-plugin-nested-stacks/branch/master/graph/badge.svg)](https://codecov.io/gh/concon121/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](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html) resources!