cdk-drizzle-migrate 0.0.9

package/API.md

@@ -0,0 +1,249 @@
+# API Reference <a name="API Reference" id="api-reference"></a>
+
+## Constructs <a name="Constructs" id="Constructs"></a>
+
+### DrizzleMigrate <a name="DrizzleMigrate" id="cdk-drizzle-migrate.DrizzleMigrate"></a>
+
+A custom resource that runs Drizzle migrations.
+
+#### Initializers <a name="Initializers" id="cdk-drizzle-migrate.DrizzleMigrate.Initializer"></a>
+
+```typescript
+import { DrizzleMigrate } from 'cdk-drizzle-migrate'
+
+new DrizzleMigrate(scope: Construct, id: string, props: DrizzleMigrateProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps">DrizzleMigrateProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="cdk-drizzle-migrate.DrizzleMigrate.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#cdk-drizzle-migrate.DrizzleMigrateProps">DrizzleMigrateProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="cdk-drizzle-migrate.DrizzleMigrate.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="cdk-drizzle-migrate.DrizzleMigrate.isConstruct"></a>
+
+```typescript
+import { DrizzleMigrate } from 'cdk-drizzle-migrate'
+
+DrizzleMigrate.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="cdk-drizzle-migrate.DrizzleMigrate.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.property.handler">handler</a></code> | <code>aws-cdk-lib.aws_lambda_nodejs.NodejsFunction</code> | The Lambda function that executes the migrations. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrate.property.resource">resource</a></code> | <code>aws-cdk-lib.CustomResource</code> | The custom resource that was created. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="cdk-drizzle-migrate.DrizzleMigrate.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `handler`<sup>Required</sup> <a name="handler" id="cdk-drizzle-migrate.DrizzleMigrate.property.handler"></a>
+
+```typescript
+public readonly handler: NodejsFunction;
+```
+
+- *Type:* aws-cdk-lib.aws_lambda_nodejs.NodejsFunction
+
+The Lambda function that executes the migrations.
+
+---
+
+##### `resource`<sup>Required</sup> <a name="resource" id="cdk-drizzle-migrate.DrizzleMigrate.property.resource"></a>
+
+```typescript
+public readonly resource: CustomResource;
+```
+
+- *Type:* aws-cdk-lib.CustomResource
+
+The custom resource that was created.
+
+---
+
+
+## Structs <a name="Structs" id="Structs"></a>
+
+### DrizzleMigrateProps <a name="DrizzleMigrateProps" id="cdk-drizzle-migrate.DrizzleMigrateProps"></a>
+
+Properties for DrizzleMigrate.
+
+#### Initializer <a name="Initializer" id="cdk-drizzle-migrate.DrizzleMigrateProps.Initializer"></a>
+
+```typescript
+import { DrizzleMigrateProps } from 'cdk-drizzle-migrate'
+
+const drizzleMigrateProps: DrizzleMigrateProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.dbSecret">dbSecret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | The database secret containing connection details Must contain standard CDK database secret properties: username, password, host, port, engine, etc. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.migrationsPath">migrationsPath</a></code> | <code>string</code> | The path to the migrations directory This directory will be bundled with the Lambda function. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC where the Lambda function will be deployed Required to allow the Lambda function to connect to the database. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_rds.IDatabaseCluster \| aws-cdk-lib.aws_rds.IDatabaseInstance</code> | Optional database cluster or instance If provided and a new security group is created, the security group will be configured to allow access to the database. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.handlerProps">handlerProps</a></code> | <code>aws-cdk-lib.aws_lambda_nodejs.NodejsFunctionProps</code> | Optional properties to customize the Lambda function Excludes runtime, entry, and handler which are managed by the construct. |
+| <code><a href="#cdk-drizzle-migrate.DrizzleMigrateProps.property.vpcSubnets">vpcSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Optional subnet selection to deploy the Lambda function. |
+
+---
+
+##### `dbSecret`<sup>Required</sup> <a name="dbSecret" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.dbSecret"></a>
+
+```typescript
+public readonly dbSecret: ISecret;
+```
+
+- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
+
+The database secret containing connection details Must contain standard CDK database secret properties: username, password, host, port, engine, etc.
+
+---
+
+##### `migrationsPath`<sup>Required</sup> <a name="migrationsPath" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.migrationsPath"></a>
+
+```typescript
+public readonly migrationsPath: string;
+```
+
+- *Type:* string
+
+The path to the migrations directory This directory will be bundled with the Lambda function.
+
+---
+
+##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+The VPC where the Lambda function will be deployed Required to allow the Lambda function to connect to the database.
+
+---
+
+##### `cluster`<sup>Optional</sup> <a name="cluster" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.cluster"></a>
+
+```typescript
+public readonly cluster: IDatabaseCluster | IDatabaseInstance;
+```
+
+- *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster | aws-cdk-lib.aws_rds.IDatabaseInstance
+- *Default:* No database connection is configured
+
+Optional database cluster or instance If provided and a new security group is created, the security group will be configured to allow access to the database.
+
+---
+
+##### `handlerProps`<sup>Optional</sup> <a name="handlerProps" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.handlerProps"></a>
+
+```typescript
+public readonly handlerProps: NodejsFunctionProps;
+```
+
+- *Type:* aws-cdk-lib.aws_lambda_nodejs.NodejsFunctionProps
+- *Default:* Default Lambda configuration is used
+
+Optional properties to customize the Lambda function Excludes runtime, entry, and handler which are managed by the construct.
+
+---
+
+##### `vpcSubnets`<sup>Optional</sup> <a name="vpcSubnets" id="cdk-drizzle-migrate.DrizzleMigrateProps.property.vpcSubnets"></a>
+
+```typescript
+public readonly vpcSubnets: SubnetSelection;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
+- *Default:* PRIVATE_WITH_EGRESS subnets
+
+Optional subnet selection to deploy the Lambda function.
+
+---
+
+
+

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+# About
+
+This CDK construct library makes it possible to run the drizzle
+migrate at deploy of your stack time against the RDS cluster of your
+choice. The supported engines are PostgreSQL, MariaDB and MySQL.
+
+This construct library is intended to be used in enterprise
+environments, and works in isolated subnets.
+
+<p align="left">
+  <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release" alt=semantic-release: angular"></a>
+  <a href="https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml"><img src="https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml/badge.svg" alt="Release badge"></a>
+</p>
+
+# Requirements
+
+This package assumes you deploy from a unix shell with access to `cp`,
+`mkdir`, and `curl`.
+
+# Installation
+
+     npm i cdk-drizzle-migrate
+
+You probably will be very unhappy if you don't have esbuild, so as
+usual in a cdk typescript project make sure that is installed too:
+
+    npm i esbuild
+
+And obviously drizzle-kit and drizzle-orm should be available if you
+actually want to create migrations.
+
+# Usage
+
+Have an RDS database and a secret that stores your db
+credentials. Usually this will be the root secret for your RDS
+database:
+
+```ts
+import { DrizzleMigrate } from "@berenddeboer/cdk-drizzle-migrate"
+
+// Create the DrizzleMigrate construct
+const migrator = new DrizzleMigrate(this, "DrizzleMigration", {
+  dbSecret: database.secret!,
+  migrationsPath: "migrations",
+  vpc: vpc,
+  vpcSubnets: {
+    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
+  },
+  cluster: database, // Pass the database instance to allow automatic security group configuration
+})
+```
+
+Your secret should look like the standard one created by CDK:
+
+```json
+{
+  "password": "some-password",
+  "dbname": "testdb",
+  "engine": "postgres",
+  "port": 5432,
+  "dbInstanceIdentifier": "some-name",
+  "host": "some-name.cvabql2flhit.us-east-1.rds.amazonaws.com",
+  "username": "postgres"
+}
+```
+
+Specify the path where the migrations are stored, `migrations` in this case.
+
+When this resource is deployed, it will run `drizzle-kit migrate` for
+you in the lambda.
+
+The default timeout is 5 minutes, you need to increase this if your
+migration takes more time.
+
+Passing your database cluster is optional. If supplied, the lambda's
+security group will be added as allowed source to the database
+security group if no security group is present in
+`handlerProps.securityGroups`.
+
+If you do not pass a cluster, make sure to pass in a security group in
+`handlerProps.securityGroups` which can connect to your database.
+
+Also if you do not pass a cluster you, but still create a database,
+you may wish to add a dependency to make sure the database is created,
+before the migration is run:
+
+```ts
+migrator.resource.node.addDependency(cluster)
+```
+
+# Potential pitfalls
+
+1. The lambda can only run for 15 minutes. If your migrations take
+   longer, this solution will not work.
+
+# Working on this code
+
+1. Install packages: `npm i`
+
+2. Bootstrap CDK if not done: `npx cdk bootstrap
+   aws://123456/us-east-1`. Replace 123456 with your AWS account.
+
+## Handler notes
+
+When making changes to the Lambda handler code in `lambda/index.ts`, you need to transpile it to JavaScript:
+
+```bash
+npx projen build:handler
+```
+
+This will generate `src/handler/handler.js` which is used by the CDK
+construct.
+
+This technique is used to avoid having to bundle nodejs dependencies
+as that doesn't work well in this case.

