Validate your Amazon SAM applications with Amazon CloudFormation Linter - Amazon Serverless Application Model
ExamplesLearn more
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Validate your Amazon SAM applications with Amazon CloudFormation Linter

Amazon CloudFormation Linter (cfn-lint) is an open-source tool that you can use to perform detailed validation on your Amazon CloudFormation templates. Cfn-lint contains rules that are guided by the Amazon 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 Amazon CloudFormation GitHub repository.

You can use cfn-lint to validate your Amazon Serverless Application Model (Amazon SAM) templates through the Amazon SAM Command Line Interface (Amazon 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 Amazon 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 Amazon SAM template

sam validate --lint --template myTemplate.yaml

Learn more

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