cfn_lint_serverless

Name	cfn_lint_serverless JSON
Version	0.3.4 JSON
	download
home_page	None
Summary	Serverless rules for cfn-lint
upload_time	2025-07-22 02:06:09
maintainer	None
docs_url	None
author	Amazon Web Service
requires_python	<4,>=3.9.1
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # cfn-lint-serverless

Ruleset for [cfn-lint](https://github.com/aws-cloudformation/cfn-lint) to validate CloudFormation templates for serverless applications against recommended best practices.

## Installation

```bash
pip install cfn-lint cfn-lint-serverless
```

## Usage

Run cfn-lint with the serverless rules module:

```bash
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](https://awslabs.github.io/serverless-rules/rules/).

## Examples

Try it with the examples provided in the repository:

```bash
# 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](../CONTRIBUTING.md) file for guidelines.

## License

This project is licensed under the MIT-0 License. See the [LICENSE](../LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cfn_lint_serverless",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.9.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Amazon Web Service",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/68/d3/2dc15045abb00c0815daace6e899c390a24a2122671596dcbea2c6034349/cfn_lint_serverless-0.3.4.tar.gz",
    "platform": null,
    "description": "# cfn-lint-serverless\n\nRuleset for [cfn-lint](https://github.com/aws-cloudformation/cfn-lint) to validate CloudFormation templates for serverless applications against recommended best practices.\n\n## Installation\n\n```bash\npip install cfn-lint cfn-lint-serverless\n```\n\n## Usage\n\nRun cfn-lint with the serverless rules module:\n\n```bash\ncfn-lint template.yaml -a cfn_lint_serverless.rules\n```\n\n## Supported Rules\n\nThis module provides validation rules for various AWS serverless resources:\n\n- Lambda Functions\n- API Gateway\n- Step Functions\n- SQS\n- SNS\n- EventBridge\n- AppSync\n\nFor a detailed list of rules, refer to the [documentation](https://awslabs.github.io/serverless-rules/rules/).\n\n## Examples\n\nTry it with the examples provided in the repository:\n\n```bash\n# For SAM templates\ncfn-lint examples/sam/template.yaml -a cfn_lint_serverless.rules\n\n# For Serverless Framework templates\ncfn-lint examples/serverless-framework/template.yaml -a cfn_lint_serverless.rules\n```\n\n## Contributing\n\nContributions are welcome! Please see the [CONTRIBUTING.md](../CONTRIBUTING.md) file for guidelines.\n\n## License\n\nThis project is licensed under the MIT-0 License. See the [LICENSE](../LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Serverless rules for cfn-lint",
    "version": "0.3.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3de2e3326578b03797219ca9fea1cb538656030766d041cbd3ad1584d74326c9",
                "md5": "44febc9e69d6a931e818454e813d60b5",
                "sha256": "560d25469bde56eaa6e38a74755e802d9b09bc1ea34d68cdd7f08baffed1c6cf"
            },
            "downloads": -1,
            "filename": "cfn_lint_serverless-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "44febc9e69d6a931e818454e813d60b5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.9.1",
            "size": 11664,
            "upload_time": "2025-07-22T02:06:08",
            "upload_time_iso_8601": "2025-07-22T02:06:08.388612Z",
            "url": "https://files.pythonhosted.org/packages/3d/e2/e3326578b03797219ca9fea1cb538656030766d041cbd3ad1584d74326c9/cfn_lint_serverless-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "68d32dc15045abb00c0815daace6e899c390a24a2122671596dcbea2c6034349",
                "md5": "f8d479aca57479ef184eb11352d7e212",
                "sha256": "46fdddcca2aaac9a302cd4ec3df45bdb65dc883c6e537880224ba2636b9bd491"
            },
            "downloads": -1,
            "filename": "cfn_lint_serverless-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f8d479aca57479ef184eb11352d7e212",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.9.1",
            "size": 75037,
            "upload_time": "2025-07-22T02:06:09",
            "upload_time_iso_8601": "2025-07-22T02:06:09.415368Z",
            "url": "https://files.pythonhosted.org/packages/68/d3/2dc15045abb00c0815daace6e899c390a24a2122671596dcbea2c6034349/cfn_lint_serverless-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-22 02:06:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cfn_lint_serverless"
}