aws-cloudformation-simple-cli

A simple command line tool for creating, updating and deleting AWS projects created via CloudFormation.

This project was created as an alternative to all 'heavy' frameworks being created for launching serverless applications. The intention is to provide a lightweight alternative that is very easy to get started with but on the other hand doesn't provide much in terms of functionality.

#Examples

npm install -g aws-cloudformation-simple-cli
aws-cfn create --config-file path/to/local-config-file.json --placeholder {PH1}=RP1 --placeholder $PH2$=RP2 --wait false
aws-cfn update --config-file path/to/local-config-file.json --dry-run true --environment test
aws-cfn delete --config-file path/to/local-config-file.json --wait false

Optional Command line options

--dry-run: Set to true if you want to preview the CloudFormation request. Default is false.
--wait: Set to true if you want the client to wait for the operation to complete before returning. Default is true.
--environment: Switch between environments in the local config file. See Configuration for more details. Default is none.
--placeholder: Placeholders for replacement of values in the config.json file. You can supply multiple placeholder arguments. Each placeholder is globally replaced. Syntax: PlaceholderString=ReplacementValue.

Configuration

The local configuration file describes all CloudFormation request parameters. It expects either at least one environment to be defined or a default configuration set.

If an environment is provided and there is a default config, any settings not defined under the environment will be merged with the default set. The environment settings takes precedence.

See the CloudFormation docs for available configuration properties.

Example

{
    "default": {
        "StackName": "DefaultStackName",
        "Parameters": {
            "MyTemplateParamKey": "MyTemplateParamValue",
            "MyOtherTemplateParamKey": "MyOtherTemplateParamValue"
        },
        "TemplateBody": "path/to/my-local-cloudformation.template",
        "Capabilities": [
            "CAPABILITY_IAM"
        ]
    },
    "test": {
        "StackName": "TestStackName",
        "Parameters": {
            "MyTemplateParamKey": "OverrideMyTemplateParamValue"
        },
        "TemplateURL": "http://s3-bucket-url/cloudformation.template"
    }
}

Some CloudFormation request params are expected to be "one of". These params, and which takes precedence if both are provided are listed below.

StackPolicyURL & StackPolicyBody. StackPolicyURL takes precedence.
StackPolicyDuringUpdateURL & StackPolicyDuringUpdateBody. StackPolicyDuringUpdateURL takes precedence.
TemplateURL & TemplateBody. TemplateURL takes precedence.
OnFailure & DisableRollback. OnFailure takes precedence.

Changelog

###v0.1.1

Added response message when update is not executed because there are no changes

###v0.1.0

Added support for placeholder arguments
Stricter argument validation

mike-rsi/aws-cloudformation-simple-cli

aws-cloudformation-simple-cli

Optional Command line options

Configuration

Example

Changelog