@berenddeboer/nx-aws-cdk

An Nx plugin for developing aws-cdk applications Based on !codebrew/nx-aws-cdk

Table of Contents

• Install
• Usage
  • Generate Application
  • Targets
• Maintainers
• Contributing
• License

Install

# npm
npm install --save-dev @berenddeboer/nx-aws-cdk

# yarn
yarn add --dev @berenddeboer/nx-aws-cdk

Usage

Generate Application

Create AWS CDK v2 Application

More details on AWS CDK v2 can be found on https://docs.aws.amazon.com/cdk/v2/guide/home.html

nx generate @berenddeboer/nx-aws-cdk:application myApp

you can customize it further by passing these options:

nx generate @berenddeboer/nx-aws-cdk:application [name] [options,...]

Options:
  --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)
  --linter                   The tool to use for running lint checks. (default: eslint)
  --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.

Targets

Generated applications expose several functions to the CLI that allow users to deploy, destroy and so on.

nx deploy myApp
nx destroy myApp

All CDK commands are supported, although only the common targets are emitted.

Upgrading to version 2

Update your project.json when upgrading from an earlier version:

1. Replace the @berenddeboer/nx-aws-cdk:* plugin with @berenddeboer/nx-aws-cdk:cdk

2. Under the options property add the CDK command like synth or deploy.

Example:

"deploy": {
  "executor": "@berenddeboer/nx-aws-cdk:cdk",
  "options": {
    "command": "deploy"
  },
  "outputs": ["{workspaceRoot}/dist/{projectRoot}"]
},

Maintainers

@therk @tienne Used to maintain the original plugin under Codebrew

Contributing

See the contributing file!

PRs accepted.

If editing the README, please conform to the standard-readme specification.

License

This project is MIT licensed.