# AWS CloudFormation CLI
The missing CloudFormation CLI. Reborn!
> This code base was forked from [https://github.com/Kotaimen/awscfncli](https://github.com/Kotaimen/awscfncli) with the aim of continuing its use alongside AWS CLI v2 which enables login through AWS Identity Center
This codebase does not aim to maintain the backwards compatibility that the original `cfn-cli` repo maintained. As such it was forked, detached and will be maintained separately with feature development that will likely not be paralleled in the original code base. This allows for modern dependencies of boto3 and botocore and other python libraries to be used - reducing conflict on installation of the CLI.
This version of `cfn-cli` has been tested and validated operational on AWS CloudShell, AWS Cloud 9, AWS Linux 2023 AMIs.
## Compatibility
This tool supports Python 3.7 and above. Python 2.X is not supported.
> Note this tool is incompatible with the [AWS `cloudformation-cli` package](https://github.com/aws-cloudformation/cloudformation-cli) due to the name clash between the two tools. A "rename" is not being considered at the moment as it is considered unlilkely to require both this tool and the AWS module/resource provider development tool within the same Python environment (i.e. without use of .venv)
## License
This tool is distributed under the MIT license. The AWS CLI dependent code is distributed under the Apache 2.0 license - see ext_customizations README and LICENCE.
## Whats New
See [Feature Development](./FEATURE_DEVELOPMENT.md) for a list of new features added since the repo was forked from the original source.
## Introduction
`cfncli` helps manage AWS CloudFormation deployments.
Highlights:
- Manage deployments accoss accounts and regions use single YAML config file.
- Cross-stack parameter reference works cross-region and cross-account.
- Organize stack using stages and blueprints.
- Automatically package and upload template resources.
- Push button SAM deployment using `stack sync` command.
- Display and track stack events in the CLI.
- List stack resources, outputs and exports in the CLI.
## Install
Install from PyPi
```
pip3 install cfncli
```
## Usage
### Quickstart
cfn-cli [OPTIONS...] COMMAND SUBCOMMAND [ARGS...]
To view a list of available subcommands, use:
cfn-cli COMMAND --help
Options:
- `-f, --file`: Specify an alternate config file.
- `-s, --stack`: Specify stacks to operate on, defined by `STAGE_NAME.STACK_NAME`, default value is `*`, which means
all stacks in all stages.
- `--profile`: Override AWS profile specified in the config or environment variable `AWS_PROFILE`.
- `--region`: Override AWS region specified in the config.
- `--artifact-store`: Override bucket used for template transform/packaging specified in the config.
- `--verbose`: Be more verbose.
Options can also be specified using environment variables:
CFN_STACK=Default.Table1 cfn-cli stack deploy
By default, `cfn-cli` tries to locate `cfn-cli.yml` or `cfn-cli.yaml` file in current directory, override this use `-f`.
### Stack Selector
Individual stack can be selected using full qualified name:
cfn-cli -s Default.Table2 status
Or, select stacks use Unix globs:
cfn-cli -s Default.Table* status
cfn-cli -s Def*.Table1 status
If `.` is missing from stack selector, `cfn-cli` will assume stage name `*` is specified.
### Commands
Use `--help` to see help on a particular command.
- `generate` - Generate sample configuration file.
- `status` - Print stack status and resources.
- `validate` - Validate template file.
- `stack` - Stack operations.
- `sync` -Apply changes using ChangeSets
- `deploy` - Deploy new stacks.
- `update` - Update existing stacks.
- `tail` - Print stack events.
- `delete` - Delete stacks.
- `cancel` - Cancel stack update.
- `drift` - Drift detection.
- `detect` - Detect stack drifts.
- `diff` - Show stack resource drifts.
### Auto Completion
Auto completion is supported by [`click_completion`](https://github.com/click-contrib/click-completion/tree/master/click_completion),
supported shells are:
`bash`, `zsh` , `fish` and `Powershell`.
To install auto completion, run this in target shell:
```
> cfn-cli --install-completion
fish completion installed in /Users/Bob/.config/fish/completions/cfn-cli.fish
```
Supported completion:
- Commands and sub commands:
```
> cfn-cli drift d<TAB><TAB>
detect (Detect stack drifts.) diff (Show stack resource drifts.)
```
- Options and parameters:
```
> cfn-cli stack deploy --<TAB> <TAB>
--disable-rollback (Disable rollback if stack creation failed. You can specify ei…)
--help (Show this message and exit.)
--ignore-existing (Don't exit with error if the stack already exists.)
--no-wait (Exit immediately after deploy is started.)
--on-failure (Determines what action will be taken if stack creation fails. This …)
--timeout-in-minutes (The amount of time in minutes that can pass before the stac…)
```
- Parameter choices:
```
> cfn-cli stack deploy --on-failure <TAB> <TAB>
DELETE DO_NOTHING ROLLBACK
```
- Dynamic complete for `--profile` by search profile name in `awscli` config:
```
> cfn-cli -p <TAB><TAB>
default
prod
staging
```
- Dynamic complete for `--stack` by search stack name in `cfn-cli` config:
```
> cfn-cli -s <TAB><TAB>
Develop.ApiBackend-Develop (ApiBackend-Develop)
Production.ApiBackend-Production (ApiBackend-Production)
Staging.ApiBackend-Staging (ApiBackend-Staging)
```
### Automatic Packaging
If a template contains property which requires a S3 url or text block, Set stack `Package` parameter to `True` tells
`cfn-cli` to package the resource automatically and upload to a S3 artifact bucket, and S3 object location is inserted
into the resource location.
This feature is particular useful when your property is a lambda source code, SQL statements or some kind of
configuration.
By default, the artifact bucket is `awscfncli-${AWS_ACCOUNT_ID}-${AWS_RERION}`, and it will be created automatically
on first run. Override the default bucket using `ArtifactStore` parameter.
The following resource property are supported by `awscfncli` and official `aws cloudformation package` command:
- `BodyS3Location` property for the `AWS::ApiGateway::RestApi` resource
- `Code` property for the `AWS::Lambda::Function` resource
- `CodeUri` property for the `AWS::Serverless::Function` resource
- `ContentUri` property for the `AWS::Serverless::LayerVersion` resource
- `DefinitionS3Location` property for the `AWS::AppSync::GraphQLSchema` resource
- `RequestMappingTemplateS3Location` property for the `AWS::AppSync::Resolver` resource
- `ResponseMappingTemplateS3Location` property for the `AWS::AppSync::Resolver` resource
- `DefinitionUri` property for the `AWS::Serverless::Api` resource
- `Location` parameter for the `AWS::Include` transform
- `SourceBundle` property for the `AWS::ElasticBeanstalk::ApplicationVersion` resource
- `TemplateURL` property for the `AWS::CloudFormation::Stack` resource
- `Command.ScriptLocation` property for the `AWS::Glue::Job` resource
> To package a template build by `awssamcli`, point `Template` parameter to `sam build` output.
## Configuration
`awscfncli` uses a `YAML` config file to manage which stacks to deploy and how to deploy them. By default,
it is `cfn-cli.yml`.
### Anatomy
The config is composed of the following elements, `Version`, `Stages`
and `Blueprints`.
- `Version` (required): Version of cfn-cli config, support 2 and 3 now.
- `Stages` (required): Definition of the stack to be deployed.
- `Blueprints` (optional): Template of the stack.
The following is a simple example of a typical config:
```yaml
Version: 3
Stages:
Default:
DDB:
Template: DynamoDB_Table.yaml
Region: us-east-1
Parameters:
HashKeyElementName: id
DDB2ndIdx:
Template: DynamoDB_Secondary_Indexes.yaml
Region: us-east-1
StackPolicy: stack_policy.json
ResourceTypes:
- AWS::DynamoDB::Table
Parameters:
ReadCapacityUnits: 10
```
A stage could have multiple stacks.
In the above example, Stage `Default` have two stacks `DDB` and `DDB2ndIdx`.
Stack name could be customized and should contain only alpha and numbers.
Each stack may have the following attributes.
- Attributes introduced by `awscfncli`:
- `Profile`: Profile name of your aws credential
- `Region`: Eg. us-east-1
- `Package`: Automatically package your template or not
- `ArtifactStore`: Name of S3 bucket to store packaged files
- `Order`: Deployment order of stacks
- `Extends`: Extend a blueprint
- Attributes introduced by `boto3`:
- Please refer to [Boto3 Create Stack](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation.Client.create_stack)
### Blueprints and Inheritance
Blueprint serves as a template of a common stack. A stack could extends
a stack and override its attributes with its own attributes.
- Inheritance behaviors:
- scalar value: replace
- dict value: update
- list value: extend
- Special attributes:
- `Capabilities`: replace
For example, please refer to [Blueprints Example](samples/SAM/api_backend/cfn-cli.yaml)
### Stages and Ordering
Stage and stacks could be deployed according to the order you specified.
Order numbers are positive integers. `cfn-cli` will deploy stacks in
stages with lower order first and in each stage stacks with lower order will be deployed first.
- Stage Order
- Stack Order
```yaml
Stages:
Stage1:
Order: 1
Stack1:
Order: 1
Stack2:
Order: 2
Stage2:
Order: 2
```
For examples, please refer to [Order Example](samples/Nested/StaticWebSiteWithPipeline/cfn-cli.yaml)
### Cross Stack Reference
In many cases, a stack's input parameter depends on output from other stacks during deployment. Cross stack reference allows stacks collect their inputs from outputs form other stacks, including stacks deployed to other region and account.
An stack parameter can reference ouputs of another stack in same configuration file by using the following syntax:
```yaml
Stack1:
Parameters:
VpcId: ${StageName.StackName.OutputName}
```
This feature make managing related cross-account and/or cross-region stacks much easier.
See [VPC peering](samples/Advanced/VpcPeering/cfn-cli.yml) and [CodePipeline](https://github.com/Kotaimen/sample-python-sam-ci/blob/master/cfn-cli.sample400.yaml) for example.
> Note: Take care of the order of deployment so eferenced stack is deployed first.
Raw data
{
"_id": null,
"home_page": "https://github.com/andyfase/cfncli",
"name": "cfncli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "aws cfn cli cloudformation changeset sam serverless",
"author": "Fase, Andy",
"author_email": "andyfase@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/40/23/d3316ee394c3d2a1e22b4bc0a6a62c8b7f61379202634a048b43af51a3b8/cfncli-0.2.2.tar.gz",
"platform": null,
"description": "# AWS CloudFormation CLI\n\nThe missing CloudFormation CLI. Reborn!\n\n> This code base was forked from [https://github.com/Kotaimen/awscfncli](https://github.com/Kotaimen/awscfncli) with the aim of continuing its use alongside AWS CLI v2 which enables login through AWS Identity Center\n\nThis codebase does not aim to maintain the backwards compatibility that the original `cfn-cli` repo maintained. As such it was forked, detached and will be maintained separately with feature development that will likely not be paralleled in the original code base. This allows for modern dependencies of boto3 and botocore and other python libraries to be used - reducing conflict on installation of the CLI.\n\nThis version of `cfn-cli` has been tested and validated operational on AWS CloudShell, AWS Cloud 9, AWS Linux 2023 AMIs. \n\n\n## Compatibility\n\nThis tool supports Python 3.7 and above. Python 2.X is not supported. \n\n> Note this tool is incompatible with the [AWS `cloudformation-cli` package](https://github.com/aws-cloudformation/cloudformation-cli) due to the name clash between the two tools. A \"rename\" is not being considered at the moment as it is considered unlilkely to require both this tool and the AWS module/resource provider development tool within the same Python environment (i.e. without use of .venv)\n\n## License\n\nThis tool is distributed under the MIT license. The AWS CLI dependent code is distributed under the Apache 2.0 license - see ext_customizations README and LICENCE.\n\n## Whats New\n\nSee [Feature Development](./FEATURE_DEVELOPMENT.md) for a list of new features added since the repo was forked from the original source.\n\n## Introduction\n\n`cfncli` helps manage AWS CloudFormation deployments. \n\nHighlights:\n\n- Manage deployments accoss accounts and regions use single YAML config file.\n- Cross-stack parameter reference works cross-region and cross-account.\n- Organize stack using stages and blueprints.\n- Automatically package and upload template resources.\n- Push button SAM deployment using `stack sync` command.\n- Display and track stack events in the CLI.\n- List stack resources, outputs and exports in the CLI.\n\n## Install\n\nInstall from PyPi\n\n```\npip3 install cfncli\n```\n\n## Usage\n\n### Quickstart\n\n cfn-cli [OPTIONS...] COMMAND SUBCOMMAND [ARGS...]\n\nTo view a list of available subcommands, use:\n\n cfn-cli COMMAND --help\n\nOptions:\n\n- `-f, --file`: Specify an alternate config file.\n- `-s, --stack`: Specify stacks to operate on, defined by `STAGE_NAME.STACK_NAME`, default value is `*`, which means \n all stacks in all stages.\n- `--profile`: Override AWS profile specified in the config or environment variable `AWS_PROFILE`.\n- `--region`: Override AWS region specified in the config.\n- `--artifact-store`: Override bucket used for template transform/packaging specified in the config.\n- `--verbose`: Be more verbose.\n\nOptions can also be specified using environment variables:\n\n CFN_STACK=Default.Table1 cfn-cli stack deploy\n\nBy default, `cfn-cli` tries to locate `cfn-cli.yml` or `cfn-cli.yaml` file in current directory, override this use `-f`.\n\n### Stack Selector\n\nIndividual stack can be selected using full qualified name:\n\n cfn-cli -s Default.Table2 status\n\nOr, select stacks use Unix globs:\n\n cfn-cli -s Default.Table* status\n cfn-cli -s Def*.Table1 status\n\nIf `.` is missing from stack selector, `cfn-cli` will assume stage name `*` is specified.\n\n### Commands\n\nUse `--help` to see help on a particular command.\n\n- `generate` - Generate sample configuration file.\n- `status` - Print stack status and resources.\n- `validate` - Validate template file.\n- `stack` - Stack operations.\n - `sync` -Apply changes using ChangeSets\n - `deploy` - Deploy new stacks.\n - `update` - Update existing stacks.\n - `tail` - Print stack events.\n - `delete` - Delete stacks.\n - `cancel` - Cancel stack update.\n- `drift` - Drift detection.\n - `detect` - Detect stack drifts.\n - `diff` - Show stack resource drifts.\n\n### Auto Completion\n\nAuto completion is supported by [`click_completion`](https://github.com/click-contrib/click-completion/tree/master/click_completion), \nsupported shells are:\n `bash`, `zsh` , `fish` and `Powershell`. \n\nTo install auto completion, run this in target shell:\n\n```\n> cfn-cli --install-completion\nfish completion installed in /Users/Bob/.config/fish/completions/cfn-cli.fish\n```\n\nSupported completion:\n\n- Commands and sub commands:\n ```\n > cfn-cli drift d<TAB><TAB> \n detect (Detect stack drifts.) diff (Show stack resource drifts.)\n ```\n- Options and parameters:\n ```\n > cfn-cli stack deploy --<TAB> <TAB>\n --disable-rollback (Disable rollback if stack creation failed. You can specify ei\u2026)\n --help (Show this message and exit.)\n --ignore-existing (Don't exit with error if the stack already exists.)\n --no-wait (Exit immediately after deploy is started.)\n --on-failure (Determines what action will be taken if stack creation fails. This \u2026)\n --timeout-in-minutes (The amount of time in minutes that can pass before the stac\u2026)\n ```\n- Parameter choices:\n ```\n > cfn-cli stack deploy --on-failure <TAB> <TAB>\n DELETE DO_NOTHING ROLLBACK \n ```\n\n- Dynamic complete for `--profile` by search profile name in `awscli` config:\n ```\n > cfn-cli -p <TAB><TAB>\n default\n prod\n staging\n ```\n- Dynamic complete for `--stack` by search stack name in `cfn-cli` config:\n ```\n > cfn-cli -s <TAB><TAB>\n Develop.ApiBackend-Develop (ApiBackend-Develop)\n Production.ApiBackend-Production (ApiBackend-Production)\n Staging.ApiBackend-Staging (ApiBackend-Staging)\n ```\n\n### Automatic Packaging\n\nIf a template contains property which requires a S3 url or text block, Set stack `Package` parameter to `True` tells \n`cfn-cli` to package the resource automatically and upload to a S3 artifact bucket, and S3 object location is inserted \ninto the resource location.\n\nThis feature is particular useful when your property is a lambda source code, SQL statements or some kind of \nconfiguration.\n\nBy default, the artifact bucket is `awscfncli-${AWS_ACCOUNT_ID}-${AWS_RERION}`, and it will be created automatically \non first run. Override the default bucket using `ArtifactStore` parameter.\n\nThe following resource property are supported by `awscfncli` and official `aws cloudformation package` command:\n\n- `BodyS3Location` property for the `AWS::ApiGateway::RestApi` resource\n- `Code` property for the `AWS::Lambda::Function` resource\n- `CodeUri` property for the `AWS::Serverless::Function` resource\n- `ContentUri` property for the `AWS::Serverless::LayerVersion` resource\n- `DefinitionS3Location` property for the `AWS::AppSync::GraphQLSchema` resource\n- `RequestMappingTemplateS3Location` property for the `AWS::AppSync::Resolver` resource\n- `ResponseMappingTemplateS3Location` property for the `AWS::AppSync::Resolver` resource\n- `DefinitionUri` property for the `AWS::Serverless::Api` resource\n- `Location` parameter for the `AWS::Include` transform\n- `SourceBundle` property for the `AWS::ElasticBeanstalk::ApplicationVersion` resource\n- `TemplateURL` property for the `AWS::CloudFormation::Stack` resource\n- `Command.ScriptLocation` property for the `AWS::Glue::Job` resource\n\n> To package a template build by `awssamcli`, point `Template` parameter to `sam build` output.\n\n## Configuration\n\n`awscfncli` uses a `YAML` config file to manage which stacks to deploy and how to deploy them. By default, \nit is `cfn-cli.yml`.\n\n### Anatomy\nThe config is composed of the following elements, `Version`, `Stages`\nand `Blueprints`.\n\n- `Version` (required): Version of cfn-cli config, support 2 and 3 now.\n- `Stages` (required): Definition of the stack to be deployed.\n- `Blueprints` (optional): Template of the stack.\n\nThe following is a simple example of a typical config:\n\n```yaml\nVersion: 3\n\nStages:\n Default:\n DDB:\n Template: DynamoDB_Table.yaml\n Region: us-east-1\n Parameters:\n HashKeyElementName: id\n DDB2ndIdx:\n Template: DynamoDB_Secondary_Indexes.yaml\n Region: us-east-1\n StackPolicy: stack_policy.json\n ResourceTypes:\n - AWS::DynamoDB::Table\n Parameters:\n ReadCapacityUnits: 10\n```\n\nA stage could have multiple stacks.\nIn the above example, Stage `Default` have two stacks `DDB` and `DDB2ndIdx`.\nStack name could be customized and should contain only alpha and numbers.\n\nEach stack may have the following attributes.\n\n- Attributes introduced by `awscfncli`:\n - `Profile`: Profile name of your aws credential\n - `Region`: Eg. us-east-1\n - `Package`: Automatically package your template or not\n - `ArtifactStore`: Name of S3 bucket to store packaged files\n - `Order`: Deployment order of stacks\n - `Extends`: Extend a blueprint\n- Attributes introduced by `boto3`:\n - Please refer to [Boto3 Create Stack](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation.Client.create_stack)\n\n\n### Blueprints and Inheritance \nBlueprint serves as a template of a common stack. A stack could extends\na stack and override its attributes with its own attributes.\n\n\n- Inheritance behaviors:\n - scalar value: replace\n - dict value: update\n - list value: extend\n\n\n- Special attributes:\n - `Capabilities`: replace\n\nFor example, please refer to [Blueprints Example](samples/SAM/api_backend/cfn-cli.yaml)\n\n### Stages and Ordering\nStage and stacks could be deployed according to the order you specified.\nOrder numbers are positive integers. `cfn-cli` will deploy stacks in\nstages with lower order first and in each stage stacks with lower order will be deployed first.\n\n- Stage Order\n- Stack Order\n\n```yaml\n Stages:\n Stage1:\n Order: 1\n Stack1:\n Order: 1\n Stack2:\n Order: 2\n Stage2:\n Order: 2\n```\n\nFor examples, please refer to [Order Example](samples/Nested/StaticWebSiteWithPipeline/cfn-cli.yaml)\n\n\n### Cross Stack Reference\n\nIn many cases, a stack's input parameter depends on output from other stacks during deployment. Cross stack reference allows stacks collect their inputs from outputs form other stacks, including stacks deployed to other region and account.\n\nAn stack parameter can reference ouputs of another stack in same configuration file by using the following syntax:\n\n```yaml\nStack1:\n Parameters:\n VpcId: ${StageName.StackName.OutputName}\n```\n\nThis feature make managing related cross-account and/or cross-region stacks much easier.\nSee [VPC peering](samples/Advanced/VpcPeering/cfn-cli.yml) and [CodePipeline](https://github.com/Kotaimen/sample-python-sam-ci/blob/master/cfn-cli.sample400.yaml) for example.\n\n> Note: Take care of the order of deployment so eferenced stack is deployed first.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CloudFormation CLI Wrapper",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/andyfase/cfncli"
},
"split_keywords": [
"aws",
"cfn",
"cli",
"cloudformation",
"changeset",
"sam",
"serverless"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4023d3316ee394c3d2a1e22b4bc0a6a62c8b7f61379202634a048b43af51a3b8",
"md5": "00a32d95af516836074928482fa70713",
"sha256": "44dceec9f7b053465754091307359cd845293ff36e0be223d0b04dfa2e285f56"
},
"downloads": -1,
"filename": "cfncli-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "00a32d95af516836074928482fa70713",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 56988,
"upload_time": "2025-07-29T23:40:54",
"upload_time_iso_8601": "2025-07-29T23:40:54.956594Z",
"url": "https://files.pythonhosted.org/packages/40/23/d3316ee394c3d2a1e22b4bc0a6a62c8b7f61379202634a048b43af51a3b8/cfncli-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-29 23:40:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andyfase",
"github_project": "cfncli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cfncli"
}
JSON
