cdk-from-cfn 0.181.0 → 0.183.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,21 +1,37 @@
1
1
  # cdk-from-cfn
2
2
 
3
- In a world where people want to use the full extent of the cdk, there **was** no product that would transform all your
4
- JSON/YAML into beautiful typescript...until now.
3
+ `cdk-from-cfn` is a command-line tool that converts AWS CloudFormation templates into AWS CDK code. It supports multiple programming languages including TypeScript, Python, Java, Go, and C#.
5
4
 
6
- `cdk-from-cfn` will take your JSON/YAML and output the equivalent typescript.
5
+ ## Installation
7
6
 
8
- ## User Guide
7
+ ```console
8
+ $ cargo install cdk-from-cfn
9
+ ```
10
+
11
+ ## Usage
9
12
 
10
13
  ```console
11
- $ cargo build --release
12
- $ ./target/release/cdk-from-cfn [INPUT] [OUTPUT]
14
+ $ cdk-from-cfn [INPUT] [OUTPUT] --language <LANGUAGE> --stack-name <STACK_NAME>
13
15
  ```
14
16
 
15
17
  - `INPUT` is the input file path (STDIN by default).
16
18
  - `OUTPUT` is the output file path; if not specified, output will be printed on your command line (STDOUT by default).
17
19
 
18
- ### Cargo Features
20
+ ## Node.js Module Usage
21
+
22
+ cdk-from-cfn leverages WebAssembly (WASM) bindings to provide a cross-platform [npm](https://www.npmjs.com/package/cdk-from-cfn) module, which exposes apis to be used in Node.js projects. Simply take a dependency on `cdk-from-cfn` in your package.json and utilize it as you would a normal module. i.e.
23
+
24
+ ```typescript
25
+ import * as cdk_from_cfn from 'cdk-from-cfn';
26
+
27
+ // get supported languages
28
+ cdk_from_cfn.supported_languages();
29
+
30
+ // transmute cfn template into cdk app
31
+ cdk_from_cfn.transmute(template, language, stackName)
32
+ ```
33
+
34
+ ## Language and Feature support
19
35
 
20
36
  Name | Enabled by default | Description
21
37
  -------------|:------------------:|---------------------------------------------
@@ -39,7 +55,7 @@ $ cargo build --release --no-default-features --features=golang
39
55
  Finished release [optimized] target(s) in 0.17s
40
56
  ```
41
57
 
42
- ## Implemented
58
+ ### Implemented
43
59
 
44
60
  - [x] Fn::FindInMap
45
61
  - [x] Fn::Join
@@ -63,7 +79,7 @@ Finished release [optimized] target(s) in 0.17s
63
79
  - [x] Deletion policy
64
80
  - [x] Fn::Cidr support
65
81
 
66
- ## Remaining
82
+ ### Remaining
67
83
 
68
84
  There are known unsupported features. Working on them in priority order:
69
85
 
package/index_bg.wasm CHANGED
Binary file
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "cdk-from-cfn",
3
3
  "description": "Turn AWS CloudFormation templates into AWS CDK applications",
4
- "version": "0.181.0",
4
+ "version": "0.183.0",
5
5
  "license": "MIT OR Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",