How to Use AWS CloudFormation CLI Help: Complete Guide
By Braincuber Team
Published on April 10, 2026
What You'll Learn:
- How to navigate AWS CLI help system for CloudFormation
- Using describe-stacks and other key CloudFormation commands
- Understanding CloudFormation template structure in JSON
- Finding and using official AWS sample templates
- Discovering Quick Starts for complex infrastructure
AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. This beginner guide shows you how to leverage the AWS CLI help system and find official resources to accelerate your infrastructure as code journey.
Getting Started with AWS CLI
If you are planning to manage your CloudFormation stacks through the AWS CLI rather than the Management Console, you need to configure your AWS credentials first. This step by step guide assumes you have already set up your AWS CLI with proper authentication.
You can verify your CLI is working by running a simple S3 command:
$ aws s3 ls
2019-11-03 13:16:59 athena5905
2019-02-03 18:01:42 book-3939
2014-07-01 18:52:32 elasticbeanstalk-ap-northeast-1-426397493112
2014-08-28 16:57:49 elasticbeanstalk-us-east-1-426497493912
2019-05-04 22:17:50 ltest236
2018-07-15 15:52:30 mybucket99688223
2017-07-25 17:06:43 nextcloud3239027
The command structure follows this pattern:
aws service command
Example breakdown:
aws = AWS CLI
s3 = Simple Storage Service
ls = list command
Mastering the AWS CLI Help System
One of the most valuable features of the AWS CLI is the built-in help system. Context-sensitive help is available at each layer, allowing you to explore available commands without leaving the terminal.
Accessing CloudFormation Help
To work with CloudFormation, you use the "cloudformation" keyword. Simply running the command without parameters gives you guidance on how to access help:
$ aws cloudformation
usage: aws [options] [ ...] [parameters]
To see help text, you can run:
aws help
aws help
aws help
aws: error: the following arguments are required: operation
Run aws cloudformation help to see all available subcommands:
$ aws cloudformation help
AVAILABLE COMMANDS
o cancel-update-stack
o continue-update-rollback
o create-change-set
o create-stack
o create-stack-set
o delete-change-set
o delete-stack
o delete-stack-instances
o delete-stack-set
o deploy
o describe-account-limits
o describe-change-set
o describe-stack-events
o describe-stack-instance
o describe-stack-resource
o describe-stack-resources
o describe-stack-set
o describe-stacks
o estimate-template-cost
o execute-change-set
o get-stack-policy
...
Working with CloudFormation Stacks
The describe-stacks command is one of the most frequently used CloudFormation CLI commands. It returns descriptions for specified stacks or all stacks in your account.
$ aws cloudformation describe-stacks help
SYNOPSIS
describe-stacks
[--stack-name ]
[--cli-input-json ]
[--starting-token ]
[--max-items ]
[--generate-cli-skeleton ]
OPTIONS
--stack-name (string)
The name or unique stack ID associated with the stack.
List All Stacks
Run aws cloudformation describe-stacks to see all stacks in your account.
Filter by Stack Name
Use --stack-name my-stack to view a specific stack.
Paginated Results
Use --max-items and --starting-token for large result sets.
Empty Results
If there are no stacks in your account, the command will return an empty list. This is normal for new AWS accounts.
Understanding CloudFormation Template Structure
AWS CloudFormation templates are JSON or YAML files that define your infrastructure. Amazon provides excellent sample templates to help you get started. Let us examine a typical EC2 instance template.
Template Sections Overview
| Section | Purpose |
|---|---|
| AWSTemplateFormatVersion | Template format version identifier |
| Description | Human-readable description of the template |
| Parameters | Input values to customize the stack |
| Mappings | Static key-value pairs for conditional values |
| Resources | AWS resources to create (required) |
| Outputs | Values to display after stack creation |
Sample Template: EC2 Instance with Security Group
Here is an excerpt from an AWS sample template that creates an EC2 instance with an associated Security Group:
{
"AWSTemplateFormatVersion" : "2010-09-09",
"Description" : "AWS CloudFormation Sample Template
EC2InstanceWithSecurityGroupSample: Create an Amazon
EC2 instance running the Amazon Linux AMI. **WARNING**
This template creates an Amazon EC2 instance.",
"Parameters" : {
"KeyName": {
"Description": "Name of an existing EC2 KeyPair
to enable SSH access",
"Type": "AWS::EC2::KeyPair::KeyName"
},
"InstanceType" : {
"Description": "WebServer EC2 instance type",
"Type" : "String",
"Default" : "t2.small"
}
},
"Resources" : {
"InstanceSecurityGroup": {
"Type" : "AWS::EC2::SecurityGroup",
"Properties" : {
"GroupDescription" : "Enable SSH access via port 22",
"SecurityGroupIngress" : [ {
"IpProtocol" : "tcp",
"FromPort" : "22",
"ToPort" : "22",
"CidrIp" : { "Ref" : "SSHLocation"}
} ]
}
}
}
}
Key Template Elements Explained
Parameters Section
Defines customizable inputs like KeyName (EC2 Key Pair) and InstanceType. Users can override defaults at stack creation time.
Mappings Section
Contains lookup tables for region-specific values like AMI IDs. This allows a single template to work across multiple AWS regions.
Resources Section
The core of every template. Defines AWS resources like EC2 instances, Security Groups, and their properties using intrinsic functions like Ref.
Finding AWS CloudFormation Resources
AWS provides extensive resources for learning and using CloudFormation templates. This complete tutorial section points you to the most valuable resources.
AWS CloudFormation Templates
Official page with sample templates organized by AWS service. Includes snippets, application frameworks, and cutting-edge solutions.
AWS Quick Starts
Pre-built infrastructure stacks created by AWS partners. Each Quick Start includes CloudFormation templates hosted on GitHub.
GitHub Repositories
AWS and partners host template source code on GitHub. Browse actual implementation examples and contribute improvements.
AWS Documentation
Complete documentation for all CloudFormation resource types, intrinsic functions, and best practices.
Quick Starts Example: HashiCorp Consul
AWS Quick Starts provide production-ready infrastructure templates. For example, the HashiCorp Consul Quick Start deploys a fully configured Consul cluster. Each Quick Start includes:
- CloudFormation templates for automated deployment
- GitHub-hosted source code for customization
- Step-by-step deployment guides
- Architecture diagrams and best practices
Browse Quick Starts to find pre-built solutions for common infrastructure patterns like:
| Category | Examples |
|---|---|
| Databases | PostgreSQL, MySQL, MongoDB, Redis |
| DevOps Tools | Jenkins, GitLab, Docker Enterprise |
| Networking | VPN, Transit Gateway, VPC patterns |
| Big Data | Apache Spark, Kafka, Hadoop |
Creating Your First Stack
Now that you understand the help system and template structure, you can create your first stack. Here is a step by step guide:
Download a Sample Template
Get an official AWS sample template from the CloudFormation Templates page.
Review Template Parameters
Examine the Parameters section and prepare values for KeyPair name, InstanceType, etc.
Create the Stack
Run aws cloudformation create-stack with your template and parameters.
Monitor Stack Events
Use describe-stacks to check stack status and describe-stack-events for detailed progress.
aws cloudformation create-stack --stack-name my-first-stack --template-body file://my-template.json --parameters ParameterKey=KeyName,ParameterValue=my-keypair ParameterKey=InstanceType,ParameterValue=t2.micro --capabilities CAPABILITY_IAM
Frequently Asked Questions
How do I access help for specific CloudFormation commands?
Use context-sensitive help by appending "help" to any command. For example: aws cloudformation help, aws cloudformation describe-stacks help. The help system is available at every level of the CLI.
Where can I find official CloudFormation templates?
Visit the AWS CloudFormation Templates page at aws.amazon.com/cloudformation/resources/templates for official samples organized by service. Additionally, Quick Starts provide production-ready templates for complex architectures.
What is the difference between JSON and YAML for CloudFormation?
Both JSON and YAML are supported formats. YAML is generally preferred because it supports comments, is more readable, and allows multiline strings. JSON is more strict but has better tooling support in some editors.
What are intrinsic functions in CloudFormation?
Intrinsic functions like Ref, Fn::GetAtt, and Fn::Join allow dynamic values in templates. For example, Ref references Parameters or Resources, while Fn::GetAtt retrieves resource attributes like IP addresses.
How do I estimate CloudFormation template costs?
Use the aws cloudformation estimate-template-cost command with your template and parameters. It returns an estimated monthly cost based on the resources defined in your template.
Need Help with AWS CloudFormation?
Our AWS experts can help you create infrastructure as code solutions, manage CloudFormation stacks, and optimize your AWS architecture.