@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
# 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
Dependencies
The machine utilising this plugin must be authenticated with AWS. Read more about how authentication works here
Usage
Bootstrap AWS environment
Prepare AWS environment for AWS CDK
nx g @nx-iac/aws-cdk:bootstrap
Generate AWS CDK project
New application
Create a new application in your Nx workspace, with AWS CDK capabilities
nx g @nx-iac/aws-cdk:app
Preexisting application
Give AWS CDK capabilities to a preexisting project in your Nx workspace
nx g @nx-iac/aws-cdk:appify
Package application
Create deployment artifacts for your AWS CDK project
nx package <app-name>
nx package <app-name> --context key1=value1 --contextSome key2=value2
Deploy application
Deploy your AWS CDK project, creating cloud resources in AWS
nx deploy <app-name>
Deploy application quickly
Deploy your AWS CDK project in the quickest way possible, shortening the feedback cycle during development
# once
nx run <app-name>:deploy:quick
# in watch mode
nx watch --includeDependentProjects --projects=<app-name> -- nx run <app-name>:deploy:quick
Destroy application
Destroy your AWS CDK project, deleting cloud resources in AWS
nx destroy <app-name>
Maintainer
Thanks
This plugin is inspired by @adrian-goe's nx-aws-cdk-v2.
Contributing
Read CONTRIBUTING.md!