Skip to main content

cf-upgrade

This package contains a simple strict to update an existing CloudFormation stack. It is intended to be used as part of a CI/CD flow to update a deployment.

Usage is simple, since there are only two commands. First you can list all CloudFormation stacks using the list command:

$ cf-upgrade list
Stack             Status
----------------  ---------------
my-example-stack  UPDATE_COMPLETE

To update a stack use the upgrade command. In its simplest version you can pass a version number which will be used for a Version parameter:

$ cf-upgrade my-example-stack 1.2.0
Stack updating, waiting to complete... done

If you want to modify another parameter, or a different one you can also provide one or more key=value options:

$ cf-upgrade my-example-stack ApiVersion=1.1.0 Nginx=1.13.4
Stack updating, waiting to complete... done

Credentials

This command assumes you have AWS CLI credentials configured. You can use the –profile and –region options to indicate which AWS profile and region to use.

Permissions

In order to operate this your will need to use an AWS user with permissions to find our existing stack template and update it. In addition you must grant any permissions necessary to update your resources.

Here is a sample policy document to allow updating of ECS services:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "cloudformation:DescribeStacks",
                "cloudformation:ListStacks",
                "cloudformation:GetTemplate",
                "cloudformation:GetTemplateSummary",
                "cloudformation:UpdateStack",

                "iam:GetRole",
                "iam:PassRole",

                "ecs:UpdateService",
                "ecs:DeregisterTaskDefinition",
                "ecs:DescribeServices",
                "ecs:RegisterTaskDefinition"
            ],
            "Resource": "*"
        }
    ]
}

Changelog

1.0.2 - September 4, 2017

Fix a ReST syntax error.

1.0.1 - September 4, 2017

Use ReST for documentation to improve display on pypi.org

1.0 - September 4, 2017

First release

Release files for cf-upgrade 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cf-upgrade 1.0.2
File Size Uploaded
cf_upgrade-1.0.2.tar.gz 3.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cf-upgrade 1.0.2
File Interpreter ABI Platform
cf_upgrade-1.0.2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 9.7 kB

Release files / cf_upgrade-1.0.2.tar.gz

Download URL cf_upgrade-1.0.2.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0659a1b0c35cda29af8af9ee1357466ac56eb7236d1169a8577639fb583edd0c
BLAKE2b-256 checksum
How to use checksums
c6bd90227dc85723ff936f4067e366688f929d417ca7dee42f94f5d189e80886
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / cf_upgrade-1.0.2-py2.py3-none-any.whl

Download URL cf_upgrade-1.0.2-py2.py3-none-any.whl
Size 5.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
343fb2241ffe2c2f4a666451d210f1f731e9536a660999ba773a1364b5d84376
BLAKE2b-256 checksum
How to use checksums
0ce7b89979060011b33ca2f25625a1c9262fef2998a9efb0bcfe3e4ecd9dba75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page