Skip to main content

API Overview

High-level overview of the Nx CDK Deploy plugin APIs. Use this section to understand what each API surface covers and how to navigate the detailed reference pages.

What’s covered​

  • Generators — Create new CDK stacks/resources and scaffold code using Nx generators.
  • Executors — Run tasks such as build, deploy, and destroy for your CDK projects.
  • Schemas — JSON schemas for all generators and executors, including options and defaults.

Versioning​

The documentation tracks the current main branch. Behavior may change between releases. Pin to a specific version in your project’s package.json for stability.

Getting help​