package/lib/drizzle-migrate-provider.d.ts

@@ -0,0 +1,58 @@
+import { CustomResource } from "aws-cdk-lib";
+import * as ec2 from "aws-cdk-lib/aws-ec2";
+import { NodejsFunction, NodejsFunctionProps } from "aws-cdk-lib/aws-lambda-nodejs";
+import * as rds from "aws-cdk-lib/aws-rds";
+import * as secretsmanager from "aws-cdk-lib/aws-secretsmanager";
+import { Construct } from "constructs";
+/**
+ * Properties for DrizzleMigrate
+ */
+export interface DrizzleMigrateProps {
+    /**
+     * The database secret containing connection details
+     * Must contain standard CDK database secret properties: username, password, host, port, engine, etc.
+     */
+    readonly dbSecret: secretsmanager.ISecret;
+    /**
+     * The path to the migrations directory
+     * This directory will be bundled with the Lambda function
+     */
+    readonly migrationsPath: string;
+    /**
+     * Optional properties to customize the Lambda function
+     * Excludes runtime, entry, and handler which are managed by the construct
+     * @default - Default Lambda configuration is used
+     */
+    readonly handlerProps?: NodejsFunctionProps;
+    /**
+     * The VPC where the Lambda function will be deployed
+     * Required to allow the Lambda function to connect to the database
+     */
+    readonly vpc: ec2.IVpc;
+    /**
+     * Optional subnet selection to deploy the Lambda function
+     * @default - PRIVATE_WITH_EGRESS subnets
+     */
+    readonly vpcSubnets?: ec2.SubnetSelection;
+    /**
+     * Optional database cluster or instance
+     * If provided and a new security group is created, the security group will be
+     * configured to allow access to the database
+     * @default - No database connection is configured
+     */
+    readonly cluster?: rds.IDatabaseCluster | rds.IDatabaseInstance;
+}
+/**
+ * A custom resource that runs Drizzle migrations
+ */
+export declare class DrizzleMigrate extends Construct {
+    /**
+     * The custom resource that was created
+     */
+    readonly resource: CustomResource;
+    /**
+     * The Lambda function that executes the migrations
+     */
+    readonly handler: NodejsFunction;
+    constructor(scope: Construct, id: string, props: DrizzleMigrateProps);
+}