Skip to main content

Serverless rules for cfn-lint

Project description

cfn-lint-serverless

Ruleset for cfn-lint to validate CloudFormation templates for serverless applications against recommended best practices.

Installation

pip install cfn-lint cfn-lint-serverless

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cfn_lint_serverless-0.3.5.tar.gz (71.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cfn_lint_serverless-0.3.5-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file cfn_lint_serverless-0.3.5.tar.gz.

File metadata

  • Download URL: cfn_lint_serverless-0.3.5.tar.gz
  • Upload date:
  • Size: 71.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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}

File hashes

Hashes for cfn_lint_serverless-0.3.5.tar.gz
Algorithm Hash digest
SHA256 7021432825694abe3f4fb217cbd447f6edfa7b696aced6bfb1008d9a21b72147
MD5 13bab5dce990682a5817033e8900fe83
BLAKE2b-256 630224d28cec6678727dd2cc91b7193e9152d904597bd3829b6e5caa62cf65c3

See more details on using hashes here.

File details

Details for the file cfn_lint_serverless-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: cfn_lint_serverless-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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}

File hashes

Hashes for cfn_lint_serverless-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cf07e6702c2d5c8ea6a448c5d87573310627f9baf6c4f98fefff14c6af158a26
MD5 abbc077723c7f787fa6ee7167b090256
BLAKE2b-256 799c45aa13ddf71c819501c27eb143ef8779da743d92d619fb1c88a1a13f13bc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page