cfnlinter

The cfnlint package is an AWS CloudFormation linter that uses the AWS CloudFormation Resource Specification and is customizable and extendible with a custom ruleset.

Package is available through pip:

pip install cfnlint

Current features

• Lint specified Cloudformation yaml file
• Lint agains eu-west-1 CloudFormation definition

Upcoming features

• Tests, linter, Code Conventions, etc.
• Add Custom rules to extend/override the AWS specification
• Lint against specific region
• Add Pluggable system to add custom resource handlers for special/extended rules

Roadmap

Current planned roadmap:

Version	Functionality
0.1.x	Initialize release with basic functionality (yaml only). Customisation: Allowed resources Override required properties Enumerators (Allowed values) Top-level property support only
0.2.x	Add json support. Customisation: Additional documentation URL Regular Expression support Sub-properties support
0.3.x	?

Setup Virtual Environment

Optional but recommended. Example:

$ virtualenv -p python3 venv
$ source venv/bin/activate

Install requirements for development

$ pip install -e .

Test Application (CLI)

$ cfn-lint --cfn_file test_stack.yaml