Skip to main content

CloudFormation Typescript (v2) Plugin

This is a plugin for the CloudFormation CLI that enables the use of Typescript for resource providers, as well providing a number of other QoL improvments over the default TypeScript plugin. It can also be used for the development of JavaScript providers, though that has not be as tested.

Warning This plugin is still in beta, and is not yet ready for production use. It is not recommended to use this plugin for any production workloads.

Installation

To install the plugin, run the following command:

pip install cfn-cli-typescriptv2-plugin

The cfn cli will automatically detect the plugin and make it available as a language provider option.

Usage

Create and navigate to a new directory for your resource provider, and run the following command:

cfn init

This will walk you through the process of creating a new resource provider. When asked for the language, select Typescript (v2).

This plugin automatically generates bindings from your schema file via the npm run generate command, and makes then available via the .cfn folder as $cfn. You should not need to interact with this folder directly, and should only update the schema file.

See the generated README.md file for more information on how to use the generated bindings, and the general CloudFormation CLI Documentation for more information on how to use the CloudFormation CLI, test your resource provider, and publish it.

Metadata

Release files for cfn-cli-typescriptv2-plugin 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cfn-cli-typescriptv2-plugin 0.1.0
File Size Uploaded Provenance Actions
cfn-cli-typescriptv2-plugin-0.1.0.tar.gz 14.5 kB Without provenance Details for cfn-cli-typescriptv2-plugin-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cfn-cli-typescriptv2-plugin 0.1.0
File Interpreter ABI Platform Actions
cfn_cli_typescriptv2_plugin-0.1.0-py3-none-any.whl Python 3 none any Details for cfn_cli_typescriptv2_plugin-0.1.0-py3-none-any.whl

Total release size: 32.3 kB

Release files / cfn-cli-typescriptv2-plugin-0.1.0.tar.gz

Download URL cfn-cli-typescriptv2-plugin-0.1.0.tar.gz
Size 14.5 kB
Tags Source
SHA-256 checksum
How to use checksums
060110719a3dd979be941aa0072bbe3649ee465f64b2b51082eb8e5f294979da
BLAKE2b-256 checksum
How to use checksums
017d92faf8943447c2707bd0469eb371fef69638a2e8d1b922af3cf603ff6974
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release files / cfn_cli_typescriptv2_plugin-0.1.0-py3-none-any.whl

Download URL cfn_cli_typescriptv2_plugin-0.1.0-py3-none-any.whl
Size 17.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0a1ae5b146e092f50f9e5faa3cdfd4d688494be1949ea6f83325757f9e4cdf64
BLAKE2b-256 checksum
How to use checksums
e6ff074dae9e35c0f32a5bd523d8f83a2c74ea2d0b8fa1f0acdff432a94553b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Security for cfn-cli-typescriptv2-plugin 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page