Prerequisites
Before you can use the Nx CDK Plugin effectively, make sure you have all the necessary tools and configurations in place.
System Requirements
Node.js and npm
- Node.js 18+ (recommended: latest LTS version)
- npm 8+ or yarn 1.22+ or pnpm 7+
Nx Workspace
- Nx 16+ (latest version recommended)
- Existing Nx workspace or ability to create one
AWS Requirements
AWS Account
- Active AWS account with administrative access
- Understanding of AWS billing and cost implications
AWS CLI
- AWS CLI v2 installed and configured
- Valid AWS credentials configured locally
AWS Permissions
Your AWS user/role needs permissions for:
- CloudFormation - Full access for stack management
- IAM - Role and policy creation
- Lambda - Function management
- API Gateway - REST API creation
- DynamoDB - Table management
- SNS/SQS - Messaging services
- S3 - Bucket operations
CDK Bootstrap
- CDK bootstrap completed for your target regions
- Understanding of CDK concepts and terminology
Development Environment
IDE/Editor
- VS Code (recommended with AWS and Nx extensions)
- WebStorm/IntelliJ with appropriate plugins
- Any editor with TypeScript support
Git
- Git installed and configured
- Basic understanding of version control
Terminal/Shell
- Bash, Zsh, or PowerShell for command execution
- Basic command line proficiency
Knowledge Prerequisites
Required Knowledge
- TypeScript/JavaScript fundamentals
- AWS Services basic understanding
- Nx Workspaces familiarity
- Infrastructure as Code concepts
Recommended Knowledge
- AWS CDK experience
- Microservices architecture patterns
- CI/CD pipeline concepts
- Docker containerization (for advanced scenarios)
Verification Checklist
Before proceeding, verify you have:
- Node.js 18+ installed
- Nx workspace available
- AWS CLI configured
- AWS credentials set up
- CDK bootstrapped in target regions
- Basic TypeScript knowledge
- Understanding of your AWS account limits
Next Steps
Once all prerequisites are met: