---

@ago-dev/nx-aws-cdk-v2

An Nx plugin for developing aws-cdk

Table of Contents

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

Install

``shell


npm

npm install --save-dev @ago-dev/nx-aws-cdk-v2

yarn

yarn add --dev @ago-dev/nx-aws-cdk-v2
`

Usage

$3

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

`shell
nx generate @ago-dev/nx-aws-cdk-v2:application myApp
`

you can customize it further by passing these options:

`
nx generate @ago-dev/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)
--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.
`

$3

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

`shell
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
``

Maintainers

@adrian-goe

Contributing

See the contributing file!

PRs accepted.

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

License

This project is MIT licensed 2022 Adrian Görisch

Special thanks

This Project is based on @tienne's
nx-plugins.

Also thanks to @therk for his work on migrating to cdk v2.