UNPKG

flywaymigrationconstruct

Version:

Flyway is an opensource tool to easily evolve your db : https://flywaydb.org/

github.com/APrzysiuda/flywaymigrationconstruct

APrzysiuda/flywaymigrationconstruct

161 lines (89 loc) • 4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# API Reference <a name="API Reference"></a> ## Constructs <a name="Constructs"></a> ### FlywayConstruct <a name="flywaymigrationconstruct.FlywayConstruct"></a> #### Initializers <a name="flywaymigrationconstruct.FlywayConstruct.Initializer"></a> ```typescript import { FlywayConstruct } from 'flywaymigrationconstruct' new FlywayConstruct(scope: Construct, id: string, params: FlywayConstructParams) ``` ##### `scope`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstruct.parameter.scope"></a> - *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct) --- ##### `id`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstruct.parameter.id"></a> - *Type:* `string` --- ##### `params`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstruct.parameter.params"></a> - *Type:* [`flywaymigrationconstruct.FlywayConstructParams`](#flywaymigrationconstruct.FlywayConstructParams) --- #### Properties <a name="Properties"></a> ##### `flywayLambdaMigration`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstruct.property.flywayLambdaMigration"></a> ```typescript public readonly flywayLambdaMigration: Function; ``` - *Type:* [`@aws-cdk/aws-lambda.Function`](#@aws-cdk/aws-lambda.Function) --- ##### `objectCodeKey`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstruct.property.objectCodeKey"></a> ```typescript public readonly objectCodeKey: any; ``` - *Type:* `any` --- #### Constants <a name="Constants"></a> ##### `BUCKET_CODE_ARN` <a name="flywaymigrationconstruct.FlywayConstruct.property.BUCKET_CODE_ARN"></a> - *Type:* `string` --- ##### `HANDLER` <a name="flywaymigrationconstruct.FlywayConstruct.property.HANDLER"></a> - *Type:* `string` --- ##### `ID_LAMBDA_CODE` <a name="flywaymigrationconstruct.FlywayConstruct.property.ID_LAMBDA_CODE"></a> - *Type:* `string` --- ## Structs <a name="Structs"></a> ### FlywayConstructParams <a name="flywaymigrationconstruct.FlywayConstructParams"></a> #### Initializer <a name="[object Object].Initializer"></a> ```typescript import { FlywayConstructParams } from 'flywaymigrationconstruct' const flywayConstructParams: FlywayConstructParams = { ... } ``` ##### `bucketMigrationSQL`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.bucketMigrationSQL"></a> ```typescript public readonly bucketMigrationSQL: IBucket; ``` - *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket) --- ##### `migrationDBSecretManager`<sup>Required</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.migrationDBSecretManager"></a> ```typescript public readonly migrationDBSecretManager: ISecret; ``` - *Type:* [`@aws-cdk/aws-secretsmanager.ISecret`](#@aws-cdk/aws-secretsmanager.ISecret) --- ##### `memorySize`<sup>Optional</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.memorySize"></a> ```typescript public readonly memorySize: number; ``` - *Type:* `number` --- ##### `securityGroups`<sup>Optional</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.securityGroups"></a> ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* [`@aws-cdk/aws-ec2.ISecurityGroup`](#@aws-cdk/aws-ec2.ISecurityGroup)[] --- ##### `subnet`<sup>Optional</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.subnet"></a> ```typescript public readonly subnet: SubnetSelection; ``` - *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection) --- ##### `timeout`<sup>Optional</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.timeout"></a> ```typescript public readonly timeout: Duration; ``` - *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration) --- ##### `vpc`<sup>Optional</sup> <a name="flywaymigrationconstruct.FlywayConstructParams.property.vpc"></a> ```typescript public readonly vpc: IVpc; ``` - *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc) ---