Skip to main content

Trivial AWS CloudFormation updater

Project description

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

Project details


Download files

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

Source Distribution

cf_upgrade-1.0.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

cf_upgrade-1.0.2-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cf_upgrade-1.0.2.tar.gz.

File metadata

  • Download URL: cf_upgrade-1.0.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cf_upgrade-1.0.2.tar.gz
Algorithm Hash digest
SHA256 0659a1b0c35cda29af8af9ee1357466ac56eb7236d1169a8577639fb583edd0c
MD5 15b6b62c784dd8058a25394af11e6513
BLAKE2b-256 c6bd90227dc85723ff936f4067e366688f929d417ca7dee42f94f5d189e80886

See more details on using hashes here.

File details

Details for the file cf_upgrade-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cf_upgrade-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 343fb2241ffe2c2f4a666451d210f1f731e9536a660999ba773a1364b5d84376
MD5 cb137ca0774251f51cf75c717466b5ee
BLAKE2b-256 0ce7b89979060011b33ca2f25625a1c9262fef2998a9efb0bcfe3e4ecd9dba75

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page