aws-cdk 2.1020.0 → 2.1020.2

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.
@@ -0,0 +1,942 @@
1
+ {
2
+ "globalOptions": {
3
+ "app": {
4
+ "type": "string",
5
+ "alias": "a",
6
+ "desc": "REQUIRED WHEN RUNNING APP: command-line for executing your app or a cloud assembly directory (e.g. \"node bin/my-app.js\"). Can also be specified in cdk.json or ~/.cdk.json",
7
+ "requiresArg": true
8
+ },
9
+ "build": {
10
+ "type": "string",
11
+ "desc": "Command-line for a pre-synth build"
12
+ },
13
+ "context": {
14
+ "type": "array",
15
+ "alias": "c",
16
+ "desc": "Add contextual string parameter (KEY=VALUE)"
17
+ },
18
+ "plugin": {
19
+ "type": "array",
20
+ "alias": "p",
21
+ "desc": "Name or path of a node package that extend the CDK features. Can be specified multiple times"
22
+ },
23
+ "trace": {
24
+ "type": "boolean",
25
+ "desc": "Print trace for stack warnings"
26
+ },
27
+ "strict": {
28
+ "type": "boolean",
29
+ "desc": "Do not construct stacks with warnings"
30
+ },
31
+ "lookups": {
32
+ "type": "boolean",
33
+ "desc": "Perform context lookups (synthesis fails if this is disabled and context lookups need to be performed)",
34
+ "default": true
35
+ },
36
+ "ignore-errors": {
37
+ "type": "boolean",
38
+ "default": false,
39
+ "desc": "Ignores synthesis errors, which will likely produce an invalid output"
40
+ },
41
+ "json": {
42
+ "type": "boolean",
43
+ "alias": "j",
44
+ "desc": "Use JSON output instead of YAML when templates are printed to STDOUT",
45
+ "default": false
46
+ },
47
+ "verbose": {
48
+ "type": "boolean",
49
+ "alias": "v",
50
+ "desc": "Show debug logs (specify multiple times to increase verbosity)",
51
+ "default": false,
52
+ "count": true
53
+ },
54
+ "debug": {
55
+ "type": "boolean",
56
+ "desc": "Debug the CDK app. Log additional information during synthesis, such as creation stack traces of tokens (sets CDK_DEBUG, will slow down synthesis)",
57
+ "default": false
58
+ },
59
+ "profile": {
60
+ "type": "string",
61
+ "desc": "Use the indicated AWS profile as the default environment",
62
+ "requiresArg": true
63
+ },
64
+ "proxy": {
65
+ "type": "string",
66
+ "desc": "Use the indicated proxy. Will read from HTTPS_PROXY environment variable if not specified",
67
+ "requiresArg": true
68
+ },
69
+ "ca-bundle-path": {
70
+ "type": "string",
71
+ "desc": "Path to CA certificate to use when validating HTTPS requests. Will read from AWS_CA_BUNDLE environment variable if not specified",
72
+ "requiresArg": true
73
+ },
74
+ "ec2creds": {
75
+ "type": "boolean",
76
+ "alias": "i",
77
+ "desc": "Force trying to fetch EC2 instance credentials. Default: guess EC2 instance status"
78
+ },
79
+ "version-reporting": {
80
+ "type": "boolean",
81
+ "desc": "Include the \"AWS::CDK::Metadata\" resource in synthesized templates (enabled by default)"
82
+ },
83
+ "path-metadata": {
84
+ "type": "boolean",
85
+ "desc": "Include \"aws:cdk:path\" CloudFormation metadata for each resource (enabled by default)"
86
+ },
87
+ "asset-metadata": {
88
+ "type": "boolean",
89
+ "desc": "Include \"aws:asset:*\" CloudFormation metadata for resources that uses assets (enabled by default)"
90
+ },
91
+ "role-arn": {
92
+ "type": "string",
93
+ "alias": "r",
94
+ "desc": "ARN of Role to use when invoking CloudFormation",
95
+ "requiresArg": true
96
+ },
97
+ "staging": {
98
+ "type": "boolean",
99
+ "desc": "Copy assets to the output directory (use --no-staging to disable the copy of assets which allows local debugging via the SAM CLI to reference the original source files)",
100
+ "default": true
101
+ },
102
+ "output": {
103
+ "type": "string",
104
+ "alias": "o",
105
+ "desc": "Emits the synthesized cloud assembly into a directory (default: cdk.out)",
106
+ "requiresArg": true
107
+ },
108
+ "notices": {
109
+ "type": "boolean",
110
+ "desc": "Show relevant notices"
111
+ },
112
+ "no-color": {
113
+ "type": "boolean",
114
+ "desc": "Removes colors and other style from console output",
115
+ "default": false
116
+ },
117
+ "ci": {
118
+ "type": "boolean",
119
+ "desc": "Force CI detection. If CI=true then logs will be sent to stdout instead of stderr"
120
+ },
121
+ "unstable": {
122
+ "type": "array",
123
+ "desc": "Opt in to unstable features. The flag indicates that the scope and API of a feature might still change. Otherwise the feature is generally production ready and fully supported. Can be specified multiple times.",
124
+ "default": []
125
+ }
126
+ },
127
+ "commands": {
128
+ "list": {
129
+ "arg": {
130
+ "name": "STACKS",
131
+ "variadic": true
132
+ },
133
+ "aliases": [
134
+ "ls"
135
+ ],
136
+ "description": "Lists all stacks in the app",
137
+ "options": {
138
+ "long": {
139
+ "type": "boolean",
140
+ "default": false,
141
+ "alias": "l",
142
+ "desc": "Display environment information for each stack"
143
+ },
144
+ "show-dependencies": {
145
+ "type": "boolean",
146
+ "default": false,
147
+ "alias": "d",
148
+ "desc": "Display stack dependency information for each stack"
149
+ }
150
+ }
151
+ },
152
+ "synth": {
153
+ "arg": {
154
+ "name": "STACKS",
155
+ "variadic": true
156
+ },
157
+ "aliases": [
158
+ "synthesize"
159
+ ],
160
+ "description": "Synthesizes and prints the CloudFormation template for this stack",
161
+ "options": {
162
+ "exclusively": {
163
+ "type": "boolean",
164
+ "alias": "e",
165
+ "desc": "Only synthesize requested stacks, don't include dependencies"
166
+ },
167
+ "validation": {
168
+ "type": "boolean",
169
+ "desc": "After synthesis, validate stacks with the \"validateOnSynth\" attribute set (can also be controlled with CDK_VALIDATION)",
170
+ "default": true
171
+ },
172
+ "quiet": {
173
+ "type": "boolean",
174
+ "alias": "q",
175
+ "desc": "Do not output CloudFormation Template to stdout",
176
+ "default": false
177
+ }
178
+ }
179
+ },
180
+ "bootstrap": {
181
+ "arg": {
182
+ "name": "ENVIRONMENTS",
183
+ "variadic": true
184
+ },
185
+ "description": "Deploys the CDK toolkit stack into an AWS environment",
186
+ "options": {
187
+ "bootstrap-bucket-name": {
188
+ "type": "string",
189
+ "alias": [
190
+ "b",
191
+ "toolkit-bucket-name"
192
+ ],
193
+ "desc": "The name of the CDK toolkit bucket; bucket will be created and must not exist"
194
+ },
195
+ "bootstrap-kms-key-id": {
196
+ "type": "string",
197
+ "desc": "AWS KMS master key ID used for the SSE-KMS encryption (specify AWS_MANAGED_KEY to use an AWS-managed key)",
198
+ "conflicts": "bootstrap-customer-key"
199
+ },
200
+ "example-permissions-boundary": {
201
+ "type": "boolean",
202
+ "alias": "epb",
203
+ "desc": "Use the example permissions boundary.",
204
+ "conflicts": "custom-permissions-boundary"
205
+ },
206
+ "custom-permissions-boundary": {
207
+ "type": "string",
208
+ "alias": "cpb",
209
+ "desc": "Use the permissions boundary specified by name.",
210
+ "conflicts": "example-permissions-boundary"
211
+ },
212
+ "bootstrap-customer-key": {
213
+ "type": "boolean",
214
+ "desc": "Create a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only)",
215
+ "conflicts": "bootstrap-kms-key-id"
216
+ },
217
+ "qualifier": {
218
+ "type": "string",
219
+ "desc": "String which must be unique for each bootstrap stack. You must configure it on your CDK app if you change this from the default."
220
+ },
221
+ "public-access-block-configuration": {
222
+ "type": "boolean",
223
+ "desc": "Block public access configuration on CDK toolkit bucket (enabled by default) "
224
+ },
225
+ "tags": {
226
+ "type": "array",
227
+ "alias": "t",
228
+ "desc": "Tags to add for the stack (KEY=VALUE)",
229
+ "default": []
230
+ },
231
+ "execute": {
232
+ "type": "boolean",
233
+ "desc": "Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet)",
234
+ "default": true
235
+ },
236
+ "trust": {
237
+ "type": "array",
238
+ "desc": "The AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only)",
239
+ "default": []
240
+ },
241
+ "trust-for-lookup": {
242
+ "type": "array",
243
+ "desc": "The AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only)",
244
+ "default": []
245
+ },
246
+ "untrust": {
247
+ "type": "array",
248
+ "desc": "The AWS account IDs that should not be trusted by this environment (may be repeated, modern bootstrapping only)",
249
+ "default": []
250
+ },
251
+ "cloudformation-execution-policies": {
252
+ "type": "array",
253
+ "desc": "The Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only)",
254
+ "default": []
255
+ },
256
+ "force": {
257
+ "alias": "f",
258
+ "type": "boolean",
259
+ "desc": "Always bootstrap even if it would downgrade template version",
260
+ "default": false
261
+ },
262
+ "termination-protection": {
263
+ "type": "boolean",
264
+ "desc": "Toggle CloudFormation termination protection on the bootstrap stacks"
265
+ },
266
+ "show-template": {
267
+ "type": "boolean",
268
+ "desc": "Instead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization",
269
+ "default": false
270
+ },
271
+ "toolkit-stack-name": {
272
+ "type": "string",
273
+ "desc": "The name of the CDK toolkit stack to create",
274
+ "requiresArg": true
275
+ },
276
+ "template": {
277
+ "type": "string",
278
+ "requiresArg": true,
279
+ "desc": "Use the template from the given file instead of the built-in one (use --show-template to obtain an example)"
280
+ },
281
+ "previous-parameters": {
282
+ "type": "boolean",
283
+ "default": true,
284
+ "desc": "Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled)"
285
+ }
286
+ }
287
+ },
288
+ "gc": {
289
+ "description": "Garbage collect assets. Options detailed here: https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-gc",
290
+ "arg": {
291
+ "name": "ENVIRONMENTS",
292
+ "variadic": true
293
+ },
294
+ "options": {
295
+ "action": {
296
+ "type": "string",
297
+ "desc": "The action (or sub-action) you want to perform. Valid entires are \"print\", \"tag\", \"delete-tagged\", \"full\".",
298
+ "default": "full"
299
+ },
300
+ "type": {
301
+ "type": "string",
302
+ "desc": "Specify either ecr, s3, or all",
303
+ "default": "all"
304
+ },
305
+ "rollback-buffer-days": {
306
+ "type": "number",
307
+ "desc": "Delete assets that have been marked as isolated for this many days",
308
+ "default": 0
309
+ },
310
+ "created-buffer-days": {
311
+ "type": "number",
312
+ "desc": "Never delete assets younger than this (in days)",
313
+ "default": 1
314
+ },
315
+ "confirm": {
316
+ "type": "boolean",
317
+ "desc": "Confirm via manual prompt before deletion",
318
+ "default": true
319
+ },
320
+ "bootstrap-stack-name": {
321
+ "type": "string",
322
+ "desc": "The name of the CDK toolkit stack, if different from the default \"CDKToolkit\"",
323
+ "requiresArg": true
324
+ }
325
+ }
326
+ },
327
+ "deploy": {
328
+ "description": "Deploys the stack(s) named STACKS into your AWS account",
329
+ "options": {
330
+ "all": {
331
+ "type": "boolean",
332
+ "desc": "Deploy all available stacks",
333
+ "default": false
334
+ },
335
+ "build-exclude": {
336
+ "type": "array",
337
+ "alias": "E",
338
+ "desc": "Do not rebuild asset with the given ID. Can be specified multiple times",
339
+ "default": []
340
+ },
341
+ "exclusively": {
342
+ "type": "boolean",
343
+ "alias": "e",
344
+ "desc": "Only deploy requested stacks, don't include dependencies"
345
+ },
346
+ "require-approval": {
347
+ "type": "string",
348
+ "choices": [
349
+ "never",
350
+ "any-change",
351
+ "broadening"
352
+ ],
353
+ "desc": "What security-sensitive changes need manual approval"
354
+ },
355
+ "notification-arns": {
356
+ "type": "array",
357
+ "desc": "ARNs of SNS topics that CloudFormation will notify with stack related events. These will be added to ARNs specified with the 'notificationArns' stack property."
358
+ },
359
+ "tags": {
360
+ "type": "array",
361
+ "alias": "t",
362
+ "desc": "Tags to add to the stack (KEY=VALUE), overrides tags from Cloud Assembly (deprecated)"
363
+ },
364
+ "execute": {
365
+ "type": "boolean",
366
+ "desc": "Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet) (deprecated)",
367
+ "deprecated": true
368
+ },
369
+ "change-set-name": {
370
+ "type": "string",
371
+ "desc": "Name of the CloudFormation change set to create (only if method is not direct)"
372
+ },
373
+ "method": {
374
+ "alias": "m",
375
+ "type": "string",
376
+ "choices": [
377
+ "direct",
378
+ "change-set",
379
+ "prepare-change-set"
380
+ ],
381
+ "requiresArg": true,
382
+ "desc": "How to perform the deployment. Direct is a bit faster but lacks progress information"
383
+ },
384
+ "import-existing-resources": {
385
+ "type": "boolean",
386
+ "desc": "Indicates if the stack set imports resources that already exist.",
387
+ "default": false
388
+ },
389
+ "force": {
390
+ "alias": "f",
391
+ "type": "boolean",
392
+ "desc": "Always deploy stack even if templates are identical",
393
+ "default": false
394
+ },
395
+ "parameters": {
396
+ "type": "array",
397
+ "desc": "Additional parameters passed to CloudFormation at deploy time (STACK:KEY=VALUE)",
398
+ "default": {}
399
+ },
400
+ "outputs-file": {
401
+ "type": "string",
402
+ "alias": "O",
403
+ "desc": "Path to file where stack outputs will be written as JSON",
404
+ "requiresArg": true
405
+ },
406
+ "previous-parameters": {
407
+ "type": "boolean",
408
+ "default": true,
409
+ "desc": "Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled)"
410
+ },
411
+ "toolkit-stack-name": {
412
+ "type": "string",
413
+ "desc": "The name of the existing CDK toolkit stack (only used for app using legacy synthesis)",
414
+ "requiresArg": true
415
+ },
416
+ "progress": {
417
+ "type": "string",
418
+ "choices": [
419
+ "bar",
420
+ "events"
421
+ ],
422
+ "desc": "Display mode for stack activity events"
423
+ },
424
+ "rollback": {
425
+ "type": "boolean",
426
+ "desc": "Rollback stack to stable state on failure. Defaults to 'true', iterate more rapidly with --no-rollback or -R. Note: do **not** disable this flag for deployments with resource replacements, as that will always fail",
427
+ "negativeAlias": "R"
428
+ },
429
+ "hotswap": {
430
+ "type": "boolean",
431
+ "desc": "Attempts to perform a 'hotswap' deployment, but does not fall back to a full deployment if that is not possible. Instead, changes to any non-hotswappable properties are ignored.Do not use this in production environments"
432
+ },
433
+ "hotswap-fallback": {
434
+ "type": "boolean",
435
+ "desc": "Attempts to perform a 'hotswap' deployment, which skips CloudFormation and updates the resources directly, and falls back to a full deployment if that is not possible. Do not use this in production environments"
436
+ },
437
+ "hotswap-ecs-minimum-healthy-percent": {
438
+ "type": "string",
439
+ "desc": "Lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount"
440
+ },
441
+ "hotswap-ecs-maximum-healthy-percent": {
442
+ "type": "string",
443
+ "desc": "Upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount"
444
+ },
445
+ "hotswap-ecs-stabilization-timeout-seconds": {
446
+ "type": "string",
447
+ "desc": "Number of seconds to wait for a single service to reach stable state, where the desiredCount is equal to the runningCount"
448
+ },
449
+ "watch": {
450
+ "type": "boolean",
451
+ "desc": "Continuously observe the project files, and deploy the given stack(s) automatically when changes are detected. Implies --hotswap by default"
452
+ },
453
+ "logs": {
454
+ "type": "boolean",
455
+ "default": true,
456
+ "desc": "Show CloudWatch log events from all resources in the selected Stacks in the terminal. 'true' by default, use --no-logs to turn off. Only in effect if specified alongside the '--watch' option"
457
+ },
458
+ "concurrency": {
459
+ "type": "number",
460
+ "desc": "Maximum number of simultaneous deployments (dependency permitting) to execute.",
461
+ "default": 1,
462
+ "requiresArg": true
463
+ },
464
+ "asset-parallelism": {
465
+ "type": "boolean",
466
+ "desc": "Whether to build/publish assets in parallel"
467
+ },
468
+ "asset-prebuild": {
469
+ "type": "boolean",
470
+ "desc": "Whether to build all assets before deploying the first stack (useful for failing Docker builds)",
471
+ "default": true
472
+ },
473
+ "ignore-no-stacks": {
474
+ "type": "boolean",
475
+ "desc": "Whether to deploy if the app contains no stacks",
476
+ "default": false
477
+ }
478
+ },
479
+ "arg": {
480
+ "name": "STACKS",
481
+ "variadic": true
482
+ }
483
+ },
484
+ "rollback": {
485
+ "description": "Rolls back the stack(s) named STACKS to their last stable state",
486
+ "arg": {
487
+ "name": "STACKS",
488
+ "variadic": true
489
+ },
490
+ "options": {
491
+ "all": {
492
+ "type": "boolean",
493
+ "default": false,
494
+ "desc": "Roll back all available stacks"
495
+ },
496
+ "toolkit-stack-name": {
497
+ "type": "string",
498
+ "desc": "The name of the CDK toolkit stack the environment is bootstrapped with",
499
+ "requiresArg": true
500
+ },
501
+ "force": {
502
+ "alias": "f",
503
+ "type": "boolean",
504
+ "desc": "Orphan all resources for which the rollback operation fails."
505
+ },
506
+ "validate-bootstrap-version": {
507
+ "type": "boolean",
508
+ "desc": "Whether to validate the bootstrap stack version. Defaults to 'true', disable with --no-validate-bootstrap-version."
509
+ },
510
+ "orphan": {
511
+ "type": "array",
512
+ "desc": "Orphan the given resources, identified by their logical ID (can be specified multiple times)",
513
+ "default": []
514
+ }
515
+ }
516
+ },
517
+ "import": {
518
+ "description": "Import existing resource(s) into the given STACK",
519
+ "arg": {
520
+ "name": "STACK",
521
+ "variadic": false
522
+ },
523
+ "options": {
524
+ "execute": {
525
+ "type": "boolean",
526
+ "desc": "Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet)",
527
+ "default": true
528
+ },
529
+ "change-set-name": {
530
+ "type": "string",
531
+ "desc": "Name of the CloudFormation change set to create"
532
+ },
533
+ "toolkit-stack-name": {
534
+ "type": "string",
535
+ "desc": "The name of the CDK toolkit stack to create",
536
+ "requiresArg": true
537
+ },
538
+ "rollback": {
539
+ "type": "boolean",
540
+ "desc": "Rollback stack to stable state on failure. Defaults to 'true', iterate more rapidly with --no-rollback or -R. Note: do **not** disable this flag for deployments with resource replacements, as that will always fail"
541
+ },
542
+ "force": {
543
+ "alias": "f",
544
+ "type": "boolean",
545
+ "desc": "Do not abort if the template diff includes updates or deletes. This is probably safe but we're not sure, let us know how it goes."
546
+ },
547
+ "record-resource-mapping": {
548
+ "type": "string",
549
+ "alias": "r",
550
+ "requiresArg": true,
551
+ "desc": "If specified, CDK will generate a mapping of existing physical resources to CDK resources to be imported as. The mapping will be written in the given file path. No actual import operation will be performed"
552
+ },
553
+ "resource-mapping": {
554
+ "type": "string",
555
+ "alias": "m",
556
+ "requiresArg": true,
557
+ "desc": "If specified, CDK will use the given file to map physical resources to CDK resources for import, instead of interactively asking the user. Can be run from scripts"
558
+ }
559
+ }
560
+ },
561
+ "watch": {
562
+ "description": "Shortcut for 'deploy --watch'",
563
+ "arg": {
564
+ "name": "STACKS",
565
+ "variadic": true
566
+ },
567
+ "options": {
568
+ "build-exclude": {
569
+ "type": "array",
570
+ "alias": "E",
571
+ "desc": "Do not rebuild asset with the given ID. Can be specified multiple times",
572
+ "default": []
573
+ },
574
+ "exclusively": {
575
+ "type": "boolean",
576
+ "alias": "e",
577
+ "desc": "Only deploy requested stacks, don't include dependencies"
578
+ },
579
+ "change-set-name": {
580
+ "type": "string",
581
+ "desc": "Name of the CloudFormation change set to create"
582
+ },
583
+ "force": {
584
+ "alias": "f",
585
+ "type": "boolean",
586
+ "desc": "Always deploy stack even if templates are identical",
587
+ "default": false
588
+ },
589
+ "toolkit-stack-name": {
590
+ "type": "string",
591
+ "desc": "The name of the existing CDK toolkit stack (only used for app using legacy synthesis)",
592
+ "requiresArg": true
593
+ },
594
+ "progress": {
595
+ "type": "string",
596
+ "choices": [
597
+ "bar",
598
+ "events"
599
+ ],
600
+ "desc": "Display mode for stack activity events"
601
+ },
602
+ "rollback": {
603
+ "type": "boolean",
604
+ "desc": "Rollback stack to stable state on failure. Defaults to 'true', iterate more rapidly with --no-rollback or -R. Note: do **not** disable this flag for deployments with resource replacements, as that will always fail",
605
+ "negativeAlias": "R"
606
+ },
607
+ "hotswap": {
608
+ "type": "boolean",
609
+ "desc": "Attempts to perform a 'hotswap' deployment, but does not fall back to a full deployment if that is not possible. Instead, changes to any non-hotswappable properties are ignored.'true' by default, use --no-hotswap to turn off"
610
+ },
611
+ "hotswap-fallback": {
612
+ "type": "boolean",
613
+ "desc": "Attempts to perform a 'hotswap' deployment, which skips CloudFormation and updates the resources directly, and falls back to a full deployment if that is not possible."
614
+ },
615
+ "hotswap-ecs-minimum-healthy-percent": {
616
+ "type": "string",
617
+ "desc": "Lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount"
618
+ },
619
+ "hotswap-ecs-maximum-healthy-percent": {
620
+ "type": "string",
621
+ "desc": "Upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount"
622
+ },
623
+ "hotswap-ecs-stabilization-timeout-seconds": {
624
+ "type": "string",
625
+ "desc": "Number of seconds to wait for a single service to reach stable state, where the desiredCount is equal to the runningCount"
626
+ },
627
+ "logs": {
628
+ "type": "boolean",
629
+ "default": true,
630
+ "desc": "Show CloudWatch log events from all resources in the selected Stacks in the terminal. 'true' by default, use --no-logs to turn off"
631
+ },
632
+ "concurrency": {
633
+ "type": "number",
634
+ "desc": "Maximum number of simultaneous deployments (dependency permitting) to execute.",
635
+ "default": 1,
636
+ "requiresArg": true
637
+ }
638
+ }
639
+ },
640
+ "destroy": {
641
+ "description": "Destroy the stack(s) named STACKS",
642
+ "arg": {
643
+ "name": "STACKS",
644
+ "variadic": true
645
+ },
646
+ "options": {
647
+ "all": {
648
+ "type": "boolean",
649
+ "default": false,
650
+ "desc": "Destroy all available stacks"
651
+ },
652
+ "exclusively": {
653
+ "type": "boolean",
654
+ "alias": "e",
655
+ "desc": "Only destroy requested stacks, don't include dependees"
656
+ },
657
+ "force": {
658
+ "type": "boolean",
659
+ "alias": "f",
660
+ "desc": "Do not ask for confirmation before destroying the stacks"
661
+ }
662
+ }
663
+ },
664
+ "diff": {
665
+ "description": "Compares the specified stack with the deployed stack or a local template file, and returns with status 1 if any difference is found",
666
+ "arg": {
667
+ "name": "STACKS",
668
+ "variadic": true
669
+ },
670
+ "options": {
671
+ "exclusively": {
672
+ "type": "boolean",
673
+ "alias": "e",
674
+ "desc": "Only diff requested stacks, don't include dependencies"
675
+ },
676
+ "context-lines": {
677
+ "type": "number",
678
+ "desc": "Number of context lines to include in arbitrary JSON diff rendering",
679
+ "default": 3,
680
+ "requiresArg": true
681
+ },
682
+ "template": {
683
+ "type": "string",
684
+ "desc": "The path to the CloudFormation template to compare with",
685
+ "requiresArg": true
686
+ },
687
+ "strict": {
688
+ "type": "boolean",
689
+ "desc": "Do not filter out AWS::CDK::Metadata resources, mangled non-ASCII characters, or the CheckBootstrapVersionRule",
690
+ "default": false
691
+ },
692
+ "security-only": {
693
+ "type": "boolean",
694
+ "desc": "Only diff for broadened security changes",
695
+ "default": false
696
+ },
697
+ "fail": {
698
+ "type": "boolean",
699
+ "desc": "Fail with exit code 1 in case of diff"
700
+ },
701
+ "processed": {
702
+ "type": "boolean",
703
+ "desc": "Whether to compare against the template with Transforms already processed",
704
+ "default": false
705
+ },
706
+ "quiet": {
707
+ "type": "boolean",
708
+ "alias": "q",
709
+ "desc": "Do not print stack name and default message when there is no diff to stdout",
710
+ "default": false
711
+ },
712
+ "change-set": {
713
+ "type": "boolean",
714
+ "alias": "changeset",
715
+ "desc": "Whether to create a changeset to analyze resource replacements. In this mode, diff will use the deploy role instead of the lookup role.",
716
+ "default": true
717
+ },
718
+ "import-existing-resources": {
719
+ "type": "boolean",
720
+ "desc": "Whether or not the change set imports resources that already exist",
721
+ "default": false
722
+ }
723
+ }
724
+ },
725
+ "drift": {
726
+ "description": "Detect drifts in the given CloudFormation stack(s)",
727
+ "arg": {
728
+ "name": "STACKS",
729
+ "variadic": true
730
+ },
731
+ "options": {
732
+ "fail": {
733
+ "type": "boolean",
734
+ "desc": "Fail with exit code 1 if drift is detected"
735
+ }
736
+ }
737
+ },
738
+ "metadata": {
739
+ "description": "Returns all metadata associated with this stack",
740
+ "arg": {
741
+ "name": "STACK",
742
+ "variadic": false
743
+ }
744
+ },
745
+ "acknowledge": {
746
+ "aliases": [
747
+ "ack"
748
+ ],
749
+ "description": "Acknowledge a notice so that it does not show up anymore",
750
+ "arg": {
751
+ "name": "ID",
752
+ "variadic": false
753
+ }
754
+ },
755
+ "notices": {
756
+ "description": "Returns a list of relevant notices",
757
+ "options": {
758
+ "unacknowledged": {
759
+ "type": "boolean",
760
+ "alias": "u",
761
+ "default": false,
762
+ "desc": "Returns a list of unacknowledged notices"
763
+ }
764
+ }
765
+ },
766
+ "init": {
767
+ "description": "Create a new, empty CDK project from a template.",
768
+ "arg": {
769
+ "name": "TEMPLATE",
770
+ "variadic": false
771
+ },
772
+ "options": {
773
+ "language": {
774
+ "type": "string",
775
+ "alias": "l",
776
+ "desc": "The language to be used for the new project (default can be configured in ~/.cdk.json)",
777
+ "choices": [
778
+ "csharp",
779
+ "fsharp",
780
+ "go",
781
+ "java",
782
+ "javascript",
783
+ "python",
784
+ "typescript"
785
+ ]
786
+ },
787
+ "list": {
788
+ "type": "boolean",
789
+ "desc": "List the available templates"
790
+ },
791
+ "generate-only": {
792
+ "type": "boolean",
793
+ "default": false,
794
+ "desc": "If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project"
795
+ },
796
+ "lib-version": {
797
+ "type": "string",
798
+ "alias": "V",
799
+ "desc": "The version of the CDK library (aws-cdk-lib) to initialize the project with. Defaults to the version that was current when this CLI was built."
800
+ }
801
+ }
802
+ },
803
+ "migrate": {
804
+ "description": "Migrate existing AWS resources into a CDK app",
805
+ "options": {
806
+ "stack-name": {
807
+ "type": "string",
808
+ "alias": "n",
809
+ "desc": "The name assigned to the stack created in the new project. The name of the app will be based off this name as well.",
810
+ "requiresArg": true
811
+ },
812
+ "language": {
813
+ "type": "string",
814
+ "default": "typescript",
815
+ "alias": "l",
816
+ "desc": "The language to be used for the new project",
817
+ "choices": [
818
+ "typescript",
819
+ "go",
820
+ "java",
821
+ "python",
822
+ "csharp"
823
+ ]
824
+ },
825
+ "account": {
826
+ "type": "string",
827
+ "desc": "The account to retrieve the CloudFormation stack template from"
828
+ },
829
+ "region": {
830
+ "type": "string",
831
+ "desc": "The region to retrieve the CloudFormation stack template from"
832
+ },
833
+ "from-path": {
834
+ "type": "string",
835
+ "desc": "The path to the CloudFormation template to migrate. Use this for locally stored templates"
836
+ },
837
+ "from-stack": {
838
+ "type": "boolean",
839
+ "desc": "Use this flag to retrieve the template for an existing CloudFormation stack"
840
+ },
841
+ "output-path": {
842
+ "type": "string",
843
+ "desc": "The output path for the migrated CDK app"
844
+ },
845
+ "from-scan": {
846
+ "type": "string",
847
+ "desc": "Determines if a new scan should be created, or the last successful existing scan should be used \n options are \"new\" or \"most-recent\""
848
+ },
849
+ "filter": {
850
+ "type": "array",
851
+ "desc": "Filters the resource scan based on the provided criteria in the following format: \"key1=value1,key2=value2\"\n This field can be passed multiple times for OR style filtering: \n filtering options: \n resource-identifier: A key-value pair that identifies the target resource. i.e. {\"ClusterName\", \"myCluster\"}\n resource-type-prefix: A string that represents a type-name prefix. i.e. \"AWS::DynamoDB::\"\n tag-key: a string that matches resources with at least one tag with the provided key. i.e. \"myTagKey\"\n tag-value: a string that matches resources with at least one tag with the provided value. i.e. \"myTagValue\""
852
+ },
853
+ "compress": {
854
+ "type": "boolean",
855
+ "desc": "Use this flag to zip the generated CDK app"
856
+ }
857
+ }
858
+ },
859
+ "context": {
860
+ "description": "Manage cached context values",
861
+ "options": {
862
+ "reset": {
863
+ "alias": "e",
864
+ "desc": "The context key (or its index) to reset",
865
+ "type": "string",
866
+ "requiresArg": true
867
+ },
868
+ "force": {
869
+ "alias": "f",
870
+ "desc": "Ignore missing key error",
871
+ "type": "boolean",
872
+ "default": false
873
+ },
874
+ "clear": {
875
+ "desc": "Clear all context",
876
+ "type": "boolean",
877
+ "default": false
878
+ }
879
+ }
880
+ },
881
+ "docs": {
882
+ "aliases": [
883
+ "doc"
884
+ ],
885
+ "description": "Opens the reference documentation in a browser",
886
+ "options": {
887
+ "browser": {
888
+ "alias": "b",
889
+ "desc": "the command to use to open the browser, using %u as a placeholder for the path of the file to open",
890
+ "type": "string"
891
+ }
892
+ }
893
+ },
894
+ "doctor": {
895
+ "description": "Check your set-up for potential problems"
896
+ },
897
+ "refactor": {
898
+ "description": "Moves resources between stacks or within the same stack",
899
+ "arg": {
900
+ "name": "STACKS",
901
+ "variadic": true
902
+ },
903
+ "options": {
904
+ "dry-run": {
905
+ "type": "boolean",
906
+ "desc": "Do not perform any changes, just show what would be done",
907
+ "default": false
908
+ },
909
+ "exclude-file": {
910
+ "type": "string",
911
+ "requiresArg": true,
912
+ "desc": "If specified, CDK will use the given file to exclude resources from the refactor"
913
+ },
914
+ "mapping-file": {
915
+ "type": "string",
916
+ "requiresArg": true,
917
+ "desc": "A file that declares an explicit mapping to be applied. If provided, the command will use it instead of computing the mapping."
918
+ },
919
+ "revert": {
920
+ "type": "boolean",
921
+ "default": false,
922
+ "desc": "If specified, the command will revert the refactor operation. This is only valid if a mapping file was provided."
923
+ }
924
+ }
925
+ },
926
+ "cli-telemetry": {
927
+ "description": "Enable or disable anonymous telemetry",
928
+ "options": {
929
+ "enable": {
930
+ "type": "boolean",
931
+ "desc": "Enable anonymous telemetry",
932
+ "conflicts": "disable"
933
+ },
934
+ "disable": {
935
+ "type": "boolean",
936
+ "desc": "Disable anonymous telemetry",
937
+ "conflicts": "enable"
938
+ }
939
+ }
940
+ }
941
+ }
942
+ }