cfn-lint-serverless
Ruleset for cfn-lint to validate CloudFormation templates for serverless applications against recommended best practices.
Requirements
- Python 3.10 or later (up to 3.14)
- cfn-lint 1.57.0 or later
Installation
pip install cfn-lint cfn-lint-serverless
For a reproducible development environment, install uv and run make dev in this directory, which creates a locked virtual environment with uv sync --all-groups.
Usage
Run cfn-lint with the serverless rules module:
cfn-lint template.yaml -a cfn_lint_serverless.rules
Supported Rules
This module provides validation rules for various AWS serverless resources:
- Lambda Functions
- API Gateway
- Step Functions
- SQS
- SNS
- EventBridge
- AppSync
For a detailed list of rules, refer to the documentation.
Examples
Try it with the examples provided in the repository:
# For SAM templates
cfn-lint examples/sam/template.yaml -a cfn_lint_serverless.rules
# For Serverless Framework templates
cfn-lint examples/serverless-framework/template.yaml -a cfn_lint_serverless.rules
Contributing
Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines.
License
This project is licensed under the MIT-0 License. See the LICENSE file for details.
2 maintainers
Metadata
2 maintainers
Release files for cfn_lint_serverless 0.3.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cfn_lint_serverless-0.3.6.tar.gz | 77.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cfn_lint_serverless-0.3.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 92.9 kB
Release files / cfn_lint_serverless-0.3.6.tar.gz
| Download URL | cfn_lint_serverless-0.3.6.tar.gz |
|---|---|
| Size | 77.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a5d9e13dfaacea56fb60edcf7a462e8238b9d8ff2049e84d37ae9bfba5c45129
|
|
BLAKE2b-256 checksum How to use checksums |
a97451f2c3f9575b8b9d10a6f65f7e839b6086b831fa22487d2170a9a1a7fe31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / cfn_lint_serverless-0.3.6-py3-none-any.whl
| Download URL | cfn_lint_serverless-0.3.6-py3-none-any.whl |
|---|---|
| Size | 15.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bae9842418ede22ed42a3d8047c5ccb7aed0662d28cb43e5c008d7943ae4cffe
|
|
BLAKE2b-256 checksum How to use checksums |
80e22a7901544ec10986347b791f0ae38ae9b3d67e3ec960d782befe9ee826bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
