@pwrdrvr/microapps-cdk 0.0.28 → 0.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1884 -185
- package/API.md +890 -60
- package/README.md +2 -8
- package/lib/MicroApps.d.ts +77 -44
- package/lib/MicroApps.js +62 -33
- package/lib/MicroAppsAPIGwy.d.ts +123 -0
- package/lib/MicroAppsAPIGwy.js +178 -0
- package/lib/MicroAppsCF.d.ts +179 -17
- package/lib/MicroAppsCF.js +127 -45
- package/lib/MicroAppsS3.d.ts +114 -17
- package/lib/MicroAppsS3.js +55 -31
- package/lib/MicroAppsSvcs.d.ts +123 -25
- package/lib/MicroAppsSvcs.js +113 -152
- package/lib/index.d.ts +4 -0
- package/lib/index.js +5 -1
- package/lib/microapps-deployer/index.js +116 -88
- package/lib/microapps-deployer/index.js.map +3 -3
- package/lib/microapps-router/index.js +60 -51
- package/lib/microapps-router/index.js.map +3 -3
- package/lib/utils/ReverseDomain.d.ts +4 -0
- package/lib/utils/ReverseDomain.js +15 -0
- package/package.json +45 -45
package/API.md
CHANGED
|
@@ -4,39 +4,583 @@
|
|
|
4
4
|
|
|
5
5
|
### MicroApps <a name="@pwrdrvr/microapps-cdk.MicroApps"></a>
|
|
6
6
|
|
|
7
|
+
- *Implements:* [`@pwrdrvr/microapps-cdk.IMicroApps`](#@pwrdrvr/microapps-cdk.IMicroApps)
|
|
8
|
+
|
|
7
9
|
Application deployment and runtime environment.
|
|
8
10
|
|
|
9
|
-
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroApps.Initializer"></a>
|
|
11
|
+
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroApps.Initializer"></a>
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MicroApps } from '@pwrdrvr/microapps-cdk'
|
|
15
|
+
|
|
16
|
+
new MicroApps(scope: Construct, id: string, props?: MicroAppsProps)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
##### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.scope"></a>
|
|
20
|
+
|
|
21
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
##### `id`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.id"></a>
|
|
26
|
+
|
|
27
|
+
- *Type:* `string`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
##### `props`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.props"></a>
|
|
32
|
+
|
|
33
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.MicroAppsProps`](#@pwrdrvr/microapps-cdk.MicroAppsProps)
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
#### Properties <a name="Properties"></a>
|
|
40
|
+
|
|
41
|
+
##### `apigwy`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.apigwy"></a>
|
|
42
|
+
|
|
43
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy`](#@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy)
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
##### `cf`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.cf"></a>
|
|
48
|
+
|
|
49
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsCF`](#@pwrdrvr/microapps-cdk.IMicroAppsCF)
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
##### `s3`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.s3"></a>
|
|
54
|
+
|
|
55
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsS3`](#@pwrdrvr/microapps-cdk.IMicroAppsS3)
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
##### `svcs`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroApps.svcs"></a>
|
|
60
|
+
|
|
61
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsSvcs`](#@pwrdrvr/microapps-cdk.IMicroAppsSvcs)
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### MicroAppsAPIGwy <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy"></a>
|
|
67
|
+
|
|
68
|
+
- *Implements:* [`@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy`](#@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy)
|
|
69
|
+
|
|
70
|
+
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.Initializer"></a>
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
import { MicroAppsAPIGwy } from '@pwrdrvr/microapps-cdk'
|
|
74
|
+
|
|
75
|
+
new MicroAppsAPIGwy(scope: Construct, id: string, props?: MicroAppsAPIGwyProps)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
##### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.scope"></a>
|
|
79
|
+
|
|
80
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
##### `id`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.id"></a>
|
|
85
|
+
|
|
86
|
+
- *Type:* `string`
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
##### `props`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.props"></a>
|
|
91
|
+
|
|
92
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps`](#@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps)
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
#### Properties <a name="Properties"></a>
|
|
99
|
+
|
|
100
|
+
##### `httpApi`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.httpApi"></a>
|
|
101
|
+
|
|
102
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.HttpApi`](#@aws-cdk/aws-apigatewayv2.HttpApi)
|
|
103
|
+
|
|
104
|
+
API Gateway.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
##### `dnAppsOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwy.dnAppsOrigin"></a>
|
|
109
|
+
|
|
110
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.IDomainName`](#@aws-cdk/aws-apigatewayv2.IDomainName)
|
|
111
|
+
|
|
112
|
+
Domain Name applied to API Gateway origin.
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### MicroAppsCF <a name="@pwrdrvr/microapps-cdk.MicroAppsCF"></a>
|
|
118
|
+
|
|
119
|
+
- *Implements:* [`@pwrdrvr/microapps-cdk.IMicroAppsCF`](#@pwrdrvr/microapps-cdk.IMicroAppsCF)
|
|
120
|
+
|
|
121
|
+
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.Initializer"></a>
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import { MicroAppsCF } from '@pwrdrvr/microapps-cdk'
|
|
125
|
+
|
|
126
|
+
new MicroAppsCF(scope: Construct, id: string, props: MicroAppsCFProps)
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
##### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.scope"></a>
|
|
130
|
+
|
|
131
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
##### `id`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.id"></a>
|
|
136
|
+
|
|
137
|
+
- *Type:* `string`
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
##### `props`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.props"></a>
|
|
142
|
+
|
|
143
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.MicroAppsCFProps`](#@pwrdrvr/microapps-cdk.MicroAppsCFProps)
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
#### Static Functions <a name="Static Functions"></a>
|
|
149
|
+
|
|
150
|
+
##### `addRoutes` <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.addRoutes"></a>
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
import { MicroAppsCF } from '@pwrdrvr/microapps-cdk'
|
|
154
|
+
|
|
155
|
+
MicroAppsCF.addRoutes(_scope: Construct, props: AddRoutesOptions)
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
###### `_scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF._scope"></a>
|
|
159
|
+
|
|
160
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
###### `props`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.props"></a>
|
|
165
|
+
|
|
166
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.AddRoutesOptions`](#@pwrdrvr/microapps-cdk.AddRoutesOptions)
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
##### `createAPIOriginPolicy` <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.createAPIOriginPolicy"></a>
|
|
171
|
+
|
|
172
|
+
```typescript
|
|
173
|
+
import { MicroAppsCF } from '@pwrdrvr/microapps-cdk'
|
|
174
|
+
|
|
175
|
+
MicroAppsCF.createAPIOriginPolicy(scope: Construct, props: CreateAPIOriginPolicyOptions)
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
###### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.scope"></a>
|
|
179
|
+
|
|
180
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
###### `props`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.props"></a>
|
|
185
|
+
|
|
186
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions`](#@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions)
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
#### Properties <a name="Properties"></a>
|
|
191
|
+
|
|
192
|
+
##### `cloudFrontDistro`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCF.cloudFrontDistro"></a>
|
|
193
|
+
|
|
194
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.Distribution`](#@aws-cdk/aws-cloudfront.Distribution)
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### MicroAppsS3 <a name="@pwrdrvr/microapps-cdk.MicroAppsS3"></a>
|
|
200
|
+
|
|
201
|
+
- *Implements:* [`@pwrdrvr/microapps-cdk.IMicroAppsS3`](#@pwrdrvr/microapps-cdk.IMicroAppsS3)
|
|
202
|
+
|
|
203
|
+
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.Initializer"></a>
|
|
204
|
+
|
|
205
|
+
```typescript
|
|
206
|
+
import { MicroAppsS3 } from '@pwrdrvr/microapps-cdk'
|
|
207
|
+
|
|
208
|
+
new MicroAppsS3(scope: Construct, id: string, props?: MicroAppsS3Props)
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
##### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.scope"></a>
|
|
212
|
+
|
|
213
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
##### `id`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.id"></a>
|
|
218
|
+
|
|
219
|
+
- *Type:* `string`
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
##### `props`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.props"></a>
|
|
224
|
+
|
|
225
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.MicroAppsS3Props`](#@pwrdrvr/microapps-cdk.MicroAppsS3Props)
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
#### Properties <a name="Properties"></a>
|
|
232
|
+
|
|
233
|
+
##### `bucketApps`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.bucketApps"></a>
|
|
234
|
+
|
|
235
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
236
|
+
|
|
237
|
+
S3 bucket for deployed applications.
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
##### `bucketAppsOAI`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.bucketAppsOAI"></a>
|
|
242
|
+
|
|
243
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.OriginAccessIdentity`](#@aws-cdk/aws-cloudfront.OriginAccessIdentity)
|
|
244
|
+
|
|
245
|
+
CloudFront Origin Access Identity for the deployed applications bucket.
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
##### `bucketAppsOrigin`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.bucketAppsOrigin"></a>
|
|
250
|
+
|
|
251
|
+
- *Type:* [`@aws-cdk/aws-cloudfront-origins.S3Origin`](#@aws-cdk/aws-cloudfront-origins.S3Origin)
|
|
252
|
+
|
|
253
|
+
CloudFront Origin for the deployed applications bucket.
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
##### `bucketAppsStaging`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.bucketAppsStaging"></a>
|
|
258
|
+
|
|
259
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
260
|
+
|
|
261
|
+
S3 bucket for staged applications (prior to deploy).
|
|
262
|
+
|
|
263
|
+
---
|
|
264
|
+
|
|
265
|
+
##### `bucketLogs`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3.bucketLogs"></a>
|
|
266
|
+
|
|
267
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
268
|
+
|
|
269
|
+
S3 bucket for CloudFront logs.
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
### MicroAppsSvcs <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs"></a>
|
|
275
|
+
|
|
276
|
+
- *Implements:* [`@pwrdrvr/microapps-cdk.IMicroAppsSvcs`](#@pwrdrvr/microapps-cdk.IMicroAppsSvcs)
|
|
277
|
+
|
|
278
|
+
#### Initializer <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.Initializer"></a>
|
|
279
|
+
|
|
280
|
+
```typescript
|
|
281
|
+
import { MicroAppsSvcs } from '@pwrdrvr/microapps-cdk'
|
|
282
|
+
|
|
283
|
+
new MicroAppsSvcs(scope: Construct, id: string, props?: MicroAppsSvcsProps)
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
##### `scope`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.scope"></a>
|
|
287
|
+
|
|
288
|
+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
|
|
289
|
+
|
|
290
|
+
---
|
|
291
|
+
|
|
292
|
+
##### `id`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.id"></a>
|
|
293
|
+
|
|
294
|
+
- *Type:* `string`
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
##### `props`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.props"></a>
|
|
299
|
+
|
|
300
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.MicroAppsSvcsProps`](#@pwrdrvr/microapps-cdk.MicroAppsSvcsProps)
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
#### Properties <a name="Properties"></a>
|
|
307
|
+
|
|
308
|
+
##### `deployerFunc`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.deployerFunc"></a>
|
|
309
|
+
|
|
310
|
+
- *Type:* [`@aws-cdk/aws-lambda.IFunction`](#@aws-cdk/aws-lambda.IFunction)
|
|
311
|
+
|
|
312
|
+
Lambda function for the Deployer.
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
##### `table`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcs.table"></a>
|
|
317
|
+
|
|
318
|
+
- *Type:* [`@aws-cdk/aws-dynamodb.ITable`](#@aws-cdk/aws-dynamodb.ITable)
|
|
319
|
+
|
|
320
|
+
DynamoDB table used by Router, Deployer, and Release console app.
|
|
321
|
+
|
|
322
|
+
---
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
## Structs <a name="Structs"></a>
|
|
326
|
+
|
|
327
|
+
### AddRoutesOptions <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions"></a>
|
|
328
|
+
|
|
329
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
import { AddRoutesOptions } from '@pwrdrvr/microapps-cdk'
|
|
333
|
+
|
|
334
|
+
const addRoutesOptions: AddRoutesOptions = { ... }
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
##### `apiGwyOrigin`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions.apiGwyOrigin"></a>
|
|
338
|
+
|
|
339
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.IOrigin`](#@aws-cdk/aws-cloudfront.IOrigin)
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
##### `apigwyOriginRequestPolicy`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions.apigwyOriginRequestPolicy"></a>
|
|
344
|
+
|
|
345
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.IOriginRequestPolicy`](#@aws-cdk/aws-cloudfront.IOriginRequestPolicy)
|
|
346
|
+
|
|
347
|
+
---
|
|
348
|
+
|
|
349
|
+
##### `bucketAppsOrigin`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions.bucketAppsOrigin"></a>
|
|
350
|
+
|
|
351
|
+
- *Type:* [`@aws-cdk/aws-cloudfront-origins.S3Origin`](#@aws-cdk/aws-cloudfront-origins.S3Origin)
|
|
352
|
+
|
|
353
|
+
---
|
|
354
|
+
|
|
355
|
+
##### `distro`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions.distro"></a>
|
|
356
|
+
|
|
357
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.Distribution`](#@aws-cdk/aws-cloudfront.Distribution)
|
|
358
|
+
|
|
359
|
+
---
|
|
360
|
+
|
|
361
|
+
##### `rootPathPrefix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.AddRoutesOptions.rootPathPrefix"></a>
|
|
362
|
+
|
|
363
|
+
- *Type:* `string`
|
|
364
|
+
|
|
365
|
+
---
|
|
366
|
+
|
|
367
|
+
### CreateAPIOriginPolicyOptions <a name="@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions"></a>
|
|
368
|
+
|
|
369
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
370
|
+
|
|
371
|
+
```typescript
|
|
372
|
+
import { CreateAPIOriginPolicyOptions } from '@pwrdrvr/microapps-cdk'
|
|
373
|
+
|
|
374
|
+
const createAPIOriginPolicyOptions: CreateAPIOriginPolicyOptions = { ... }
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions.assetNameRoot"></a>
|
|
378
|
+
|
|
379
|
+
- *Type:* `string`
|
|
380
|
+
|
|
381
|
+
---
|
|
382
|
+
|
|
383
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions.assetNameSuffix"></a>
|
|
384
|
+
|
|
385
|
+
- *Type:* `string`
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
##### `domainNameEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.CreateAPIOriginPolicyOptions.domainNameEdge"></a>
|
|
390
|
+
|
|
391
|
+
- *Type:* `string`
|
|
392
|
+
|
|
393
|
+
Edge domain name used by CloudFront - If set a custom OriginRequestPolicy will be created that prevents the Host header from being passed to the origin.
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
### MicroAppsAPIGwyProps <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps"></a>
|
|
398
|
+
|
|
399
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
400
|
+
|
|
401
|
+
```typescript
|
|
402
|
+
import { MicroAppsAPIGwyProps } from '@pwrdrvr/microapps-cdk'
|
|
403
|
+
|
|
404
|
+
const microAppsAPIGwyProps: MicroAppsAPIGwyProps = { ... }
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.assetNameRoot"></a>
|
|
408
|
+
|
|
409
|
+
- *Type:* `string`
|
|
410
|
+
- *Default:* resource names auto assigned
|
|
411
|
+
|
|
412
|
+
Optional asset name root.
|
|
413
|
+
|
|
414
|
+
---
|
|
415
|
+
|
|
416
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.assetNameSuffix"></a>
|
|
417
|
+
|
|
418
|
+
- *Type:* `string`
|
|
419
|
+
- *Default:* none
|
|
420
|
+
|
|
421
|
+
Optional asset name suffix.
|
|
422
|
+
|
|
423
|
+
---
|
|
424
|
+
|
|
425
|
+
##### `certOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.certOrigin"></a>
|
|
426
|
+
|
|
427
|
+
- *Type:* [`@aws-cdk/aws-certificatemanager.ICertificate`](#@aws-cdk/aws-certificatemanager.ICertificate)
|
|
428
|
+
- *Default:* none
|
|
429
|
+
|
|
430
|
+
Optional local region ACM certificate to use for API Gateway Note: required when using a custom domain.
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
##### `domainNameEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.domainNameEdge"></a>
|
|
435
|
+
|
|
436
|
+
- *Type:* `string`
|
|
437
|
+
- *Default:* auto-assigned
|
|
438
|
+
|
|
439
|
+
CloudFront edge domain name.
|
|
440
|
+
|
|
441
|
+
---
|
|
442
|
+
|
|
443
|
+
##### `domainNameOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.domainNameOrigin"></a>
|
|
444
|
+
|
|
445
|
+
- *Type:* `string`
|
|
446
|
+
- *Default:* auto-assigned
|
|
447
|
+
|
|
448
|
+
API Gateway origin domain name.
|
|
449
|
+
|
|
450
|
+
---
|
|
451
|
+
|
|
452
|
+
##### `r53Zone`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.r53Zone"></a>
|
|
453
|
+
|
|
454
|
+
- *Type:* [`@aws-cdk/aws-route53.IHostedZone`](#@aws-cdk/aws-route53.IHostedZone)
|
|
455
|
+
|
|
456
|
+
Route53 zone in which to create optional `domainNameEdge` record.
|
|
457
|
+
|
|
458
|
+
---
|
|
459
|
+
|
|
460
|
+
##### `removalPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.removalPolicy"></a>
|
|
461
|
+
|
|
462
|
+
- *Type:* [`@aws-cdk/core.RemovalPolicy`](#@aws-cdk/core.RemovalPolicy)
|
|
463
|
+
- *Default:* per resource default
|
|
464
|
+
|
|
465
|
+
RemovalPolicy override for child resources.
|
|
466
|
+
|
|
467
|
+
Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
|
|
468
|
+
|
|
469
|
+
---
|
|
470
|
+
|
|
471
|
+
##### `rootPathPrefix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsAPIGwyProps.rootPathPrefix"></a>
|
|
472
|
+
|
|
473
|
+
- *Type:* `string`
|
|
474
|
+
- *Default:* none
|
|
475
|
+
|
|
476
|
+
Path prefix on the root of the API Gateway Stage.
|
|
477
|
+
|
|
478
|
+
---
|
|
479
|
+
|
|
480
|
+
### MicroAppsCFProps <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps"></a>
|
|
481
|
+
|
|
482
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
483
|
+
|
|
484
|
+
```typescript
|
|
485
|
+
import { MicroAppsCFProps } from '@pwrdrvr/microapps-cdk'
|
|
486
|
+
|
|
487
|
+
const microAppsCFProps: MicroAppsCFProps = { ... }
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
##### `bucketAppsOrigin`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.bucketAppsOrigin"></a>
|
|
491
|
+
|
|
492
|
+
- *Type:* [`@aws-cdk/aws-cloudfront-origins.S3Origin`](#@aws-cdk/aws-cloudfront-origins.S3Origin)
|
|
493
|
+
|
|
494
|
+
S3 bucket origin for deployed applications.
|
|
495
|
+
|
|
496
|
+
---
|
|
497
|
+
|
|
498
|
+
##### `httpApi`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.httpApi"></a>
|
|
499
|
+
|
|
500
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.HttpApi`](#@aws-cdk/aws-apigatewayv2.HttpApi)
|
|
501
|
+
|
|
502
|
+
API Gateway v2 HTTP API for apps.
|
|
503
|
+
|
|
504
|
+
---
|
|
505
|
+
|
|
506
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.assetNameRoot"></a>
|
|
507
|
+
|
|
508
|
+
- *Type:* `string`
|
|
509
|
+
- *Default:* resource names auto assigned
|
|
510
|
+
|
|
511
|
+
Optional asset name root.
|
|
512
|
+
|
|
513
|
+
---
|
|
514
|
+
|
|
515
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.assetNameSuffix"></a>
|
|
516
|
+
|
|
517
|
+
- *Type:* `string`
|
|
518
|
+
- *Default:* none
|
|
519
|
+
|
|
520
|
+
Optional asset name suffix.
|
|
521
|
+
|
|
522
|
+
---
|
|
523
|
+
|
|
524
|
+
##### `bucketLogs`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.bucketLogs"></a>
|
|
525
|
+
|
|
526
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
527
|
+
|
|
528
|
+
S3 bucket for CloudFront logs.
|
|
529
|
+
|
|
530
|
+
---
|
|
531
|
+
|
|
532
|
+
##### `certEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.certEdge"></a>
|
|
533
|
+
|
|
534
|
+
- *Type:* [`@aws-cdk/aws-certificatemanager.ICertificate`](#@aws-cdk/aws-certificatemanager.ICertificate)
|
|
535
|
+
|
|
536
|
+
ACM Certificate that covers `domainNameEdge` name.
|
|
10
537
|
|
|
11
|
-
|
|
12
|
-
import { MicroApps } from '@pwrdrvr/microapps-cdk'
|
|
538
|
+
---
|
|
13
539
|
|
|
14
|
-
|
|
15
|
-
```
|
|
540
|
+
##### `domainNameEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.domainNameEdge"></a>
|
|
16
541
|
|
|
17
|
-
|
|
542
|
+
- *Type:* `string`
|
|
543
|
+
- *Default:* auto-assigned
|
|
18
544
|
|
|
19
|
-
|
|
545
|
+
CloudFront Distribution domain name.
|
|
20
546
|
|
|
21
547
|
---
|
|
22
548
|
|
|
23
|
-
##### `
|
|
549
|
+
##### `domainNameOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.domainNameOrigin"></a>
|
|
24
550
|
|
|
25
551
|
- *Type:* `string`
|
|
552
|
+
- *Default:* retrieved from httpApi, if possible
|
|
553
|
+
|
|
554
|
+
API Gateway custom origin domain name.
|
|
26
555
|
|
|
27
556
|
---
|
|
28
557
|
|
|
29
|
-
##### `
|
|
558
|
+
##### `r53Zone`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.r53Zone"></a>
|
|
30
559
|
|
|
31
|
-
- *Type:* [`@
|
|
560
|
+
- *Type:* [`@aws-cdk/aws-route53.IHostedZone`](#@aws-cdk/aws-route53.IHostedZone)
|
|
561
|
+
|
|
562
|
+
Route53 zone in which to create optional `domainNameEdge` record.
|
|
32
563
|
|
|
33
564
|
---
|
|
34
565
|
|
|
566
|
+
##### `removalPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.removalPolicy"></a>
|
|
35
567
|
|
|
568
|
+
- *Type:* [`@aws-cdk/core.RemovalPolicy`](#@aws-cdk/core.RemovalPolicy)
|
|
569
|
+
- *Default:* per resource default
|
|
36
570
|
|
|
571
|
+
RemovalPolicy override for child resources.
|
|
37
572
|
|
|
573
|
+
Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
|
|
38
574
|
|
|
39
|
-
|
|
575
|
+
---
|
|
576
|
+
|
|
577
|
+
##### `rootPathPrefix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsCFProps.rootPathPrefix"></a>
|
|
578
|
+
|
|
579
|
+
- *Type:* `string`
|
|
580
|
+
|
|
581
|
+
Path prefix on the root of the CloudFront distribution.
|
|
582
|
+
|
|
583
|
+
---
|
|
40
584
|
|
|
41
585
|
### MicroAppsProps <a name="@pwrdrvr/microapps-cdk.MicroAppsProps"></a>
|
|
42
586
|
|
|
@@ -50,33 +594,34 @@ import { MicroAppsProps } from '@pwrdrvr/microapps-cdk'
|
|
|
50
594
|
const microAppsProps: MicroAppsProps = { ... }
|
|
51
595
|
```
|
|
52
596
|
|
|
53
|
-
##### `
|
|
597
|
+
##### `appEnv`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.appEnv"></a>
|
|
54
598
|
|
|
55
599
|
- *Type:* `string`
|
|
600
|
+
- *Default:* dev
|
|
56
601
|
|
|
57
|
-
|
|
602
|
+
Passed to NODE_ENV of Router and Deployer Lambda functions.
|
|
58
603
|
|
|
59
604
|
---
|
|
60
605
|
|
|
61
|
-
##### `
|
|
606
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.assetNameRoot"></a>
|
|
62
607
|
|
|
63
608
|
- *Type:* `string`
|
|
64
|
-
- *Default:*
|
|
609
|
+
- *Default:* resource names auto assigned
|
|
65
610
|
|
|
66
|
-
|
|
611
|
+
Optional asset name root.
|
|
67
612
|
|
|
68
613
|
---
|
|
69
614
|
|
|
70
|
-
##### `
|
|
615
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.assetNameSuffix"></a>
|
|
71
616
|
|
|
72
617
|
- *Type:* `string`
|
|
73
|
-
- *Default:*
|
|
618
|
+
- *Default:* none
|
|
74
619
|
|
|
75
|
-
|
|
620
|
+
Optional asset name suffix.
|
|
76
621
|
|
|
77
622
|
---
|
|
78
623
|
|
|
79
|
-
##### `certEdge`<sup>
|
|
624
|
+
##### `certEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.certEdge"></a>
|
|
80
625
|
|
|
81
626
|
- *Type:* [`@aws-cdk/aws-certificatemanager.ICertificate`](#@aws-cdk/aws-certificatemanager.ICertificate)
|
|
82
627
|
|
|
@@ -84,7 +629,7 @@ Certificate in US-East-1 for the CloudFront distribution.
|
|
|
84
629
|
|
|
85
630
|
---
|
|
86
631
|
|
|
87
|
-
##### `certOrigin`<sup>
|
|
632
|
+
##### `certOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.certOrigin"></a>
|
|
88
633
|
|
|
89
634
|
- *Type:* [`@aws-cdk/aws-certificatemanager.ICertificate`](#@aws-cdk/aws-certificatemanager.ICertificate)
|
|
90
635
|
|
|
@@ -92,71 +637,48 @@ Certificate in deployed region for the API Gateway.
|
|
|
92
637
|
|
|
93
638
|
---
|
|
94
639
|
|
|
95
|
-
##### `
|
|
96
|
-
|
|
97
|
-
- *Type:* `string`
|
|
98
|
-
|
|
99
|
-
Domain name of the zone for the edge host.
|
|
100
|
-
|
|
101
|
-
Example: 'pwrdrvr.com' for apps.pwrdrvr.com
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
##### `domainNameEdge`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.domainNameEdge"></a>
|
|
640
|
+
##### `domainNameEdge`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.domainNameEdge"></a>
|
|
106
641
|
|
|
107
642
|
- *Type:* `string`
|
|
643
|
+
- *Default:* auto-assigned
|
|
108
644
|
|
|
109
|
-
|
|
645
|
+
Optional custom domain name for the CloudFront distribution.
|
|
110
646
|
|
|
111
647
|
---
|
|
112
648
|
|
|
113
|
-
##### `domainNameOrigin`<sup>
|
|
649
|
+
##### `domainNameOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.domainNameOrigin"></a>
|
|
114
650
|
|
|
115
651
|
- *Type:* `string`
|
|
652
|
+
- *Default:* auto-assigned
|
|
116
653
|
|
|
117
|
-
|
|
654
|
+
Optional custom domain name for the API Gateway HTTPv2 API.
|
|
118
655
|
|
|
119
656
|
---
|
|
120
657
|
|
|
121
|
-
##### `
|
|
658
|
+
##### `r53Zone`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.r53Zone"></a>
|
|
122
659
|
|
|
123
|
-
- *Type:* `
|
|
660
|
+
- *Type:* [`@aws-cdk/aws-route53.IHostedZone`](#@aws-cdk/aws-route53.IHostedZone)
|
|
124
661
|
|
|
125
|
-
|
|
662
|
+
Route53 zone in which to create optional `domainNameEdge` record.
|
|
126
663
|
|
|
127
664
|
---
|
|
128
665
|
|
|
129
|
-
##### `
|
|
130
|
-
|
|
131
|
-
- *Type:* `string`
|
|
132
|
-
|
|
133
|
-
Name of the zone in R53 to add records to.
|
|
134
|
-
|
|
135
|
-
---
|
|
666
|
+
##### `removalPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.removalPolicy"></a>
|
|
136
667
|
|
|
137
|
-
|
|
668
|
+
- *Type:* [`@aws-cdk/core.RemovalPolicy`](#@aws-cdk/core.RemovalPolicy)
|
|
669
|
+
- *Default:* per resource default
|
|
138
670
|
|
|
139
|
-
|
|
671
|
+
RemovalPolicy override for child resources.
|
|
140
672
|
|
|
141
|
-
|
|
673
|
+
Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
|
|
142
674
|
|
|
143
675
|
---
|
|
144
676
|
|
|
145
|
-
##### `
|
|
677
|
+
##### `rootPathPrefix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.rootPathPrefix"></a>
|
|
146
678
|
|
|
147
679
|
- *Type:* `string`
|
|
148
|
-
- *Default:* none
|
|
149
|
-
|
|
150
|
-
Suffix to add to asset names, such as -[env]-pr-[prNum].
|
|
151
680
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
##### `autoDeleteEverything`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsProps.autoDeleteEverything"></a>
|
|
155
|
-
|
|
156
|
-
- *Type:* `boolean`
|
|
157
|
-
- *Default:* false
|
|
158
|
-
|
|
159
|
-
Automatically destroy all assets when stack is deleted.
|
|
681
|
+
Path prefix on the root of the CloudFront distribution.
|
|
160
682
|
|
|
161
683
|
---
|
|
162
684
|
|
|
@@ -233,5 +755,313 @@ fully trusted.
|
|
|
233
755
|
|
|
234
756
|
---
|
|
235
757
|
|
|
758
|
+
### MicroAppsS3Props <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props"></a>
|
|
759
|
+
|
|
760
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
761
|
+
|
|
762
|
+
```typescript
|
|
763
|
+
import { MicroAppsS3Props } from '@pwrdrvr/microapps-cdk'
|
|
764
|
+
|
|
765
|
+
const microAppsS3Props: MicroAppsS3Props = { ... }
|
|
766
|
+
```
|
|
767
|
+
|
|
768
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.assetNameRoot"></a>
|
|
769
|
+
|
|
770
|
+
- *Type:* `string`
|
|
771
|
+
- *Default:* resource names auto assigned
|
|
772
|
+
|
|
773
|
+
Optional asset name root.
|
|
774
|
+
|
|
775
|
+
---
|
|
776
|
+
|
|
777
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.assetNameSuffix"></a>
|
|
778
|
+
|
|
779
|
+
- *Type:* `string`
|
|
780
|
+
- *Default:* none
|
|
781
|
+
|
|
782
|
+
Optional asset name suffix.
|
|
783
|
+
|
|
784
|
+
---
|
|
785
|
+
|
|
786
|
+
##### `bucketAppsName`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.bucketAppsName"></a>
|
|
787
|
+
|
|
788
|
+
- *Type:* `string`
|
|
789
|
+
- *Default:* auto-assigned
|
|
790
|
+
|
|
791
|
+
S3 deployed apps bucket name.
|
|
792
|
+
|
|
793
|
+
---
|
|
794
|
+
|
|
795
|
+
##### `bucketAppsStagingName`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.bucketAppsStagingName"></a>
|
|
796
|
+
|
|
797
|
+
- *Type:* `string`
|
|
798
|
+
- *Default:* auto-assigned
|
|
799
|
+
|
|
800
|
+
S3 staging apps bucket name.
|
|
801
|
+
|
|
802
|
+
---
|
|
803
|
+
|
|
804
|
+
##### `bucketLogsName`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.bucketLogsName"></a>
|
|
805
|
+
|
|
806
|
+
- *Type:* `string`
|
|
807
|
+
- *Default:* auto-assigned
|
|
808
|
+
|
|
809
|
+
S3 logs bucket name.
|
|
810
|
+
|
|
811
|
+
---
|
|
812
|
+
|
|
813
|
+
##### `removalPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsS3Props.removalPolicy"></a>
|
|
814
|
+
|
|
815
|
+
- *Type:* [`@aws-cdk/core.RemovalPolicy`](#@aws-cdk/core.RemovalPolicy)
|
|
816
|
+
- *Default:* per resource default
|
|
817
|
+
|
|
818
|
+
RemovalPolicy override for child resources.
|
|
819
|
+
|
|
820
|
+
Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
|
|
821
|
+
|
|
822
|
+
---
|
|
823
|
+
|
|
824
|
+
### MicroAppsSvcsProps <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps"></a>
|
|
825
|
+
|
|
826
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
827
|
+
|
|
828
|
+
```typescript
|
|
829
|
+
import { MicroAppsSvcsProps } from '@pwrdrvr/microapps-cdk'
|
|
830
|
+
|
|
831
|
+
const microAppsSvcsProps: MicroAppsSvcsProps = { ... }
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
##### `appEnv`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.appEnv"></a>
|
|
835
|
+
|
|
836
|
+
- *Type:* `string`
|
|
837
|
+
|
|
838
|
+
---
|
|
839
|
+
|
|
840
|
+
##### `bucketApps`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.bucketApps"></a>
|
|
841
|
+
|
|
842
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
843
|
+
|
|
844
|
+
S3 bucket for deployed applications.
|
|
845
|
+
|
|
846
|
+
---
|
|
847
|
+
|
|
848
|
+
##### `bucketAppsOAI`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.bucketAppsOAI"></a>
|
|
849
|
+
|
|
850
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.OriginAccessIdentity`](#@aws-cdk/aws-cloudfront.OriginAccessIdentity)
|
|
851
|
+
|
|
852
|
+
CloudFront Origin Access Identity for the deployed applications bucket.
|
|
853
|
+
|
|
854
|
+
---
|
|
855
|
+
|
|
856
|
+
##### `bucketAppsStaging`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.bucketAppsStaging"></a>
|
|
857
|
+
|
|
858
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
859
|
+
|
|
860
|
+
S3 bucket for staged applications (prior to deploy).
|
|
861
|
+
|
|
862
|
+
---
|
|
863
|
+
|
|
864
|
+
##### `httpApi`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.httpApi"></a>
|
|
865
|
+
|
|
866
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.HttpApi`](#@aws-cdk/aws-apigatewayv2.HttpApi)
|
|
867
|
+
|
|
868
|
+
API Gateway v2 HTTP for Router and app.
|
|
869
|
+
|
|
870
|
+
---
|
|
871
|
+
|
|
872
|
+
##### `assetNameRoot`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.assetNameRoot"></a>
|
|
873
|
+
|
|
874
|
+
- *Type:* `string`
|
|
875
|
+
- *Default:* resource names auto assigned
|
|
876
|
+
|
|
877
|
+
Optional asset name root.
|
|
878
|
+
|
|
879
|
+
---
|
|
880
|
+
|
|
881
|
+
##### `assetNameSuffix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.assetNameSuffix"></a>
|
|
882
|
+
|
|
883
|
+
- *Type:* `string`
|
|
884
|
+
- *Default:* none
|
|
885
|
+
|
|
886
|
+
Optional asset name suffix.
|
|
887
|
+
|
|
888
|
+
---
|
|
889
|
+
|
|
890
|
+
##### `removalPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.removalPolicy"></a>
|
|
891
|
+
|
|
892
|
+
- *Type:* [`@aws-cdk/core.RemovalPolicy`](#@aws-cdk/core.RemovalPolicy)
|
|
893
|
+
- *Default:* per resource default
|
|
894
|
+
|
|
895
|
+
RemovalPolicy override for child resources.
|
|
896
|
+
|
|
897
|
+
Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
|
|
898
|
+
|
|
899
|
+
---
|
|
900
|
+
|
|
901
|
+
##### `rootPathPrefix`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.rootPathPrefix"></a>
|
|
902
|
+
|
|
903
|
+
- *Type:* `string`
|
|
904
|
+
- *Default:* none
|
|
905
|
+
|
|
906
|
+
Path prefix on the root of the deployment.
|
|
907
|
+
|
|
908
|
+
---
|
|
909
|
+
|
|
910
|
+
##### `s3PolicyBypassAROAs`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.s3PolicyBypassAROAs"></a>
|
|
911
|
+
|
|
912
|
+
- *Type:* `string`[]
|
|
913
|
+
|
|
914
|
+
---
|
|
915
|
+
|
|
916
|
+
##### `s3PolicyBypassPrincipalARNs`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.s3PolicyBypassPrincipalARNs"></a>
|
|
917
|
+
|
|
918
|
+
- *Type:* `string`[]
|
|
919
|
+
|
|
920
|
+
---
|
|
921
|
+
|
|
922
|
+
##### `s3StrictBucketPolicy`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.MicroAppsSvcsProps.s3StrictBucketPolicy"></a>
|
|
923
|
+
|
|
924
|
+
- *Type:* `boolean`
|
|
925
|
+
|
|
926
|
+
---
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
## Protocols <a name="Protocols"></a>
|
|
930
|
+
|
|
931
|
+
### IMicroApps <a name="@pwrdrvr/microapps-cdk.IMicroApps"></a>
|
|
932
|
+
|
|
933
|
+
- *Implemented By:* [`@pwrdrvr/microapps-cdk.MicroApps`](#@pwrdrvr/microapps-cdk.MicroApps), [`@pwrdrvr/microapps-cdk.IMicroApps`](#@pwrdrvr/microapps-cdk.IMicroApps)
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
#### Properties <a name="Properties"></a>
|
|
937
|
+
|
|
938
|
+
##### `apigwy`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroApps.apigwy"></a>
|
|
939
|
+
|
|
940
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy`](#@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy)
|
|
941
|
+
|
|
942
|
+
---
|
|
943
|
+
|
|
944
|
+
##### `cf`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroApps.cf"></a>
|
|
945
|
+
|
|
946
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsCF`](#@pwrdrvr/microapps-cdk.IMicroAppsCF)
|
|
947
|
+
|
|
948
|
+
---
|
|
949
|
+
|
|
950
|
+
##### `s3`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroApps.s3"></a>
|
|
951
|
+
|
|
952
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsS3`](#@pwrdrvr/microapps-cdk.IMicroAppsS3)
|
|
953
|
+
|
|
954
|
+
---
|
|
955
|
+
|
|
956
|
+
##### `svcs`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroApps.svcs"></a>
|
|
957
|
+
|
|
958
|
+
- *Type:* [`@pwrdrvr/microapps-cdk.IMicroAppsSvcs`](#@pwrdrvr/microapps-cdk.IMicroAppsSvcs)
|
|
959
|
+
|
|
960
|
+
---
|
|
961
|
+
|
|
962
|
+
### IMicroAppsAPIGwy <a name="@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy"></a>
|
|
963
|
+
|
|
964
|
+
- *Implemented By:* [`@pwrdrvr/microapps-cdk.MicroAppsAPIGwy`](#@pwrdrvr/microapps-cdk.MicroAppsAPIGwy), [`@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy`](#@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy)
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
#### Properties <a name="Properties"></a>
|
|
968
|
+
|
|
969
|
+
##### `httpApi`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy.httpApi"></a>
|
|
970
|
+
|
|
971
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.HttpApi`](#@aws-cdk/aws-apigatewayv2.HttpApi)
|
|
972
|
+
|
|
973
|
+
API Gateway.
|
|
974
|
+
|
|
975
|
+
---
|
|
976
|
+
|
|
977
|
+
##### `dnAppsOrigin`<sup>Optional</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsAPIGwy.dnAppsOrigin"></a>
|
|
978
|
+
|
|
979
|
+
- *Type:* [`@aws-cdk/aws-apigatewayv2.IDomainName`](#@aws-cdk/aws-apigatewayv2.IDomainName)
|
|
980
|
+
|
|
981
|
+
Domain Name applied to API Gateway origin.
|
|
982
|
+
|
|
983
|
+
---
|
|
984
|
+
|
|
985
|
+
### IMicroAppsCF <a name="@pwrdrvr/microapps-cdk.IMicroAppsCF"></a>
|
|
986
|
+
|
|
987
|
+
- *Implemented By:* [`@pwrdrvr/microapps-cdk.MicroAppsCF`](#@pwrdrvr/microapps-cdk.MicroAppsCF), [`@pwrdrvr/microapps-cdk.IMicroAppsCF`](#@pwrdrvr/microapps-cdk.IMicroAppsCF)
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
#### Properties <a name="Properties"></a>
|
|
991
|
+
|
|
992
|
+
##### `cloudFrontDistro`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsCF.cloudFrontDistro"></a>
|
|
993
|
+
|
|
994
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.Distribution`](#@aws-cdk/aws-cloudfront.Distribution)
|
|
995
|
+
|
|
996
|
+
---
|
|
997
|
+
|
|
998
|
+
### IMicroAppsS3 <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3"></a>
|
|
999
|
+
|
|
1000
|
+
- *Implemented By:* [`@pwrdrvr/microapps-cdk.MicroAppsS3`](#@pwrdrvr/microapps-cdk.MicroAppsS3), [`@pwrdrvr/microapps-cdk.IMicroAppsS3`](#@pwrdrvr/microapps-cdk.IMicroAppsS3)
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
#### Properties <a name="Properties"></a>
|
|
1004
|
+
|
|
1005
|
+
##### `bucketApps`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3.bucketApps"></a>
|
|
1006
|
+
|
|
1007
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
1008
|
+
|
|
1009
|
+
S3 bucket for deployed applications.
|
|
1010
|
+
|
|
1011
|
+
---
|
|
1012
|
+
|
|
1013
|
+
##### `bucketAppsOAI`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3.bucketAppsOAI"></a>
|
|
236
1014
|
|
|
1015
|
+
- *Type:* [`@aws-cdk/aws-cloudfront.OriginAccessIdentity`](#@aws-cdk/aws-cloudfront.OriginAccessIdentity)
|
|
1016
|
+
|
|
1017
|
+
CloudFront Origin Access Identity for the deployed applications bucket.
|
|
1018
|
+
|
|
1019
|
+
---
|
|
1020
|
+
|
|
1021
|
+
##### `bucketAppsOrigin`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3.bucketAppsOrigin"></a>
|
|
1022
|
+
|
|
1023
|
+
- *Type:* [`@aws-cdk/aws-cloudfront-origins.S3Origin`](#@aws-cdk/aws-cloudfront-origins.S3Origin)
|
|
1024
|
+
|
|
1025
|
+
CloudFront Origin for the deployed applications bucket.
|
|
1026
|
+
|
|
1027
|
+
---
|
|
1028
|
+
|
|
1029
|
+
##### `bucketAppsStaging`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3.bucketAppsStaging"></a>
|
|
1030
|
+
|
|
1031
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
1032
|
+
|
|
1033
|
+
S3 bucket for staged applications (prior to deploy).
|
|
1034
|
+
|
|
1035
|
+
---
|
|
1036
|
+
|
|
1037
|
+
##### `bucketLogs`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsS3.bucketLogs"></a>
|
|
1038
|
+
|
|
1039
|
+
- *Type:* [`@aws-cdk/aws-s3.IBucket`](#@aws-cdk/aws-s3.IBucket)
|
|
1040
|
+
|
|
1041
|
+
S3 bucket for CloudFront logs.
|
|
1042
|
+
|
|
1043
|
+
---
|
|
1044
|
+
|
|
1045
|
+
### IMicroAppsSvcs <a name="@pwrdrvr/microapps-cdk.IMicroAppsSvcs"></a>
|
|
1046
|
+
|
|
1047
|
+
- *Implemented By:* [`@pwrdrvr/microapps-cdk.MicroAppsSvcs`](#@pwrdrvr/microapps-cdk.MicroAppsSvcs), [`@pwrdrvr/microapps-cdk.IMicroAppsSvcs`](#@pwrdrvr/microapps-cdk.IMicroAppsSvcs)
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
#### Properties <a name="Properties"></a>
|
|
1051
|
+
|
|
1052
|
+
##### `deployerFunc`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsSvcs.deployerFunc"></a>
|
|
1053
|
+
|
|
1054
|
+
- *Type:* [`@aws-cdk/aws-lambda.IFunction`](#@aws-cdk/aws-lambda.IFunction)
|
|
1055
|
+
|
|
1056
|
+
Lambda function for the Deployer.
|
|
1057
|
+
|
|
1058
|
+
---
|
|
1059
|
+
|
|
1060
|
+
##### `table`<sup>Required</sup> <a name="@pwrdrvr/microapps-cdk.IMicroAppsSvcs.table"></a>
|
|
1061
|
+
|
|
1062
|
+
- *Type:* [`@aws-cdk/aws-dynamodb.ITable`](#@aws-cdk/aws-dynamodb.ITable)
|
|
1063
|
+
|
|
1064
|
+
DynamoDB table used by Router, Deployer, and Release console app.
|
|
1065
|
+
|
|
1066
|
+
---
|
|
237
1067
|
|