@bjacobel/cloudformer-node
v0.0.23
Published
A port of the Ruby AWS CloudFormation tooling https://github.com/kunday/cloudformer
Downloads
28
Maintainers
Readme
cloudformer-node
A port of the Ruby AWS CloudFormation tooling https://github.com/kunday/cloudformer
Cloudformer attempts to simplify AWS Cloudformation stack creation process in NodeJS projects by providing reusable operations such as apply(create/update), delete, recreate on stack along with validations on templates. Task executions which enforce a stack change will wait until ROLLBACK/COMPLETE or DELETE is signalled on the stack (useful in continuous deployment environments to wait until deployment is successful).
Installation:
$ npm install cloudformer-node -g
AWS Environment configuration
Cloudformer depends on the aws-sdk module to query AWS API. You will need to export AWS configuration to environment variables to your .bashrc/.bash_profile or your build server:
export AWS_ACCESS_KEY=your access key
export AWS_DEFAULT_REGION=ap-southeast-2
export AWS_SECRET_ACCESS_KEY=your secret access key
JS Usage:
var stack = new Stack('tooling-test');
stack.apply('./samples/basic_template.json', {
Parameters: { AmiId: 'ami-fd9cecc7' },
DisableRollback: false,
Capabilities: [],
NotificationARNs: [],
Tags: { Name: 'mystack' }
}, console.log);
stack.outputs(console.log);
stack.delete(console.log);
CLI Usage:
stack-apply -h
stack-outputs -h
stack-delete -h
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request