The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.
Primary documentation for the CloudFormation CLI can be found at the AWS Documentation site.
This tool can be installed using pip from the Python Package Index (PyPI). It requires Python 3. The tool requires at least one language plugin. The language plugins are also available on PyPI and as such can be installed all at once:
pip install cloudformation-cli cloudformation-cli-java-plugin cloudformation-cli-go-plugin cloudformation-cli-python-pluginTo create a project in the current directory, use the init command. A wizard will guide you through the creation.
cfn initTo refresh auto-generated code, use the generate command. Usually, plugins try to integrate this command in the native build flow, so please consult a plugin's README to see if this is necessary.
cfn generateTo run the contract tests, use the test command.
cfn test
cfn test -- -k contract_delete_update #to run a single testFor developing, it's strongly suggested to install the development dependencies inside a virtual environment. (This isn't required if you just want to use this tool.)
python3 -m venv env
source env/bin/activate
pip install -e . -r requirements.txt
pre-commit installYou will also need to install a language plugin, such as the Java language plugin, also via pip install. For example, assuming the plugin is checked out in the same parent directory as this repository:
pip install -e ../cloudformation-cli-java-pluginLinting and running unit tests is done via pre-commit, and so is performed automatically on commit. The continuous integration also runs these checks. Manual options are available so you don't have to commit):
# run all hooks on all files, mirrors what the CI runs
pre-commit run --all-files
# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local
pre-commit run pytest-localIf you want to generate an HTML coverage report afterwards, run coverage html. The report is output to htmlcov/index.html.
New language plugins can be independently developed. As long as they declare the appropriate entry point and are installed in the same environment, they can even be completely separate codebases. For example, a plugin for Groovy might have the following entry point:
entry_points={
"rpdk.v1.languages": ["groovy = rpdk.groovy:GroovyLanguagePlugin"],
},Plugins must provide the same interface as LanguagePlugin (in plugin_base.py). And they may inherit from LanguagePlugin for the helper methods - but this is not necessary. As long as the class has the same methods, it will work as a plugin.
| Language | Status | Github | PyPI |
|---|---|---|---|
| Java | Available | cloudformation-cli-java-plugin | cloudformation-cli-java-plugin |
| Go | Available | cloudformation-cli-go-plugin | cloudformation-cli-go-plugin |
| Python | Available | cloudformation-cli-python-plugin | cloudformation-cli-python-plugin |
This library is licensed under the Apache 2.0 License.