AWS-CloudFormation-Diagrams 0.2.0

A simple CLI script to generate AWS infrastructure diagrams from AWS CloudFormation templates

AWS CloudFormation Diagrams

A simple CLI script to generate AWS infrastructure diagrams from AWS CloudFormation templates.

Features

• Parses both YAML and JSON AWS CloudFormation templates
• Supports 140 AWS resource types and any custom resource types
• Supports Rain::Module resource type
• Supports DependsOn, Ref, and Fn::GetAtt relationships
• Generates DOT, GIF, JPEG, PDF, PNG, SVG, and TIFF diagrams
• Provides 126 generated diagram examples

Have ideas? Open an issue or start a discussion.

Prerequisites

Following software must be installed:

• Python 3.9 or higher
• dot command (Graphviz)

Installation

Following command installs required Python dependencies, i.e., PyYAML and Diagrams.

# using pip (pip3)
pip install PyYAML diagrams

Usage

usage: aws-cfn-diagrams [-h] [-o OUTPUT] [-f FORMAT] [--embed-all-icons] filename

Generate AWS infrastructure diagrams from AWS CloudFormation templates

positional arguments:
  filename             the AWS CloudFormation template to process

options:
  -h, --help           show this help message and exit
  -o, --output OUTPUT  output diagram filename
  -f, --format FORMAT  output format, allowed formats are dot, dot_json, gif, jp2, jpe, jpeg, jpg, pdf, png, svg, tif, tiff, set to png by default
  --embed-all-icons    embed all icons into svg or dot_json output diagrams

Examples

The folder diagrams contains generated diagrams for most of AWS CloudFormation templates.

Following diagram is about WebApp:

Following diagram is about Gitea with Rain::Module:

Following diagram is about Gitea without Rain::Module:

Following diagram is about AutoScaling:

Following diagram is about EKS:

Following diagram is about VPC:

License

This project is licensed under the Apache 2.0 License.

Contributing

PRs and ideas are welcome!

Star History