Skip to main content

No project description provided

Project description

AWS CloudFormation Resource Provider Java Plugin

The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.

This plugin library helps to provide Java runtime bindings for the execution of your providers by CloudFormation.


If you are using this package to build resource providers for CloudFormation, install the CloudFormation CLI Java Plugin - this will automatically install the the CloudFormation CLI! A Python virtual environment is recommended.


  • Python version 3.6 or above
  • Your choice of Java IDE
  • Lombok: The code generated by the CloudFormation CLI uses Lombok, which requires support in IDEs for some syntax highlighting to work. For the best development experience, it is recommended you install Lombok support in your IDE.


pip3 install cloudformation-cli-java-plugin

Refer to the CloudFormation CLI User Guide for the CloudFormation CLI for usage instructions.

Alternate Type Formats

The format keyword can be specified on primitive types defined in a resource provider's schema to allow the CloudFormation CLI Java Plugin to generate more than the defaults for primitive types. Consult the table below for what formats are available and defaults for various types. The default value is used if omitted:

JSON Schema Type Format value Generated variable type
boolean default Boolean
integer default, int32 Integer
integer int64 Long
number default Double
string default String

For example, the below schema for a property would generate a variable of type Long.

    "type": "integer",
    "format": "int64"


For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:

python3 -m venv env
source env/bin/activate
pip3 install -e /path/to/cloudformation-cli-java-plugin

You may also want to check out the CloudFormation CLI if you wish to make edits to that. In this case, installing them in one operation works well:

pip3 install \
  -e /path/to/cloudformation-cli \
  -e /path/to/cloudformation-cli-java-plugin

That ensures neither is accidentally installed from PyPI.

Linting and running unit tests is done via pre-commit, and so is performed automatically on commit after being installed (pre-commit install). 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-local


This library is licensed under the Apache 2.0 License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudformation-cli-java-plugin-2.0.16.tar.gz (38.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page