## 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.
Usage
-----
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.
**Prerequisites**
- Python version 3.8 or above
- Your choice of Java IDE
- Lombok: The code generated by the CloudFormation CLI uses [Lombok](https://projectlombok.org/), 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.
**Installation**
```shell
pip3 install cloudformation-cli-java-plugin
```
Refer to the [CloudFormation CLI User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) for the [CloudFormation CLI](https://github.com/aws-cloudformation/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](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)|
| integer | `default`, `int32` | [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)|
| integer | `int64` | [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html)|
| number | `default` | [Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html)|
| string | `default` | [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)|
For example, the below schema for a property would generate a variable of type `Long`.
```
{
"type": "integer",
"format": "int64"
}
```
Development
-----------
For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:
```shell
python3 -m venv env
source env/bin/activate
pip3 install -e /path/to/cloudformation-cli-java-plugin
```
Install `pytest-cov`, used when running unit tests for this plugin:
```shell
pip3 install pytest-cov
```
You may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:
```shell
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](https://pre-commit.com/), 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:
```shell
# 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
```
License
-------
This library is licensed under the Apache 2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin/",
"name": "cloudformation-cli-java-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Amazon Web Services AWS CloudFormation",
"author": "Amazon Web Services",
"author_email": "aws-cloudformation-developers@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/1e/e6/6f7b3aea60930b03545dfc5030a8046d18f5f0f1bafcf3c32a7229d0981f/cloudformation-cli-java-plugin-2.1.1.tar.gz",
"platform": null,
"description": "## AWS CloudFormation Resource Provider Java Plugin\n\nThe CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.\n\nThis plugin library helps to provide Java runtime bindings for the execution of your providers by CloudFormation.\n\nUsage\n-----\n\nIf you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.\n\n**Prerequisites**\n\n - Python version 3.8 or above\n - Your choice of Java IDE\n - Lombok: The code generated by the CloudFormation CLI uses [Lombok](https://projectlombok.org/), 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.\n\n**Installation**\n\n```shell\npip3 install cloudformation-cli-java-plugin\n```\n\nRefer to the [CloudFormation CLI User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.\n\n### Alternate Type Formats\nThe `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:\n\n| JSON Schema Type | Format value | Generated variable type |\n| ---- | ----------- | ---------------------- |\n| boolean | `default` | [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)|\n| integer | `default`, `int32` | [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)|\n| integer | `int64` | [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html)|\n| number | `default` | [Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html)|\n| string | `default` | [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)|\n\nFor example, the below schema for a property would generate a variable of type `Long`.\n```\n{\n \"type\": \"integer\",\n \"format\": \"int64\"\n}\n```\n\n\nDevelopment\n-----------\n\nFor changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:\n\n```shell\npython3 -m venv env\nsource env/bin/activate\npip3 install -e /path/to/cloudformation-cli-java-plugin\n```\n\nInstall `pytest-cov`, used when running unit tests for this plugin:\n\n```shell\npip3 install pytest-cov\n```\n\nYou may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:\n\n```shell\npip3 install \\\n -e /path/to/cloudformation-cli \\\n -e /path/to/cloudformation-cli-java-plugin\n```\n\nThat ensures neither is accidentally installed from PyPI.\n\nLinting and running unit tests is done via [pre-commit](https://pre-commit.com/), 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:\n\n```shell\n# run all hooks on all files, mirrors what the CI runs\npre-commit run --all-files\n# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local\npre-commit run pytest-local\n```\n\nLicense\n-------\n\nThis library is licensed under the Apache 2.0 License.\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin/"
},
"split_keywords": [
"amazon",
"web",
"services",
"aws",
"cloudformation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "763f6602f7f52773d11b54cc951b21e9fa0e0d7db8052a41c38468ff733b1b08",
"md5": "86694fb0039d171b2215da52e66c040a",
"sha256": "79ce08feaa3c135222ead3a5fab7f98e932622361965c745e5e11e94f9765954"
},
"downloads": -1,
"filename": "cloudformation_cli_java_plugin-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86694fb0039d171b2215da52e66c040a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 67424,
"upload_time": "2024-02-06T20:15:43",
"upload_time_iso_8601": "2024-02-06T20:15:43.614740Z",
"url": "https://files.pythonhosted.org/packages/76/3f/6602f7f52773d11b54cc951b21e9fa0e0d7db8052a41c38468ff733b1b08/cloudformation_cli_java_plugin-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ee66f7b3aea60930b03545dfc5030a8046d18f5f0f1bafcf3c32a7229d0981f",
"md5": "7b5f78dc9eb9b8f16902cc9e5877dbb6",
"sha256": "e783370ab32dddcd6257df959c440253a9084208e3ef915ae8edb95fa7875910"
},
"downloads": -1,
"filename": "cloudformation-cli-java-plugin-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7b5f78dc9eb9b8f16902cc9e5877dbb6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39635,
"upload_time": "2024-02-06T20:15:45",
"upload_time_iso_8601": "2024-02-06T20:15:45.756112Z",
"url": "https://files.pythonhosted.org/packages/1e/e6/6f7b3aea60930b03545dfc5030a8046d18f5f0f1bafcf3c32a7229d0981f/cloudformation-cli-java-plugin-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 20:15:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-cloudformation",
"github_project": "aws-cloudformation-rpdk-java-plugin",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "cloudformation-cli-java-plugin"
}
JSON
