aws-cdk 2.1018.0 → 2.1019.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.
Files changed (15) hide show
  1. package/README.md +43 -35
  2. package/THIRD_PARTY_LICENSES +255 -50
  3. package/build-info.json +2 -2
  4. package/db.json.gz +0 -0
  5. package/lib/api/index.d.ts +1 -1
  6. package/lib/api/index.js +1 -1
  7. package/lib/api-private.d.ts +3 -1
  8. package/lib/api-private.js +2 -1
  9. package/lib/cli/cdk-toolkit.js +3 -4
  10. package/lib/cli/user-configuration.js +9 -2
  11. package/lib/index.js +35858 -29476
  12. package/lib/index_bg.wasm +0 -0
  13. package/lib/init-templates/.init-version.json +1 -1
  14. package/lib/init-templates/.recommended-feature-flags.json +2 -1
  15. package/package.json +14 -15
package/README.md CHANGED
@@ -9,14 +9,14 @@
9
9
 
10
10
  <!--END STABILITY BANNER-->
11
11
 
12
- The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications.
12
+ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
13
13
 
14
14
  | Command | Description |
15
- |---------------------------------------|-----------------------------------------------------------------------------------|
15
+ | ------------------------------------- | --------------------------------------------------------------------------------- |
16
16
  | [`cdk docs`](#cdk-docs) | Access the online documentation |
17
17
  | [`cdk init`](#cdk-init) | Start a new CDK project (app or library) |
18
18
  | [`cdk list`](#cdk-list) | List stacks and their dependencies in an application |
19
- | [`cdk synth`](#cdk-synthesize) | Synthesize a CDK app to CloudFormation template(s) |
19
+ | [`cdk synth`](#cdk-synth) | Synthesize a CDK app to CloudFormation template(s) |
20
20
  | [`cdk diff`](#cdk-diff) | Diff stacks against current state |
21
21
  | [`cdk deploy`](#cdk-deploy) | Deploy a stack into an AWS account |
22
22
  | [`cdk rollback`](#cdk-rollback) | Roll back a failed deployment |
@@ -32,29 +32,22 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t
32
32
  | [`cdk refactor`](#cdk-refactor) | Moves resources between stacks or within the same stack |
33
33
  | [`cdk drift`](#cdk-drift) | Detect drifts in the given CloudFormation stack(s) |
34
34
 
35
- - [Bundling](#bundling)
36
- - [MFA Support](#mfa-support)
37
- - [SSO Support](#sso-support)
35
+ ## Common topics
36
+
37
+ - Usage
38
+ - [Asset bundling](#bundling)
39
+ - [Preview features](#unstable)
40
+ - Authentication
41
+ - [MFA Support](#mfa-support)
42
+ - [SSO Support](#sso-support)
38
43
  - [Configuration](#configuration)
39
44
  - [Running in CI](#running-in-ci)
40
45
 
46
+ ## Requirements
41
47
 
42
- This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
43
-
44
- ## Global Options
45
-
46
- ### `unstable`
47
-
48
- The `--unstable` flag indicates that the scope and API of a feature might still change.
49
- Otherwise the feature is generally production ready and fully supported. For example,
50
- `cdk gc` is gated behind an `--unstable` flag:
51
-
52
- ```bash
53
- cdk gc --unstable=gc
54
- ```
55
-
56
- The command will fail if `--unstable=gc` is not passed in, which acknowledges that the user
57
- is aware of the caveats in place for the feature.
48
+ You need [Node.js](https://nodejs.org/en/download) or another JavaScript runtime to use the AWS CDK Toolkit CLI. We recommend using the [Node.js version in Active LTS](https://nodejs.org/en/about/previous-releases).
49
+ The minimal supported version is **Node.js v18**.
50
+ See our [Support Policy](https://docs.aws.amazon.com/cdk/v2/guide/node-versions.html) for full details.
58
51
 
59
52
  ## Commands
60
53
 
@@ -124,7 +117,7 @@ $ cdk list --app='node bin/main.js' --long
124
117
  region: bermuda-triangle-3
125
118
  ```
126
119
 
127
- ### `cdk synthesize`
120
+ ### `cdk synth`
128
121
 
129
122
  Synthesizes the CDK app and produces a cloud assembly to a designated output (defaults to `cdk.out`)
130
123
 
@@ -525,11 +518,11 @@ Hotswapping is currently supported for the following changes
525
518
 
526
519
  You can optionally configure the behavior of your hotswap deployments. Currently you can only configure ECS hotswap behavior:
527
520
 
528
- | Property | Description | Default |
529
- |--------------------------------|--------------------------------------|-------------|
530
- | minimumHealthyPercent | 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 | **REPLICA:** 100, **DAEMON:** 0 |
531
- | maximumHealthyPercent | 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 | **REPLICA:** 200, **DAEMON:**: N/A |
532
- | stabilizationTimeoutSeconds | Number of seconds to wait for a single service to reach stable state, where the desiredCount is equal to the runningCount | 600 |
521
+ | Property | Description | Default |
522
+ | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
523
+ | minimumHealthyPercent | 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 | **REPLICA:** 100, **DAEMON:** 0 |
524
+ | maximumHealthyPercent | 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 | **REPLICA:** 200, **DAEMON:**: N/A |
525
+ | stabilizationTimeoutSeconds | Number of seconds to wait for a single service to reach stable state, where the desiredCount is equal to the runningCount | 600 |
533
526
 
534
527
  ##### cdk.json
535
528
 
@@ -860,13 +853,13 @@ before deploying the generated application.
860
853
 
861
854
  In practice this is how CDK Migrate generated applications will operate in the following scenarios:
862
855
 
863
- | Situation | Result |
864
- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
865
- | Provided template + stack-name is from a deployed stack in the account/region | The CDK application will deploy as a changeset to the existing stack |
866
- | Provided template has no overlap with resources already in the account/region | The CDK application will deploy a new stack successfully |
867
- | Provided template has overlap with Cloudformation managed resources already in the account/region | The CDK application will not be deployable unless those resources are removed |
868
- | Provided template has overlap with un-managed resources already in the account/region | The CDK application will not be deployable until those resources are adopted with [`cdk import`](#cdk-import) |
869
- | No template has been provided and resources exist in the region the scan is done | The CDK application will be immediatly deployable and will import those resources into a new cloudformation stack upon deploy |
856
+ | Situation | Result |
857
+ | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
858
+ | Provided template + stack-name is from a deployed stack in the account/region | The CDK application will deploy as a changeset to the existing stack |
859
+ | Provided template has no overlap with resources already in the account/region | The CDK application will deploy a new stack successfully |
860
+ | Provided template has overlap with Cloudformation managed resources already in the account/region | The CDK application will not be deployable unless those resources are removed |
861
+ | Provided template has overlap with un-managed resources already in the account/region | The CDK application will not be deployable until those resources are adopted with [`cdk import`](#cdk-import) |
862
+ | No template has been provided and resources exist in the region the scan is done | The CDK application will be immediatly deployable and will import those resources into a new cloudformation stack upon deploy |
870
863
 
871
864
  ##### **The provided template is already deployed to CloudFormation in the account/region**
872
865
 
@@ -1215,6 +1208,21 @@ $ # Detect drift against the currently-deployed stack with the verbose flag enab
1215
1208
  $ cdk drift --verbose
1216
1209
  ```
1217
1210
 
1211
+ ## Global Options
1212
+
1213
+ ### `unstable`
1214
+
1215
+ The `--unstable` flag indicates that the scope and API of a feature might still change.
1216
+ Otherwise the feature is generally production ready and fully supported. For example,
1217
+ `cdk gc` is gated behind an `--unstable` flag:
1218
+
1219
+ ```bash
1220
+ cdk gc --unstable=gc
1221
+ ```
1222
+
1223
+ The command will fail if `--unstable=gc` is not passed in, which acknowledges that the user
1224
+ is aware of the caveats in place for the feature.
1225
+
1218
1226
  ## Notices
1219
1227
 
1220
1228
  CDK Notices are important messages regarding security vulnerabilities, regressions, and usage of unsupported