@wolsok/nx-aws-cdk-v2 2.6.0 → 2.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Wolfram Sokollek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,97 +1,249 @@
-[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-[![@wolsok/nx-aws-cdk-v2](https://img.shields.io/badge/%40adrian--goe-nx--aws--cdk-green)](https://github.com/WolfSoko/nx-aws-cdk-v2/tree/main/packages/aws-cdk-v2)
-[![Typescript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://www.typescriptlang.org/)
-[![LICENSE](https://img.shields.io/npm/l/@wolsok/nx-aws-cdk-v2.svg)](https://www.npmjs.com/package/@wolsok/nx-aws-cdk-v2)
 [![npm version](https://img.shields.io/npm/v/@wolsok/nx-aws-cdk-v2.svg)](https://www.npmjs.com/package/@wolsok/nx-aws-cdk-v2)
 [![Downloads](https://img.shields.io/npm/dm/@wolsok/nx-aws-cdk-v2.svg)](https://www.npmjs.com/package/@wolsok/nx-aws-cdk-v2)
-
-<hr>
+[![LICENSE](https://img.shields.io/npm/l/@wolsok/nx-aws-cdk-v2.svg)](https://www.npmjs.com/package/@wolsok/nx-aws-cdk-v2)
+[![Typescript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://www.typescriptlang.org/)
 
 # @wolsok/nx-aws-cdk-v2
 
-An Nx plugin for developing [aws-cdk](https://docs.aws.amazon.com/cdk/latest/guide/home.html)
+Generate, synthesize, deploy and destroy [AWS CDK v2](https://docs.aws.amazon.com/cdk/v2/guide/home.html)
+applications from inside an [Nx](https://nx.dev) workspace.
+
+The plugin adds one generator and four executors. The executors are thin, predictable wrappers
+around the CDK Toolkit CLI: they build a `cdk` command line and run it, so anything you know about
+`cdk` keeps working, and anything Nx gives you — the project graph, `nx affected`, task caching,
+`nx release` — applies to your infrastructure code as well.
 
-## Table of Contents
+## Table of contents
 
+- [Requirements](#requirements)
 - [Install](#install)
-- [Usage](#usage)
-  - [Generate Application](#generate-application)
-  - [Targets](#targets)
-- [Maintainers](#maintainers)
+- [Quick start](#quick-start)
+- [Generator: `application`](#generator-application)
+- [Executors](#executors)
+  - [`deploy`](#deploy)
+  - [`synth`](#synth)
+  - [`destroy`](#destroy)
+  - [`bootstrap`](#bootstrap)
+  - [Passing extra CDK flags](#passing-extra-cdk-flags)
+- [How the executors invoke the CDK CLI](#how-the-executors-invoke-the-cdk-cli)
+- [Documentation](#documentation)
 - [Contributing](#contributing)
 - [License](#license)
 
+## Requirements
+
+| Requirement     | Version                                                                           |
+| --------------- | --------------------------------------------------------------------------------- |
+| Node.js         | `>= 20.19`                                                                        |
+| Nx              | `>= 21` (built and tested against Nx 23)                                          |
+| AWS CDK         | v2 — installed into your workspace by the generator                               |
+| AWS credentials | Any method the AWS SDK understands (`aws configure`, `AWS_PROFILE`, SSO, OIDC, …) |
+
+`@nx/devkit` is a peer dependency. `@nx/jest` is an optional peer dependency and is only needed if
+you generate applications with the default `--unitTestRunner=jest`.
+
 ## Install
 
 ```shell
-# npm
 npm install --save-dev @wolsok/nx-aws-cdk-v2
-
-# yarn
+# or
+pnpm add --save-dev @wolsok/nx-aws-cdk-v2
+# or
 yarn add --dev @wolsok/nx-aws-cdk-v2
 ```
 
-## Usage
+## Quick start
+
+```shell
+# 1. Scaffold a CDK app (adds aws-cdk-lib, constructs and the CDK Toolkit to your workspace)
+nx generate @wolsok/nx-aws-cdk-v2:application my-app
+
+# 2. Prepare the target AWS environment - once per account/region
+nx bootstrap my-app --profile=my-profile
+
+# 3. Check what CloudFormation the app produces
+nx synth my-app
+
+# 4. Ship it
+nx deploy my-app
+
+# 5. Tear it down again
+nx destroy my-app
+```
+
+## Generator: `application`
+
+```shell
+nx generate @wolsok/nx-aws-cdk-v2:application <name> [options]
+# alias: nx g @wolsok/nx-aws-cdk-v2:app <name>
+```
+
+| Option                      | Type             | Default | Description                                                                                 |
+| --------------------------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- |
+| `--name`                    | `string`         | —       | Name of the application. Can also be passed as the first positional argument. **Required.** |
+| `--directory`, `-d`         | `string`         | —       | Directory the project is placed in, relative to the workspace's apps directory.             |
+| `--tags`, `-t`              | `string`         | —       | Comma separated tags, used by lint rules and `nx affected` filtering.                       |
+| `--unitTestRunner`          | `jest` \| `none` | `jest`  | Adds a Jest configuration and a sample stack test.                                          |
+| `--skipFormat`              | `boolean`        | `false` | Skip formatting the generated files with Prettier.                                          |
+| `--setParserOptionsProject` | `boolean`        | `false` | Configure ESLint's `parserOptions.project`. Off by default for lint performance.            |
+
+### Where the project is created
+
+The project root is `<appsDir>/<directory>/<name>`, where `<appsDir>` is
+`workspaceLayout.appsDir` from `nx.json` if set, otherwise `apps/` or `packages/` if either exists,
+otherwise the workspace root. The Nx project name is the path below `<appsDir>` with `/` replaced by
+`-`, so `--directory=aws my-app` becomes the project `aws-my-app`.
+
+### What gets generated
+
+```text
+<project-root>/
+├── cdk.json                     # used when you run the cdk CLI yourself from this directory
+├── jest.config.cts              # only with --unitTestRunner=jest
+├── project.json                 # deploy / synth / destroy / bootstrap targets
+├── src/
+│   ├── main.ts                  # CDK app entry point - the executors point cdk at this file
+│   ├── main.test.ts             # only with --unitTestRunner=jest
+│   └── stacks/
+│       └── app-stack.ts         # your stack - start adding constructs here
+├── tsconfig.app.json
+├── tsconfig.json
+└── tsconfig.spec.json           # only with --unitTestRunner=jest
+```
+
+The generator also adds `aws-cdk-lib` and `constructs` to `dependencies`, and the `aws-cdk` CLI plus
+the TypeScript loaders (`ts-node`, `tsconfig-paths`, `tsx`) to `devDependencies` of your workspace.
+
+> The CDK Toolkit CLI (`aws-cdk`) and the construct library (`aws-cdk-lib`) are released on separate
+> version lines — `2.1xxx.x` for the CLI, `2.x` for the library. They are pinned independently.
+
+## Executors
+
+Every generated project gets four targets. Run them with `nx <target> <project>` or
+`nx run <project>:<target>`.
+
+Options shared by all four executors:
+
+| Option            | Type                   | Description                                                             |
+| ----------------- | ---------------------- | ----------------------------------------------------------------------- |
+| `--profile`       | `string`               | AWS profile from `~/.aws/credentials` or `~/.aws/config`.               |
+| `--context`, `-c` | `string` \| `string[]` | CDK context values as `KEY=VALUE`. Repeat the flag for multiple values. |
+
+### `deploy`
+
+Deploys the project's stacks to AWS.
+
+| Option     | Type     | Description                                                                                  |
+| ---------- | -------- | -------------------------------------------------------------------------------------------- |
+| `--stacks` | `string` | Stack names or glob patterns to deploy, space separated. Defaults to every stack in the app. |
+
+```shell
+nx deploy my-app
+nx deploy my-app --stacks=MyStack
+nx deploy my-app --profile=production --context=env=prod
+```
+
+### `synth`
+
+Synthesizes the app into CloudFormation templates without touching AWS. Useful in CI as a fast
+"does this still compile into valid infrastructure" check.
+
+| Option     | Type     | Description                                               |
+| ---------- | -------- | --------------------------------------------------------- |
+| `--stacks` | `string` | Stacks to synthesize. Defaults to every stack in the app. |
+
+```shell
+nx synth my-app
+```
+
+### `destroy`
+
+Removes the project's deployed stacks.
 
-### Generate Application
+| Option     | Type     | Description                                            |
+| ---------- | -------- | ------------------------------------------------------ |
+| `--stacks` | `string` | Stacks to destroy. Defaults to every stack in the app. |
+
+```shell
+nx destroy my-app
+nx destroy my-app --stacks=MyStack --profile=staging
+```
 
-Create AWS CDK v2 Application
+### `bootstrap`
 
-More details on AWS CDK v2 can be found on https://docs.aws.amazon.com/cdk/v2/guide/home.html
+Prepares an AWS environment (account + region pair) so CDK stacks can be deployed into it. Needed
+once per environment — see the
+[CDK bootstrapping guide](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html).
 
 ```shell
-nx generate @wolsok/nx-aws-cdk-v2:application myApp
+nx bootstrap my-app --profile=my-profile
+nx bootstrap my-app aws://123456789012/us-east-1
 ```
 
-you can customize it further by passing these options:
+### Passing extra CDK flags
 
+Any option that is not part of an executor's schema is forwarded to the CDK CLI as
+`--<option> <value>`, so the whole `cdk` surface stays reachable:
+
+```shell
+nx deploy my-app --hotswap=true          # -> cdk deploy --hotswap true
+nx deploy my-app --requireApproval=never # -> cdk deploy --requireApproval never
+nx synth my-app --quiet=true             # -> cdk synth --quiet true
 ```
-nx generate @wolsok/nx-aws-cdk-v2:application [name] [options,...]
-
-Options:
-  --name
-  --tags                     Add tags to the project (used for linting)
-  --directory                A directory where the project is placed
-  --skipFormat               Skip formatting files
-  --unitTestRunner           Adds the specified unit test runner (default: jest)
-  --setParserOptionsProject  Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
-  --dryRun                   Runs through and reports activity without writing to disk.
-  --skip-nx-cache            Skip the use of Nx cache.
-  --help                     Show available options for project target.
+
+You can also set them permanently in the project's `project.json`:
+
+```json
+{
+  "targets": {
+    "deploy": {
+      "executor": "@wolsok/nx-aws-cdk-v2:deploy",
+      "options": {
+        "profile": "production",
+        "requireApproval": "never"
+      }
+    }
+  }
+}
 ```
 
-### Targets
+## How the executors invoke the CDK CLI
 
-Generated applications expose several functions to the CLI that allow users to synthesize, deploy, destroy and bootstrap.
+All four executors build the same shape of command and run it **from the workspace root**:
 
 ```shell
-nx synth myApp
-nx deploy myApp
-nx destroy myApp
-nx bootstrap myApp --profile=profile
-#see how to use aws environments https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-howto-cli
-nx bootstrap myApp aws://123456789012/us-east-1
+<pm-exec> cdk -a "<pm-exec> <loader> <workspace-root>/<project-root>/src/main.ts" <command> [stacks] [--flags]
 ```
 
-## Maintainers
+- `<pm-exec>` is `npx` for npm workspaces, otherwise your package manager (`pnpm`, `yarn`, `bun`),
+  detected by Nx.
+- `<loader>` is `tsx` when the nearest `package.json` has `"type": "module"`, otherwise
+  `ts-node --require tsconfig-paths/register --project <project-root>/tsconfig.app.json`.
+- Because `cdk` runs with the workspace root as its working directory, `cdk.out` is written to the
+  **workspace root**, and the generated `cdk.json` is _not_ read. That file exists for the times you
+  invoke `cdk` yourself from the project directory.
 
-[@WolfSoko](https://github.com/WolfSoko)
+Run any target with `--verbose` to see the exact command that is executed.
 
-## Contributing
+## Documentation
 
-See [the contributing file](../../CONTRIBUTING.md)!
+- [Getting started](https://github.com/WolfSoko/nx-aws-cdk-v2/blob/main/docs/getting-started.md)
+- [API reference](https://github.com/WolfSoko/nx-aws-cdk-v2/blob/main/docs/api-documentation.md)
+- [Architecture](https://github.com/WolfSoko/nx-aws-cdk-v2/blob/main/docs/architecture.md)
+- [Troubleshooting](https://github.com/WolfSoko/nx-aws-cdk-v2/blob/main/docs/troubleshooting.md)
 
-PRs accepted.
+## Contributing
 
-If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+Issues and pull requests are welcome — see
+[CONTRIBUTING.md](https://github.com/WolfSoko/nx-aws-cdk-v2/blob/main/CONTRIBUTING.md).
 
 ## License
 
-This project is MIT licensed 2022 Wolfram Sokollek
+MIT © Wolfram Sokollek
 
 ## Special thanks
 
-This Project is based on [@tienne](https://github.com/tienne)'s
-[nx-plugins](https://github.com/codebrewlab/nx-plugins).
-
-Also thanks to [@therk](https://github.com/therk) for his work on migrating to cdk v2.
+This project is based on [@tienne](https://github.com/tienne)'s
+[nx-plugins](https://github.com/codebrewlab/nx-plugins), and on
+[@adrian-goe](https://github.com/adrian-goe)'s [nx-aws-cdk-v2](https://github.com/adrian-goe/nx-aws-cdk-v2).
+Thanks to [@therk](https://github.com/therk) for the work on migrating to CDK v2.

package/executors.json

@@ -4,22 +4,22 @@
     "deploy": {
       "implementation": "./src/executors/deploy/deploy",
       "schema": "./src/executors/deploy/schema.json",
-      "description": "build executor"
+      "description": "Deploy the CDK stacks of a project to AWS."
     },
     "destroy": {
       "implementation": "./src/executors/destroy/destroy",
       "schema": "./src/executors/destroy/schema.json",
-      "description": "destroy executor"
+      "description": "Destroy the deployed CDK stacks of a project."
     },
     "synth": {
       "implementation": "./src/executors/synth/synth",
       "schema": "./src/executors/synth/schema.json",
-      "description": "synth executor"
+      "description": "Synthesize the CDK app of a project into a CloudFormation template."
     },
     "bootstrap": {
       "implementation": "./src/executors/bootstrap/bootstrap",
       "schema": "./src/executors/bootstrap/schema.json",
-      "description": "bootstrap executor"
+      "description": "Bootstrap an AWS environment for CDK deployments."
     }
   }
 }

package/generators.json

@@ -6,14 +6,15 @@
     "init": {
       "factory": "./src/generators/init/init",
       "schema": "./src/generators/init/schema.json",
-      "description": "init generator",
+      "description": "Add the AWS CDK dependencies to the workspace. Runs automatically as part of the application generator.",
       "aliases": ["ng-add"],
       "hidden": true
     },
     "application": {
       "factory": "./src/generators/application/application",
       "schema": "./src/generators/application/schema.json",
-      "description": "create aws-cdk application"
+      "aliases": ["app"],
+      "description": "Create an AWS CDK v2 application with deploy, destroy, synth and bootstrap targets."
     }
   }
 }

package/migrations.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "generators": {},
+  "packageJsonUpdates": {}
+}

package/package.json

@@ -1,26 +1,49 @@
 {
   "name": "@wolsok/nx-aws-cdk-v2",
-  "version": "2.6.0",
+  "version": "2.7.0",
+  "description": "Nx plugin to generate, synthesize, deploy and destroy AWS CDK v2 applications inside an Nx workspace.",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "generators": "./generators.json",
   "executors": "./executors.json",
+  "nx-migrations": {
+    "migrations": "./migrations.json"
+  },
   "keywords": [
     "nx",
+    "nx-plugin",
+    "aws",
     "aws-cdk",
-    "monorepo",
     "aws cdk",
+    "cdk",
+    "cdk-v2",
+    "cloudformation",
+    "infrastructure-as-code",
+    "monorepo",
     "Node"
   ],
-  "ng-update": {
-    "requirements": {},
-    "migrations": "./migrations.json"
-  },
   "author": "Wolfram Sokollek",
+  "homepage": "https://github.com/WolfSoko/nx-aws-cdk-v2/tree/main/packages/aws-cdk-v2#readme",
+  "bugs": {
+    "url": "https://github.com/WolfSoko/nx-aws-cdk-v2/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git@github.com:WolfSoko/nx-aws-cdk-v2"
+    "url": "git+https://github.com/WolfSoko/nx-aws-cdk-v2.git",
+    "directory": "packages/aws-cdk-v2"
   },
   "license": "MIT",
-  "types": "./src/index.d.ts",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "peerDependencies": {
+    "@nx/devkit": ">=21.0.0",
+    "@nx/jest": ">=21.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nx/jest": {
+      "optional": true
+    }
+  },
   "type": "commonjs"
 }

package/src/executors/bootstrap/bootstrap.js

@@ -1,32 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = runExecutor;
-const tslib_1 = require("tslib");
 const executor_util_1 = require("../../utils/executor.util");
-function runExecutor(options, context) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const normalizedOptions = normalizeOptions(options, context);
-        const result = yield runBootstrap(normalizedOptions, context);
-        return {
-            success: result,
-        };
-    });
+async function runExecutor(options, context) {
+    const normalizedOptions = normalizeOptions(options, context);
+    const result = await runBootstrap(normalizedOptions, context);
+    return {
+        success: result,
+    };
 }
 function runBootstrap(options, context) {
     const command = (0, executor_util_1.createCommand)('bootstrap', options);
     return (0, executor_util_1.runCommandProcess)(command, context.root);
 }
 function normalizeOptions(options, context) {
-    var _a;
     const parsedArgs = (0, executor_util_1.parseArgs)(options);
     let profile;
     if (Object.prototype.hasOwnProperty.call(options, 'profile')) {
         profile = `--profile ${options.profile}`;
     }
     // eslint-disable-next-line no-unsafe-optional-chaining
-    const { sourceRoot, root } = (_a = context === null || context === void 0 ? void 0 : context.projectsConfigurations) === null || _a === void 0 ? void 0 : _a.projects[context.projectName];
-    return Object.assign(Object.assign({}, options), { parseArgs: parsedArgs, profile,
+    const { sourceRoot, root } = context?.projectsConfigurations?.projects[context.projectName];
+    return {
+        ...options,
+        parseArgs: parsedArgs,
+        profile,
         sourceRoot,
-        root });
+        root,
+    };
 }
 //# sourceMappingURL=bootstrap.js.map

package/src/executors/bootstrap/bootstrap.js.map

@@ -1 +1 @@
-{"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../../../../../../packages/aws-cdk-v2/src/executors/bootstrap/bootstrap.ts"],"names":[],"mappings":";;AAYA,8BAOC;;AAlBD,6DAAwF;AAWxF,SAA8B,WAAW,CAAC,OAAgC,EAAE,OAAwB;;QAClG,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAE9D,OAAO;YACL,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,OAAsC,EAAE,OAAwB;IACpF,MAAM,OAAO,GAAG,IAAA,6BAAa,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACpD,OAAO,IAAA,iCAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgC,EAAE,OAAwB;;IAClF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,OAAO,CAAC,CAAC;IACtC,IAAI,OAAO,CAAC;IAEZ,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAC7D,OAAO,GAAG,aAAa,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3C,CAAC;IAED,uDAAuD;IACvD,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,0CAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5F,uCACK,OAAO,KACV,SAAS,EAAE,UAAU,EACrB,OAAO;QACP,UAAU;QACV,IAAI,IACJ;AACJ,CAAC"}
+{"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../../../../../../packages/aws-cdk-v2/src/executors/bootstrap/bootstrap.ts"],"names":[],"mappings":";;AAYA,8BAOC;AAlBD,6DAAwF;AAWzE,KAAK,UAAU,WAAW,CAAC,OAAgC,EAAE,OAAwB;IAClG,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAE9D,OAAO;QACL,OAAO,EAAE,MAAM;KAChB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,OAAsC,EAAE,OAAwB;IACpF,MAAM,OAAO,GAAG,IAAA,6BAAa,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACpD,OAAO,IAAA,iCAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgC,EAAE,OAAwB;IAClF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,OAAO,CAAC,CAAC;IACtC,IAAI,OAAO,CAAC;IAEZ,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAC7D,OAAO,GAAG,aAAa,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3C,CAAC;IAED,uDAAuD;IACvD,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5F,OAAO;QACL,GAAG,OAAO;QACV,SAAS,EAAE,UAAU;QACrB,OAAO;QACP,UAAU;QACV,IAAI;KACL,CAAC;AACJ,CAAC"}

package/src/executors/bootstrap/schema.d.ts

@@ -1,3 +1,6 @@
 export interface BootstrapExecutorSchema {
+  /** AWS profile to bootstrap with. */
   profile?: string;
+  /** Additional CDK context values as `KEY=VALUE` pairs. */
+  context?: string | string[];
 }

package/src/executors/bootstrap/schema.json

@@ -1,8 +1,19 @@
 {
   "$schema": "http://json-schema.org/schema",
   "title": "Bootstrap executor",
-  "description": "",
+  "description": "Prepare (bootstrap) an AWS environment so CDK stacks of this project can be deployed into it.",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "profile": {
+      "type": "string",
+      "description": "Name of the AWS profile (from ~/.aws/credentials or ~/.aws/config) to bootstrap with."
+    },
+    "context": {
+      "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }],
+      "description": "Additional CDK context values as KEY=VALUE pairs. Pass the option multiple times for multiple values.",
+      "alias": "c"
+    }
+  },
+  "additionalProperties": true,
   "required": []
 }

package/src/executors/deploy/deploy.js

@@ -1,33 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = runExecutor;
-const tslib_1 = require("tslib");
 const executor_util_1 = require("../../utils/executor.util");
-function runExecutor(options, context) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const normalizedOptions = normalizeOptions(options, context);
-        const result = yield runDeploy(normalizedOptions, context);
-        return {
-            success: result,
-        };
-    });
+async function runExecutor(options, context) {
+    const normalizedOptions = normalizeOptions(options, context);
+    const result = await runDeploy(normalizedOptions, context);
+    return {
+        success: result,
+    };
 }
-function runDeploy(options, context) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const command = (0, executor_util_1.createCommand)('deploy', options);
-        return (0, executor_util_1.runCommandProcess)(command, context.root);
-    });
+async function runDeploy(options, context) {
+    const command = (0, executor_util_1.createCommand)('deploy', options);
+    return (0, executor_util_1.runCommandProcess)(command, context.root);
 }
 function normalizeOptions(options, context) {
-    var _a, _b;
     const parsedArgs = (0, executor_util_1.parseArgs)(options);
     let stacks;
     if (Object.prototype.hasOwnProperty.call(options, 'stacks')) {
         stacks = options.stacks;
     }
-    const { sourceRoot, root } = (_b = (_a = context === null || context === void 0 ? void 0 : context.projectsConfigurations) === null || _a === void 0 ? void 0 : _a.projects[context.projectName]) !== null && _b !== void 0 ? _b : {};
-    return Object.assign(Object.assign({}, options), { parseArgs: parsedArgs, stacks,
+    const { sourceRoot, root } = context?.projectsConfigurations?.projects[context.projectName] ?? {};
+    return {
+        ...options,
+        parseArgs: parsedArgs,
+        stacks,
         sourceRoot,
-        root });
+        root,
+    };
 }
 //# sourceMappingURL=deploy.js.map

package/src/executors/deploy/deploy.js.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../../../../packages/aws-cdk-v2/src/executors/deploy/deploy.ts"],"names":[],"mappings":";;AAWA,8BAOC;;AAjBD,6DAAwF;AAUxF,SAA8B,WAAW,CAAC,OAA6B,EAAE,OAAwB;;QAC/F,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAE3D,OAAO;YACL,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;CAAA;AAED,SAAe,SAAS,CAAC,OAAmC,EAAE,OAAwB;;QACpF,MAAM,OAAO,GAAG,IAAA,6BAAa,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,IAAA,iCAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;CAAA;AAED,SAAS,gBAAgB,CAAC,OAA6B,EAAE,OAAwB;;IAC/E,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,OAAO,CAAC,CAAC;IACtC,IAAI,MAAM,CAAC;IAEX,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC5D,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,0CAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,mCAAI,EAAE,CAAC;IAElG,uCACK,OAAO,KACV,SAAS,EAAE,UAAU,EACrB,MAAM;QACN,UAAU;QACV,IAAI,IACJ;AACJ,CAAC"}
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../../../../packages/aws-cdk-v2/src/executors/deploy/deploy.ts"],"names":[],"mappings":";;AAWA,8BAOC;AAjBD,6DAAwF;AAUzE,KAAK,UAAU,WAAW,CAAC,OAA6B,EAAE,OAAwB;IAC/F,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAE3D,OAAO;QACL,OAAO,EAAE,MAAM;KAChB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,OAAmC,EAAE,OAAwB;IACpF,MAAM,OAAO,GAAG,IAAA,6BAAa,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO,IAAA,iCAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,gBAAgB,CAAC,OAA6B,EAAE,OAAwB;IAC/E,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,OAAO,CAAC,CAAC;IACtC,IAAI,MAAM,CAAC;IAEX,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC5D,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAElG,OAAO;QACL,GAAG,OAAO;QACV,SAAS,EAAE,UAAU;QACrB,MAAM;QACN,UAAU;QACV,IAAI;KACL,CAAC;AACJ,CAAC"}

package/src/executors/deploy/schema.d.ts

@@ -1,3 +1,8 @@
 export interface DeployExecutorSchema {
+  /** Stacks to deploy. Defaults to every stack in the app. */
   stacks?: string;
+  /** AWS profile to use. */
+  profile?: string;
+  /** Additional CDK context values as `KEY=VALUE` pairs. */
+  context?: string | string[];
 }

package/src/executors/deploy/schema.json

@@ -1,13 +1,23 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "title": "deploy executor",
-  "description": "",
+  "title": "Deploy executor",
+  "description": "Deploy the CDK stacks of this project to AWS.",
   "type": "object",
   "properties": {
     "stacks": {
       "type": "string",
-      "description": "use deploy named STACKS"
+      "description": "Stacks to deploy. Accepts stack names or glob patterns, space separated. Defaults to every stack in the app."
+    },
+    "profile": {
+      "type": "string",
+      "description": "Name of the AWS profile (from ~/.aws/credentials or ~/.aws/config) to use."
+    },
+    "context": {
+      "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }],
+      "description": "Additional CDK context values as KEY=VALUE pairs. Pass the option multiple times for multiple values.",
+      "alias": "c"
     }
   },
+  "additionalProperties": true,
   "required": []
 }