Skip to main content

Tools to manage CloudFormation stack configuration

Project description

Simple command line tools to create and update CloudFormation stacks that make it easy to version-control both your templates and stack configurations in one place. Supports a few proprietary transforms useful for dynamically merging a manually maintained template with a generated template (for example, sam.json from “chalice package”) that contains resources you’d like to include in your main template.


The vinstall script uses virtualenv to prepare a Python environment useful for development, so you don’t have to build and install carica-cfn-tools to be able to run and test it.

  1. Run ./vinstall

  2. Activate the virtualenv by running . ./venv/bin/activate

  3. The console_scripts listed in are now in your path, so you can simply run them like:

    carica-cfn ...

Sample Stack Config

Region: us-east-1
Bucket: mycorp-cfn-us-east-1
Name: WarehouseApp
Template: ../templates/warehouse-app.yml
  # Normal parameter values can include strings, numbers, booleans, etc.
  Stage: dev
  TableReadCapacityUnits: 10
  TableWriteCapacityUnits: 5
    # A parameter with a "ParameterStore" sub-key will be resolved to the
    # SSM Parameter Store parameter with that name.
    ParameterStore: dev.warehouseapp.admin-password
    # A parameter with a "SecretsManager" sub-key will be resolved to the
    # Secrets Manager secret with that ID.
    SecretsManager: dev.warehouseapp.postgresql-password
  - ../cfn/static/logo.png
  - ../cfn/static/index.html
  - ../cfn/includes/*.yml
  FOO: bar

Extras and JinjaExtras can be absolute paths or glob patterns relative to the stack config file.

Extras or JinjaExtras that are directories, whether specified by absolute path or expanded from a glob pattern, are copied recursively into the deployment at a top-level directory named after the last directory component of the source. An extra directory path like /foo/bar/baz ends up as /baz in the deployment.

Extras or JinjaExtras that are files, whether by absolute path or expanded from a glob pattern, are copied into the root of the deployment.

JinjaExtras are processed with the Jinja2 template engine after all extras are copied to a temporary directory.

JinjaExtrasContext is a dictionary passed as the context when Jinja is run.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for carica-cfn-tools, version 1.15
Filename, size File type Python version Upload date Hashes
Filename, size carica_cfn_tools-1.15-py2.py3-none-any.whl (17.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size carica_cfn_tools-1.15.tar.gz (13.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page