# API Reference
## Constructs
### FlywayConstruct
#### Initializers
```typescript
import { FlywayConstruct } from 'flywaymigrationconstruct'
new FlywayConstruct(scope: Construct, id: string, params: FlywayConstructParams)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `params`Required
- *Type:* [`flywaymigrationconstruct.FlywayConstructParams`](#flywaymigrationconstruct.FlywayConstructParams)
---
#### Properties
##### `flywayLambdaMigration`Required
```typescript
public readonly flywayLambdaMigration: Function;
```
- *Type:* [`@aws-cdk/aws-lambda.Function`](#@aws-cdk/aws-lambda.Function)
---
##### `objectCodeKey`Required
```typescript
public readonly objectCodeKey: any;
```
- *Type:* `any`
---
#### Constants
##### `BUCKET_CODE_ARN`
- *Type:* `string`
---
##### `HANDLER`
- *Type:* `string`
---
##### `ID_LAMBDA_CODE`
- *Type:* `string`
---
## Structs
### FlywayConstructParams
#### Initializer
```typescript
import { FlywayConstructParams } from 'flywaymigrationconstruct'
const flywayConstructParams: FlywayConstructParams = { ... }
```
##### `bucketMigrationSQL`Required
```typescript
public readonly bucketMigrationSQL: IBucket;
```
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
---
##### `migrationDBSecretManager`Required
```typescript
public readonly migrationDBSecretManager: ISecret;
```
- *Type:* [`@aws-cdk/aws-secretsmanager.ISecret`](#@aws-cdk/aws-secretsmanager.ISecret)
---
##### `memorySize`Optional
```typescript
public readonly memorySize: number;
```
- *Type:* `number`
---
##### `securityGroups`Optional
```typescript
public readonly securityGroups: ISecurityGroup[];
```
- *Type:* [`@aws-cdk/aws-ec2.ISecurityGroup`](#@aws-cdk/aws-ec2.ISecurityGroup)[]
---
##### `subnet`Optional
```typescript
public readonly subnet: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
---
##### `timeout`Optional
```typescript
public readonly timeout: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---