Skip to content
Simple Cloud Formation for Node.js
JavaScript
Branch: master
Clone or download
Latest commit 65f835c Dec 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test fix error when parsing template that contains an S3 link (#26) Sep 25, 2018
.gitignore
.travis.yml
LICENSE Initial commit Jun 18, 2016
README.md
circle.yml fix xo issues Jul 22, 2016
cli.js add output command Sep 25, 2018
index.js
package-lock.json
package.json

README.md

cfn Build Status Coverage Status JavaScript Style Guide

cfn makes the following AWS CloudFormation tasks simpler.

Create / Update Stack
  • If the stack already exists, it Updates; otherwise, it Creates.
  • Monitors stack progress, logging events.
  • Returns a Promise. Resolves when stack Create / Update is done, Rejects if there is an error.
Delete Stack
  • Monitors stack progress, logging events.
  • Returns a Promise. Resolves when stack Create / Update is done, Rejects if there is an error.
Cleanup Stacks
  • Use regex pattern to delete stacks.
  • Include daysOld to delete stacks this old.
Validate Templates
  • Checks if a template is valid
  • Returns a Promise. Resolves when template is valid, Rejects if there is an error.

Install

$ npm install cfn --save-dev

CLI Usage

  Usage
    cfn deploy {stack name} {template} [--{param key}={param value}...]
    cfn delete {stack name}
    cfn outputs {stack name}

  Examples
    cfn deploy my-stack template.js
    cfn deploy your_stack template.yml --ImageId=ami-828283 --VpcId=vpc-828283
    cfn delete your_stack
    cfn outputs my-stack

Programmatic Usage

Create / Update

Use cfn to create or update an AWS CloudFormation stack. It returns a promise. You can use Node.js modules or standard json or yaml for AWS CloudFormation templates.

const cfn = require('cfn');

// Create or update (if it exists) the Foo-Bar stack with the template.js Node.js module.
cfn('Foo-Bar', __dirname + '/template.js')
    .then(function() {
        console.log('done');
    });

// json
cfn('Foo-Bar', 'template.json');

// yaml
cfn('Foo-Bar2', 'template.yml');


// Verbose Syntax
cfn({
  name: 'Foo-Bar',
  template: 'template.yaml',
  cfParams: {
    buildNumber: '123',
  },
  tags: {
    app: 'my app',
    department: 'accounting',
  },
  awsConfig: {
    region: 'us-east-2',
    accessKeyId: 'akid',
    secretAccessKey: 'secret',
  },
  capabilities: ['CAPABILITY_IAM'],
  checkStackInterval: 5000,
});

Delete

Delete a stack.

// Delete the Foo-Bar stack
cfn.delete('Foo-Bar');

Cleanup

Cleanup stacks based on regex and daysOld.

// Delete stacks starting with TEST- that are 3 days old or more
cfn.cleanup({
    regex: /TEST-/,
    minutesOld: 60
})
    .then(function() {
        console.log('done')
    });

Stack Exists

Returns a boolean if a stack exists or not

// Returns boolean if stack name 'foo-bar' exists
cfn.stackExists('foo-bar')
    .then(function(exists){
        if (exists){
            //Do something
        }
    })

Validate

Checks if a template is valid

// Validate a template.js Node.js module.
cfn({
    template: __dirname + '/template.js',
    params: {
        foo: 'bar'
    },
    awsConfig: {
        region: 'us-west-2'
    }
}).validate()
    .then(function(data){
        //Stack is valid do something
    },
    function(err){
        //Stack is invalid
    })

// Validate a json template.
cfn.validate('us-west-2', 'template.json');

// Validate a yaml template.
cfn.validate('us-west-2', 'template.yml');

API

cfn(name|options[, template])

Creates or Updates a stack if it already exists. Logs events and returns a Promise.

name

The name of the stack to Create / Update. If the first arg is a string it is used as name.

options

Options object. If the first arg is an object it will be used as options.

template

Path to template (js, yaml or json file), JSON object, serialized JSON string, YAML string, or a S3 Bucket URL. This is optional and if given will override options.template (if present). This arg is helpful if the first arg is the name of the template rather than an options object.

options.name

Name of stack.

options.template

Path to template (json, yaml or js file), JSON object, serialized JSON string, or a YAML string. If the optional second argument is passed in it will override this.

options.async

If set to true create/update and delete runs asynchronously. Defaults to false.

options.params

Interpolated parameters into JS module-wrapped CloudFormation templates (only should be used with js files).

A JS module-wrapped template example is shown below:

module.exports = function (params) {
    return {
        AWSTemplateFormatVersion: '2010-09-09',
        Description: 'Test Stack',
        Resources: {
            testTable: {
                Type: 'AWS::DynamoDB::Table',
                Properties: {
                    ...
                    TableName: 'FOO-TABLE-' + params.env
                }
            }
        }
    };
};

Is deployed as follows:

cfn({
    name: 'Test-Stack',
    template: 'template.js',
    params: { env: 'dev' }
});
options.cfParams

The standard AWS CloudFormation parameters to be passed into the template.

A standard AWS CloudFormation template in yaml format is shown below:

AWSTemplateFormatVersion: '2010-09-09'
Description: 'Test Stack'

Parameters:
  env:
    Type: String
    Description: The environment for the application

Resources:
  testTable:
    Type: AWS::DynamoDB::Table
    Properties:
      ...
      TableName: !Sub FOO-TABLE-${env}

Is deployed as follows:

cfn({
    name: 'Test-Stack',
    template: 'template.yml',
    cfParams: { env: 'dev' }
});
options.awsConfig

This allows you to pass any config properties allowed by the AWS Node.js SDK

cfn({
    name: 'Foo-Bar',
    template: _dirname + '/template.js',
    awsConfig: {
        region: 'us-west-2'
        accessKeyId: 'akid',
        secretAccessKey: 'secret'
    }
}).then(function() {
    console.log('done');
});
You can’t perform that action at this time.