lucaster / cloudformation-template-schema Goto Github PK

The CloudFormation template schema is intended to improve the authoring experience for our customers. It is a simple code process which converts our existing Resource Specifications files into a JSON Schema formatted document. This schema can be integrated into many publicly available IDEs such as Visual Studio Code & PyCharm to provide inline syntax checking and code completion.

1. Complete type-safe template authoring with IntelliSense-based completion
2. Support for both YAML and JSON templates
3. Errors flagged for missing required properties
4. Integrated deep links to CloudFormation documentation for the resource or template section you are editing

Here is a VSCode setup integration example

For VS Code please follow the setup/guidelines or install the pre-configured CloudFormation Linter VS Code extension

For PyCharm please follow the setup/guidelines

See instructions which describes how to run the tool locally, to generate specifications for only subset of resources or AWS regions.

This library is licensed under the Apache 2.0 License.