aws-cfm-utils

AWS CLOUDFORMATION UTILS

NPM module to create/update cloudformation stacks

Installation

npm install -g

Usage

Usage: aws-cfm-utils [options]

Help: aws-cfm-utils --help

Version: aws-cfm-utils --version

Options:
--stack-name                                               [string] [required]
--template-body                    CFM template file name             [string]
--stack-policy-body                Stack policy file name             [string]
--accesskeyid                      AWS access key                     [string]
--secretkey                        AWS secret key                     [string]
-h, --help                         Show help                         [boolean]
--parameters                       CFM Parameters                      [array]
--tags                             CFM Tags                            [array]
--region                                       [string] [default: "eu-west-1"]
--capabilities     [array] [choices: "CAPABILITY_NAMED_IAM", "CAPABILITY_IAM"]
--profile                                                             [string]
--role-arn                                                            [string]
--resource-types                                                       [array]
--disable-rollback                                                   [boolean]
--template-url                                                        [string]
--stack-policy-url                                                    [string]
--notification-arns                                                    [array]
--timeout-in-minutes                                                  [number]
--on-failure            [string] [choices: "DO_NOTHING", "ROLLBACK", "DELETE"]
--use-previous-template                                              [boolean]
--stack-policy-during-update-body                                     [string]
--stack-policy-during-update-url                                      [string]
--wait                                                               [boolean]
--enable-termination-protection                                      [boolean]
-v, --version                      Show version number               [boolean]

Examples:

1. aws-cfm-utils --stack-name stackname --template-body cfmtemplate --stack-policy-body stackpolicy --region eu-west-1 --enable-termination-protection true

2. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --enable-termination-protection true --region eu-west-1 --parameters test/fixtures/parameters.json --tags Key=TestTag,Value=TestTagValue Key=TestTag2,Value=TestTagValue2 Key=TestTag3,Value=TestTagValue4
    
3. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --enable-termination-protection true --region eu-west-1 --parameters test/fixtures/parameters.json --tags test/fixtures/tags.json
    
4. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --enable-termination-protection --region eu-west-1 --parameters ParameterKey=TestName,ParameterValue=TestKey ParameterKey=TestName2,ParameterValue=TestKey2

// More complicated ParameterValues in the following two examples, ensure to escape double quotes
5. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --enable-termination-protection --parameters ParameterKey=TestName,ParameterValue=\"subnet1,subnet2,subnet3\" ParameterKey=TestName2,ParameterValue=TestKey2

6. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --no-enable-termination-protection --parameters ParameterKey=vpc,ParameterValue=\"vpcid=12345,vpceid=12345\" ParameterKey=TestName2,ParameterValue=TestKey2

// More complicated TagValue in the following two examples, ensure to escape double quotes
7. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --enable-termination-protection --parameters ParameterKey=TestName,ParameterValue=\"subnet1,subnet2,subnet3\" ParameterKey=TestName2,ParameterValue=TestKey2 --tags Key=TestTag,Value=TestTagValue Key=s3buckets,Value=\"s3://bucket_name1/....,s3://bucket_name2/....\"

8. aws-cfm-utils --stack-name mynewstack --template-body test/fixtures/template.json --stack-policy-body test/fixtures/stackpolicy.json --no-enable-termination-protection --parameters ParameterKey=vpc,ParameterValue=\"vpcid=12345,vpceid=12345\" ParameterKey=TestName2,ParameterValue=TestKey2 --tags Key=s3bucket,Value=\"S3link=s3://bucket_name/....,S3name=bucket_name\"

In general, please use /"your_values/" for --parameters or --tags to ensure your values include all the special characters.

Global parameters (AWS CLI Docs):

--profile //optional
--region //optional, defaults to Ireland region eu-west-1

Used during creation of the stack, otherwise ignored (create-stack):

--enable-termination-protection | --no-enable-termination-protection
--disable-rollback | --no-disable-rollback
--timeout-in-minutes
--on-failure

Used during update of the stack, otherwise ignored (update-stack):

--use-previous-template | --no-use-previous-template
--stack-policy-during-update-body
--stack-policy-during-update-url

Unit Tests

npm run test

Coverage

npm run coverage

Requirements and Dependencies

1. NODE version >= 8.10

Dependencies

1. aws-sdk
2. fs
3. util
4. yargs

Disclaimer

The SOFTWARE PACKAGE provided in this page is provided "as is", without any guarantee made as to its suitability or fitness for any particular use. It may contain bugs, so use of this tool is at your own risk. We take no responsibility for any damage of any sort that may unintentionally be caused through its use.

Contacts

If you have any questions, drop an email to [e-mail] and leave stars! :)