cfn-cli-typescriptv2-plugin 0.1.0

The CloudFormation Resource Provider Development Kit (RPDK) allows you to author your own resource providers that can be used by CloudFormation. This plugin library helps to provide runtime bindings for the execution of your providers by CloudFormation.

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.