@plastic-ant/nx-cdk

An Nx (Project Crystal) plugin for developing with the aws-cdk

Table of Contents

• Install
• Usage
• Example App
• Contributing
• License

Install

# npm
npm install --save-dev @plastic-ant/nx-cdk

# yarn
yarn add --dev @plastic-ant/nx-cdk

Usage

For using the inferred tasks (Project Crystal) add the plugin to your nx.json config:

"plugins": [
    {
      "plugin": "@plastic-ant/nx-cdk",
      "options": {
          synthTargetName     (optional) generated target synth, default cdk-synth
          deployTargetName    (optional) generated target deploy, default cdk-deploy
          bootstrapTargetName (optional) generated target bootstrap, default cdk-bootstrap
       }
    }
]

Included executors

Each executor has options that mirror the same cdk CLI command with the addtional of postTargets to be run synchronously.

"targets": {
      "bootstrap": {
        "executor": "@plastic-ant/nx-cdk:bootstrap",
        "options": {
          "postTargets": []
        }
      },
      "synth": {
        "executor": "@plastic-ant/nx-cdk:synth",
        "options": {
          "postTargets": ["{projectName}:postSynth"]
        }
      },
      "deploy": {
        "executor": "@plastic-ant/nx-cdk:deploy",
        "options": {
          "postTargets": ["sendSQS"]
        }
      }
    }
    ...

License

This project is MIT licensed 2024 Plastic Ant Software

Links

• Nx
• AWS CDK