Skip to content

Commit bdf1f66

Browse files
mrgrainmrgrain
authored
feat(cli): aws-cdk bundle is now targeting node18 (#610)
Editorial changes to the CLI readme to ensure this will end-up in the correct release notes. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
1 parent c64f63a commit bdf1f66

File tree

2 files changed

+44
-36
lines changed

2 files changed

+44
-36
lines changed

‎packages/@aws-cdk/node-bundle/src/api/bundle.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ export class Bundle {
443443
const bundle = esbuild.buildSync({
444444
entryPoints: this.entryPoints,
445445
bundle: true,
446-
target: 'node14',
446+
target: 'node18',
447447
platform: 'node',
448448
sourcemap: this.sourcemap,
449449
metafile: true, // this is always required for some of our validation rules

‎packages/aws-cdk/README.md

Lines changed: 43 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99

1010
<!--END STABILITY BANNER-->
1111

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.
1313

1414
| Command | Description |
15-
|---------------------------------------|-----------------------------------------------------------------------------------|
15+
| ------------------------------------- | --------------------------------------------------------------------------------- |
1616
| [`cdk docs`](#cdk-docs) | Access the online documentation |
1717
| [`cdk init`](#cdk-init) | Start a new CDK project (app or library) |
1818
| [`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) |
2020
| [`cdk diff`](#cdk-diff) | Diff stacks against current state |
2121
| [`cdk deploy`](#cdk-deploy) | Deploy a stack into an AWS account |
2222
| [`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
3232
| [`cdk refactor`](#cdk-refactor) | Moves resources between stacks or within the same stack |
3333
| [`cdk drift`](#cdk-drift) | Detect drifts in the given CloudFormation stack(s) |
3434

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)
3843
- [Configuration](#configuration)
3944
- [Running in CI](#running-in-ci)
4045

46+
## Requirements
4147

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.
5851

5952
## Commands
6053

@@ -124,7 +117,7 @@ $ cdk list --app='node bin/main.js' --long
124117
region: bermuda-triangle-3
125118
```
126119

127-
### `cdk synthesize`
120+
### `cdk synth`
128121

129122
Synthesizes the CDK app and produces a cloud assembly to a designated output (defaults to `cdk.out`)
130123

@@ -525,11 +518,11 @@ Hotswapping is currently supported for the following changes
525518

526519
You can optionally configure the behavior of your hotswap deployments. Currently you can only configure ECS hotswap behavior:
527520

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 |
533526

534527
##### cdk.json
535528

@@ -860,13 +853,13 @@ before deploying the generated application.
860853

861854
In practice this is how CDK Migrate generated applications will operate in the following scenarios:
862855

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 |
870863

871864
##### **The provided template is already deployed to CloudFormation in the account/region**
872865

@@ -1215,6 +1208,21 @@ $ # Detect drift against the currently-deployed stack with the verbose flag enab
12151208
$ cdk drift --verbose
12161209
```
12171210

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+
12181226
## Notices
12191227

12201228
CDK Notices are important messages regarding security vulnerabilities, regressions, and usage of unsupported

0 commit comments

Comments
 (0)