Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DrizzleMigrate
✓ import { DrizzleMigrate } from "@berenddeboer/cdk-drizzle-migrate"
✗ import { DrizzleMigrate } from "cdk-drizzle-migrate"
Note the npm scope @berenddeboer - not the plain package name. Common mistake due to package name mismatch.
DrizzleMigrate
✓ const { DrizzleMigrate } = require("@berenddeboer/cdk-drizzle-migrate")
✗ const DrizzleMigrate = require("@berenddeboer/cdk-drizzle-migrate")
CommonJS require with destructuring for named export. Default export not available.
DrizzleMigrateProps
✓ import { DrizzleMigrateProps } from "@berenddeboer/cdk-drizzle-migrate"
Type import available since 3.0.0. Type for props interface.
Creates an RDS cluster and runs Drizzle migrations from the local 'migrations' folder at deploy time.
import { Stack, StackProps } from "aws-cdk-lib";
import { Vpc, SubnetType } from "aws-cdk-lib/aws-ec2";
import { DatabaseCluster } from "aws-cdk-lib/aws-rds";
import { DrizzleMigrate } from "@berenddeboer/cdk-drizzle-migrate";
import { Construct } from "constructs";
class MyStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const vpc = new Vpc(this, "Vpc");
const database = new DatabaseCluster(this, "Database", {
engine: DatabaseClusterEngine.auroraPostgres({ version: AuroraPostgresEngineVersion.VER_15_3 }),
vpc,
vpcSubnets: { subnetType: SubnetType.PRIVATE_ISOLATED },
credentials: Credentials.fromGeneratedSecret("dbuser"),
});
new DrizzleMigrate(this, "DrizzleMigration", {
dbSecret: database.secret!,
migrationsPath: "migrations",
vpc,
vpcSubnets: { subnetType: SubnetType.PRIVATE_ISOLATED },
cluster: database,
});
}
}
Errors
Common errors & fixes
Cannot find module '@berenddeboer/cdk-drizzle-migrate'
Using unscoped package name 'cdk-drizzle-migrate' in import.
fixUse import { DrizzleMigrate } from '@berenddeboer/cdk-drizzle-migrate' The runtime version specified is not supported: nodejs24.x
Node.js 24.0.0 required but older runtime used in AWS Lambda or deploy environment.
fixEnsure Node.js >=24 is installed and CDK is configured to use Node 24 Lambda runtime.
Cannot find module 'drizzle-kit'
drizzle-kit NOT installed as a dependency.
fixInstall drizzle-kit: npm install drizzle-kit --save-dev
missing or empty migrations path: migrations
The specified migrationsPath does not exist or is empty.
fixEnsure the migrations folder exists and contains valid Drizzle migration files.
Property 'cluster' does not exist on type 'DrizzleMigrateProps'
Using an older version that did not support the 'cluster' property.
fixUpdate to version 3.0.0 or pass handlerProps.securityGroups instead.
Audit
Dependencies
aws-cdk-librequiredCDK framework peer dependency
constructsrequiredCDK constructs peer dependency
esbuildoptionalRecommended for CDK TypeScript projects