Validate your AWS SAM applications with AWS CloudFormation Linter - AWS Serverless Application Model

Validate your AWS SAM applications with AWS CloudFormation Linter

AWS CloudFormation Linter (cfn-lint) is an open-source tool that you can use to perform detailed validation on your AWS CloudFormation templates. Cfn-lint contains rules that are guided by the AWS CloudFormation resource specification. Use cfn-lint to compare your resources against those rules to receive detailed messages on errors, warnings, or informational suggestions. Alternatively, create your own custom rules to validate against. To learn more about cfn-lint, see cfn-lint in the AWS CloudFormation GitHub repository.

You can use cfn-lint to validate your AWS Serverless Application Model (AWS SAM) templates through the AWS SAM Command Line Interface (AWS SAM CLI) by running sam validate with the --lint option.

sam validate --lint

To customize cfn-lint behavior, such as creating custom rules or specifying validation options, you can define a configuration file. To learn more, see Config File in the cfn-lint AWS CloudFormation GitHub repository. When you run sam validate --lint, cfn-lint behavior defined in your configuration file will be applied.

Examples

Perform cfn-lint validation on an AWS SAM template

sam validate --lint --template myTemplate.yaml

Learn more

To learn more about the sam validate command, see sam validate.