cdk-import 0.2.164 → 0.2.167
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 +19 -6
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
# cdk-import
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Generates CDK constructs from external sources such as public CloudFormation Registry types and
|
|
4
|
+
modules (L1s) as well as AWS Service Catalog product versions.
|
|
5
|
+
|
|
6
|
+
> **IMPORTANT** The AWS CDK CLI has feature called [`cdk import`](https://github.com/aws/aws-cdk/blob/master/packages/aws-cdk/README.md#cdk-import), which can be used to import ("adopt")
|
|
7
|
+
> existing resources into CloudFormation control, so that they can be mutated by CDK updates later.
|
|
8
|
+
> *The naming collission is unfortunate, but this repository has nothing to do with that feature*. For more information on the feature to import existing AWS resources into CDK/CloudFormation stacks, see the [CLI documentation on `cdk import`](https://github.com/aws/aws-cdk/blob/master/packages/aws-cdk/README.md#cdk-import).
|
|
5
9
|
|
|
6
10
|
## Installation
|
|
7
11
|
|
|
@@ -15,6 +19,7 @@ There are currently two sources that resources can be generated from. The subcom
|
|
|
15
19
|
`cfn` is used to import from CloudFormation Registry,
|
|
16
20
|
`sc` is used to import AWS Service Catalog products.
|
|
17
21
|
There are shared general options for output directories and target language.
|
|
22
|
+
You will need `AWS_REGION` variable configured in your environment.
|
|
18
23
|
|
|
19
24
|
```shell
|
|
20
25
|
Usage:
|
|
@@ -165,9 +170,9 @@ cdk-import cfn AWSQS::CheckPoint::CloudGuardQS::MODULE
|
|
|
165
170
|
|
|
166
171
|
## AWS Service Catalog Usage
|
|
167
172
|
|
|
168
|
-
The cdk-import tool generates a user friendly version of a provisioned product
|
|
169
|
-
|
|
170
|
-
You can currently either specify a specific product version or generate all available products
|
|
173
|
+
The cdk-import tool generates a user friendly version of a provisioned product that becomes
|
|
174
|
+
a normal cdk construct that you can use within a cdk app.
|
|
175
|
+
You can currently either specify a specific product version or generate all available products.
|
|
171
176
|
The tool will call APIs and attempt to resolve default artifact and launch path for a product,
|
|
172
177
|
if a singular product version or launch path cannot be resolved, it will throw an error.
|
|
173
178
|
You will need Service Catalog end-user read permissions to call these APIs.
|
|
@@ -198,6 +203,14 @@ If you are using `csharp`, you must specify a `--csharp-namespace` within your p
|
|
|
198
203
|
Output will be generated relative to `--outdir` which defaults to the current
|
|
199
204
|
working directory under `./sc-products`.
|
|
200
205
|
|
|
206
|
+
## Examples
|
|
207
|
+
|
|
208
|
+
Generates constructs in python for the latest product versions as importable modules in your local workspace.
|
|
209
|
+
|
|
210
|
+
```shell
|
|
211
|
+
cdk-import sc -l python -o .
|
|
212
|
+
```
|
|
213
|
+
|
|
201
214
|
|
|
202
215
|
## Contributing
|
|
203
216
|
|
|
@@ -210,4 +223,4 @@ information.
|
|
|
210
223
|
|
|
211
224
|
## License
|
|
212
225
|
|
|
213
|
-
This project is licensed under the Apache-2.0 License.
|
|
226
|
+
This project is licensed under the Apache-2.0 License.
|
package/package.json
CHANGED
|
@@ -40,17 +40,19 @@
|
|
|
40
40
|
"jest-junit": "^13",
|
|
41
41
|
"json-schema": "^0.4.0",
|
|
42
42
|
"npm-check-updates": "^12",
|
|
43
|
-
"projen": "^0.55.
|
|
43
|
+
"projen": "^0.55.8",
|
|
44
44
|
"standard-version": "^9",
|
|
45
45
|
"ts-jest": "^27",
|
|
46
46
|
"ts-node": "^10.7.0",
|
|
47
47
|
"typescript": "^4.6.4"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"aws-
|
|
50
|
+
"aws-cdk-lib": "^2.23.0",
|
|
51
|
+
"aws-sdk": "^2.1129.0",
|
|
51
52
|
"case": "^1.6.3",
|
|
52
|
-
"
|
|
53
|
-
"
|
|
53
|
+
"constructs": "^10",
|
|
54
|
+
"jsii-srcmak": "^0.1.550",
|
|
55
|
+
"json2jsii": "^0.3.3",
|
|
54
56
|
"minimist": "^1.2.6",
|
|
55
57
|
"minimist-subcommand": "^3.0.2",
|
|
56
58
|
"proxy-agent": "^5.0.0"
|
|
@@ -60,7 +62,7 @@
|
|
|
60
62
|
},
|
|
61
63
|
"main": "lib/index.js",
|
|
62
64
|
"license": "Apache-2.0",
|
|
63
|
-
"version": "0.2.
|
|
65
|
+
"version": "0.2.167",
|
|
64
66
|
"jest": {
|
|
65
67
|
"testMatch": [
|
|
66
68
|
"<rootDir>/src/**/__tests__/**/*.ts?(x)",
|