# API Reference
## Constructs
### DrizzleMigrate
A custom resource that runs Drizzle migrations.
#### Initializers
```typescript
import { DrizzleMigrate } from 'cdk-drizzle-migrate'
new DrizzleMigrate(scope: Construct, id: string, props: DrizzleMigrateProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | DrizzleMigrateProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* DrizzleMigrateProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```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`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| handler | aws-cdk-lib.aws_lambda_nodejs.NodejsFunction | The Lambda function that executes the migrations. |
| resource | aws-cdk-lib.CustomResource | The custom resource that was created. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `handler`Required
```typescript
public readonly handler: NodejsFunction;
```
- *Type:* aws-cdk-lib.aws_lambda_nodejs.NodejsFunction
The Lambda function that executes the migrations.
---
##### `resource`Required
```typescript
public readonly resource: CustomResource;
```
- *Type:* aws-cdk-lib.CustomResource
The custom resource that was created.
---
## Structs
### DrizzleMigrateProps
Properties for DrizzleMigrate.
#### Initializer
```typescript
import { DrizzleMigrateProps } from 'cdk-drizzle-migrate'
const drizzleMigrateProps: DrizzleMigrateProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| migrationsPath | string | The path to the migrations directory This directory will be bundled with the Lambda function. |
| cluster | aws-cdk-lib.aws_rds.IDatabaseCluster \| aws-cdk-lib.aws_rds.IDatabaseInstance \| aws-cdk-lib.aws_dsql.CfnCluster | Optional database cluster or instance Supports both traditional RDS/Aurora clusters and DSQL clusters - For RDS/Aurora: security groups will be configured to allow access - For DSQL: IAM authentication will be used instead of secrets. |
| dbSecret | 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. |
| handlerProps | aws-cdk-lib.aws_lambda_nodejs.NodejsFunctionProps | Optional properties to customize the Lambda function Excludes runtime, entry, and handler which are managed by the construct. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the Lambda function will be deployed Required when your database is only accessible in a VPC. |
| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Optional subnet selection to deploy the Lambda function Only used when vpc is specified. |
---
##### `migrationsPath`Required
```typescript
public readonly migrationsPath: string;
```
- *Type:* string
The path to the migrations directory This directory will be bundled with the Lambda function.
---
##### `cluster`Optional
```typescript
public readonly cluster: IDatabaseCluster | IDatabaseInstance | CfnCluster;
```
- *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster | aws-cdk-lib.aws_rds.IDatabaseInstance | aws-cdk-lib.aws_dsql.CfnCluster
- *Default:* No database connection is configured
Optional database cluster or instance Supports both traditional RDS/Aurora clusters and DSQL clusters - For RDS/Aurora: security groups will be configured to allow access - For DSQL: IAM authentication will be used instead of secrets.
---
##### `dbSecret`Optional
```typescript
public readonly dbSecret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
- *Default:* undefined for DSQL clusters using IAM authentication
The database secret containing connection details Must contain standard CDK database secret properties: username, password, host, port, engine, etc.
Not required when relying on IAM authentication (such as DSQL).
---
##### `handlerProps`Optional
```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.
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
- *Default:* use VPC of your RDS/Aurora cluster
The VPC where the Lambda function will be deployed Required when your database is only accessible in a VPC.
Not required for DSQL as it uses public endpoints with IAM authentication
---
##### `vpcSubnets`Optional
```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 Only used when vpc is specified.
---