@nx-iac/aws-cdk

Empowers your Nx workspace with AWS CDK capabilities ⚡

What does it do?

- Generate AWS CDK projects
- Deploy AWS CDK projects
- Gives you total control of CLI arguments through project.json

Table of contents

- Install
- Dependencies
- Usage
- Bootstrap AWS environment
- Generate AWS CDK project
- New application
- Preexisting application
- Package application
- Deploy application
- Deploy application quickly
- Destroy application
- Maintainer
- Thanks
- Contributing
- License

Install

``sh


npm

npm install --save-dev @nx-iac/aws-cdk

yarn

yarn add --dev @nx-iac/aws-cdk

pnpm

pnpm install --save-dev @nx-iac/aws-cdk
`

$3

The machine utilising this plugin must be authenticated with AWS. Read more about how authentication works here

Usage

$3

Prepare AWS environment for AWS CDK

`sh
nx g @nx-iac/aws-cdk:bootstrap
`

$3

#### New application

Create a new application in your Nx workspace, with AWS CDK capabilities

`sh
nx g @nx-iac/aws-cdk:app
`

#### Preexisting application

Give AWS CDK capabilities to a preexisting project in your Nx workspace

`sh
nx g @nx-iac/aws-cdk:appify
`

$3

Create deployment artifacts for your AWS CDK project

⚠️ Beware of caching this output, since a target AWS environment could be encoded in it

`sh
nx package
`

`sh
nx package --context key1=value1 --contextSome key2=value2
`

$3

Deploy your AWS CDK project, creating cloud resources in AWS

`sh
nx deploy
`

$3

Deploy your AWS CDK project in the quickest way possible, shortening the feedback cycle during development

`sh


once

nx run :deploy:quick

in watch mode

nx watch --includeDependentProjects --projects= -- nx run :deploy:quick
`

$3

Destroy your AWS CDK project, deleting cloud resources in AWS

`sh
nx destroy
``

Maintainer

@joelklint

Thanks

This plugin is inspired by @adrian-goe's
nx-aws-cdk-v2.

Contributing

Read CONTRIBUTING.md!

License

MIT © Joel Klint