@btc-embedded/cdk-extensions 0.15.0 → 0.17.0

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.
Files changed (46) hide show
  1. package/.jsii +225 -177
  2. package/API.md +175 -140
  3. package/CHANGELOG.md +35 -0
  4. package/lib/constructs/EventPipe.js +1 -1
  5. package/lib/constructs/S3Bucket.js +1 -1
  6. package/lib/constructs/SecureRestApi.js +1 -1
  7. package/lib/constructs/SecureRestApiV2.js +1 -1
  8. package/lib/extensions/ApiGatewayExtension.js +1 -1
  9. package/lib/extensions/ApplicationLoadBalancerExtension.js +1 -1
  10. package/lib/extensions/ApplicationLoadBalancerExtensionV2.js +1 -1
  11. package/lib/extensions/CloudMapExtension.js +1 -1
  12. package/lib/extensions/DeactivatableServiceExtension.js +1 -1
  13. package/lib/extensions/DocumentDbAccessExtension.js +1 -1
  14. package/lib/extensions/DomainEventMessagingExtension.js +1 -1
  15. package/lib/extensions/EfsMountExtension.js +1 -1
  16. package/lib/extensions/ExtraContainerExtension.js +1 -1
  17. package/lib/extensions/HTTPApiExtension.d.ts +9 -2
  18. package/lib/extensions/HTTPApiExtension.js +22 -21
  19. package/lib/extensions/LogExtension.js +1 -1
  20. package/lib/extensions/ModifyContainerDefinitionExtension.js +1 -1
  21. package/lib/extensions/ModifyTaskDefinitionExtension.js +1 -1
  22. package/lib/extensions/OpenTelemetryExtension.js +1 -1
  23. package/lib/extensions/PostgresDbAccessExtension.d.ts +0 -4
  24. package/lib/extensions/PostgresDbAccessExtension.js +4 -3
  25. package/lib/extensions/SharedVolumeExtension.js +1 -1
  26. package/lib/extensions/TcpKeepAliveExtension.js +1 -1
  27. package/lib/platform/ApiGateway.js +1 -1
  28. package/lib/platform/{ApiGatewayV2.d.ts → ApiGatewayVpcLink.d.ts} +13 -13
  29. package/lib/platform/ApiGatewayVpcLink.js +78 -0
  30. package/lib/platform/ApplicationLoadBalancer.js +1 -1
  31. package/lib/platform/ApplicationLoadBalancerV2.d.ts +2 -2
  32. package/lib/platform/ApplicationLoadBalancerV2.js +3 -3
  33. package/lib/platform/BTCLogGroup.js +1 -1
  34. package/lib/platform/CognitoUserPool.d.ts +8 -1
  35. package/lib/platform/CognitoUserPool.js +19 -3
  36. package/lib/platform/DefaultUserPoolClients.js +1 -1
  37. package/lib/platform/DocumentDB.js +2 -2
  38. package/lib/platform/EfsFileSystem.js +1 -1
  39. package/lib/platform/PrivateDnsNamespace.js +1 -1
  40. package/lib/platform/ResourceServer.js +1 -1
  41. package/lib/platform/Vpc.js +1 -1
  42. package/lib/platform/index.d.ts +1 -1
  43. package/lib/platform/index.js +2 -2
  44. package/lib/utils/StackParameter.js +1 -1
  45. package/package.json +1 -1
  46. package/lib/platform/ApiGatewayV2.js +0 -78
package/API.md CHANGED
@@ -128,51 +128,51 @@ The tree node.
128
128
  ---
129
129
 
130
130
 
131
- ### ApiGatewayV2 <a name="ApiGatewayV2" id="@btc-embedded/cdk-extensions.ApiGatewayV2"></a>
131
+ ### ApiGatewayVpcLink <a name="ApiGatewayVpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink"></a>
132
132
 
133
- Constructs an API Gateway V2 resource for use in base platforms.
133
+ Constructs an API Gateway VPC link and an associated security group.
134
+
135
+ This construct is intended to be used once in an AWS account and provides a
136
+ mechanism to set up the security group for access to services deployed in the
137
+ VPC.
134
138
 
135
139
  This construct creates:
136
140
  - A VPC Link for the API Gateway to connect to services within the specified VPC.
137
141
  - A Security Group associated with the VPC Link to control network traffic.
138
142
 
139
- Additionally, the following parameters are exposed as CloudFormation outputs:
140
- - The VPC Link ID.
141
- - The Security Group ID.
142
-
143
143
  These outputs can be utilized by other CDK extensions provided in this library.
144
144
 
145
- #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer"></a>
145
+ #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer"></a>
146
146
 
147
147
  ```typescript
148
- import { ApiGatewayV2 } from '@btc-embedded/cdk-extensions'
148
+ import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
149
149
 
150
- new ApiGatewayV2(scope: Construct, id: string, props: ApiGatewayPropsV2)
150
+ new ApiGatewayVpcLink(scope: Construct, id: string, props: ApiGatewayVpcLinkProps)
151
151
  ```
152
152
 
153
153
  | **Name** | **Type** | **Description** |
154
154
  | --- | --- | --- |
155
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
156
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
157
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayPropsV2">ApiGatewayPropsV2</a></code> | *No description.* |
155
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
156
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
157
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps">ApiGatewayVpcLinkProps</a></code> | *No description.* |
158
158
 
159
159
  ---
160
160
 
161
- ##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.scope"></a>
161
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.scope"></a>
162
162
 
163
163
  - *Type:* constructs.Construct
164
164
 
165
165
  ---
166
166
 
167
- ##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.id"></a>
167
+ ##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.id"></a>
168
168
 
169
169
  - *Type:* string
170
170
 
171
171
  ---
172
172
 
173
- ##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.ApiGatewayV2.Initializer.parameter.props"></a>
173
+ ##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer.parameter.props"></a>
174
174
 
175
- - *Type:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayPropsV2">ApiGatewayPropsV2</a>
175
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps">ApiGatewayVpcLinkProps</a>
176
176
 
177
177
  ---
178
178
 
@@ -180,12 +180,12 @@ new ApiGatewayV2(scope: Construct, id: string, props: ApiGatewayPropsV2)
180
180
 
181
181
  | **Name** | **Description** |
182
182
  | --- | --- |
183
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.toString">toString</a></code> | Returns a string representation of this construct. |
184
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.allowAccessTo">allowAccessTo</a></code> | *No description.* |
183
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.toString">toString</a></code> | Returns a string representation of this construct. |
184
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.allowAccessTo">allowAccessTo</a></code> | *No description.* |
185
185
 
186
186
  ---
187
187
 
188
- ##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApiGatewayV2.toString"></a>
188
+ ##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.toString"></a>
189
189
 
190
190
  ```typescript
191
191
  public toString(): string
@@ -193,25 +193,25 @@ public toString(): string
193
193
 
194
194
  Returns a string representation of this construct.
195
195
 
196
- ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.ApiGatewayV2.allowAccessTo"></a>
196
+ ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.allowAccessTo"></a>
197
197
 
198
198
  ```typescript
199
199
  public allowAccessTo(other: IConnectable, port: number, description?: string): void
200
200
  ```
201
201
 
202
- ###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.ApiGatewayV2.allowAccessTo.parameter.other"></a>
202
+ ###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.allowAccessTo.parameter.other"></a>
203
203
 
204
204
  - *Type:* aws-cdk-lib.aws_ec2.IConnectable
205
205
 
206
206
  ---
207
207
 
208
- ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.ApiGatewayV2.allowAccessTo.parameter.port"></a>
208
+ ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.allowAccessTo.parameter.port"></a>
209
209
 
210
210
  - *Type:* number
211
211
 
212
212
  ---
213
213
 
214
- ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.ApiGatewayV2.allowAccessTo.parameter.description"></a>
214
+ ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.allowAccessTo.parameter.description"></a>
215
215
 
216
216
  - *Type:* string
217
217
 
@@ -221,17 +221,17 @@ public allowAccessTo(other: IConnectable, port: number, description?: string): v
221
221
 
222
222
  | **Name** | **Description** |
223
223
  | --- | --- |
224
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
225
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.fromBasePlatform">fromBasePlatform</a></code> | *No description.* |
224
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
225
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform">fromBasePlatform</a></code> | *No description.* |
226
226
 
227
227
  ---
228
228
 
229
- ##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayV2.isConstruct"></a>
229
+ ##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.isConstruct"></a>
230
230
 
231
231
  ```typescript
232
- import { ApiGatewayV2 } from '@btc-embedded/cdk-extensions'
232
+ import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
233
233
 
234
- ApiGatewayV2.isConstruct(x: any)
234
+ ApiGatewayVpcLink.isConstruct(x: any)
235
235
  ```
236
236
 
237
237
  Checks if `x` is a construct.
@@ -250,7 +250,7 @@ library can be accidentally installed, and `instanceof` will behave
250
250
  unpredictably. It is safest to avoid using `instanceof`, and using
251
251
  this type-testing method instead.
252
252
 
253
- ###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApiGatewayV2.isConstruct.parameter.x"></a>
253
+ ###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.isConstruct.parameter.x"></a>
254
254
 
255
255
  - *Type:* any
256
256
 
@@ -258,29 +258,29 @@ Any object.
258
258
 
259
259
  ---
260
260
 
261
- ##### `fromBasePlatform` <a name="fromBasePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayV2.fromBasePlatform"></a>
261
+ ##### `fromBasePlatform` <a name="fromBasePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform"></a>
262
262
 
263
263
  ```typescript
264
- import { ApiGatewayV2 } from '@btc-embedded/cdk-extensions'
264
+ import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
265
265
 
266
- ApiGatewayV2.fromBasePlatform(scope: Construct, id: string, options: ApiGatewayV2LookupOptions)
266
+ ApiGatewayVpcLink.fromBasePlatform(scope: Construct, id: string, options: ApiGatewayVpcLinkLookupOptions)
267
267
  ```
268
268
 
269
- ###### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayV2.fromBasePlatform.parameter.scope"></a>
269
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform.parameter.scope"></a>
270
270
 
271
271
  - *Type:* constructs.Construct
272
272
 
273
273
  ---
274
274
 
275
- ###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayV2.fromBasePlatform.parameter.id"></a>
275
+ ###### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform.parameter.id"></a>
276
276
 
277
277
  - *Type:* string
278
278
 
279
279
  ---
280
280
 
281
- ###### `options`<sup>Required</sup> <a name="options" id="@btc-embedded/cdk-extensions.ApiGatewayV2.fromBasePlatform.parameter.options"></a>
281
+ ###### `options`<sup>Required</sup> <a name="options" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform.parameter.options"></a>
282
282
 
283
- - *Type:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions">ApiGatewayV2LookupOptions</a>
283
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions">ApiGatewayVpcLinkLookupOptions</a>
284
284
 
285
285
  ---
286
286
 
@@ -288,13 +288,13 @@ ApiGatewayV2.fromBasePlatform(scope: Construct, id: string, options: ApiGatewayV
288
288
 
289
289
  | **Name** | **Type** | **Description** |
290
290
  | --- | --- | --- |
291
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
292
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
293
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
291
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
292
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
293
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
294
294
 
295
295
  ---
296
296
 
297
- ##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApiGatewayV2.property.node"></a>
297
+ ##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.node"></a>
298
298
 
299
299
  ```typescript
300
300
  public readonly node: Node;
@@ -306,7 +306,7 @@ The tree node.
306
306
 
307
307
  ---
308
308
 
309
- ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.ApiGatewayV2.property.securityGroup"></a>
309
+ ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.securityGroup"></a>
310
310
 
311
311
  ```typescript
312
312
  public readonly securityGroup: ISecurityGroup;
@@ -316,7 +316,7 @@ public readonly securityGroup: ISecurityGroup;
316
316
 
317
317
  ---
318
318
 
319
- ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayV2.property.vpcLink"></a>
319
+ ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.property.vpcLink"></a>
320
320
 
321
321
  ```typescript
322
322
  public readonly vpcLink: IVpcLink;
@@ -327,26 +327,26 @@ public readonly vpcLink: IVpcLink;
327
327
  ---
328
328
 
329
329
 
330
- ### ApiGatewayV2Base <a name="ApiGatewayV2Base" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base"></a>
330
+ ### ApiGatewayVpcLinkBase <a name="ApiGatewayVpcLinkBase" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase"></a>
331
331
 
332
- - *Implements:* <a href="#@btc-embedded/cdk-extensions.IApiGatewayV2">IApiGatewayV2</a>
332
+ - *Implements:* <a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink">IApiGatewayVpcLink</a>
333
333
 
334
- #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.Initializer"></a>
334
+ #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer"></a>
335
335
 
336
336
  ```typescript
337
- import { ApiGatewayV2Base } from '@btc-embedded/cdk-extensions'
337
+ import { ApiGatewayVpcLinkBase } from '@btc-embedded/cdk-extensions'
338
338
 
339
- new ApiGatewayV2Base(scope: Construct, id: string)
339
+ new ApiGatewayVpcLinkBase(scope: Construct, id: string)
340
340
  ```
341
341
 
342
342
  | **Name** | **Type** | **Description** |
343
343
  | --- | --- | --- |
344
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | The scope in which to define this construct. |
345
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.Initializer.parameter.id">id</a></code> | <code>string</code> | The scoped construct ID. |
344
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | The scope in which to define this construct. |
345
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer.parameter.id">id</a></code> | <code>string</code> | The scoped construct ID. |
346
346
 
347
347
  ---
348
348
 
349
- ##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.Initializer.parameter.scope"></a>
349
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer.parameter.scope"></a>
350
350
 
351
351
  - *Type:* constructs.Construct
352
352
 
@@ -354,7 +354,7 @@ The scope in which to define this construct.
354
354
 
355
355
  ---
356
356
 
357
- ##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.Initializer.parameter.id"></a>
357
+ ##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer.parameter.id"></a>
358
358
 
359
359
  - *Type:* string
360
360
 
@@ -370,12 +370,12 @@ dash `--`.
370
370
 
371
371
  | **Name** | **Description** |
372
372
  | --- | --- |
373
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.toString">toString</a></code> | Returns a string representation of this construct. |
374
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.allowAccessTo">allowAccessTo</a></code> | *No description.* |
373
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.toString">toString</a></code> | Returns a string representation of this construct. |
374
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.allowAccessTo">allowAccessTo</a></code> | *No description.* |
375
375
 
376
376
  ---
377
377
 
378
- ##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.toString"></a>
378
+ ##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.toString"></a>
379
379
 
380
380
  ```typescript
381
381
  public toString(): string
@@ -383,25 +383,25 @@ public toString(): string
383
383
 
384
384
  Returns a string representation of this construct.
385
385
 
386
- ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.allowAccessTo"></a>
386
+ ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.allowAccessTo"></a>
387
387
 
388
388
  ```typescript
389
389
  public allowAccessTo(other: IConnectable, port: number, description?: string): void
390
390
  ```
391
391
 
392
- ###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.allowAccessTo.parameter.other"></a>
392
+ ###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.allowAccessTo.parameter.other"></a>
393
393
 
394
394
  - *Type:* aws-cdk-lib.aws_ec2.IConnectable
395
395
 
396
396
  ---
397
397
 
398
- ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.allowAccessTo.parameter.port"></a>
398
+ ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.allowAccessTo.parameter.port"></a>
399
399
 
400
400
  - *Type:* number
401
401
 
402
402
  ---
403
403
 
404
- ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.allowAccessTo.parameter.description"></a>
404
+ ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.allowAccessTo.parameter.description"></a>
405
405
 
406
406
  - *Type:* string
407
407
 
@@ -411,16 +411,16 @@ public allowAccessTo(other: IConnectable, port: number, description?: string): v
411
411
 
412
412
  | **Name** | **Description** |
413
413
  | --- | --- |
414
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
414
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
415
415
 
416
416
  ---
417
417
 
418
- ##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.isConstruct"></a>
418
+ ##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.isConstruct"></a>
419
419
 
420
420
  ```typescript
421
- import { ApiGatewayV2Base } from '@btc-embedded/cdk-extensions'
421
+ import { ApiGatewayVpcLinkBase } from '@btc-embedded/cdk-extensions'
422
422
 
423
- ApiGatewayV2Base.isConstruct(x: any)
423
+ ApiGatewayVpcLinkBase.isConstruct(x: any)
424
424
  ```
425
425
 
426
426
  Checks if `x` is a construct.
@@ -439,7 +439,7 @@ library can be accidentally installed, and `instanceof` will behave
439
439
  unpredictably. It is safest to avoid using `instanceof`, and using
440
440
  this type-testing method instead.
441
441
 
442
- ###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.isConstruct.parameter.x"></a>
442
+ ###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.isConstruct.parameter.x"></a>
443
443
 
444
444
  - *Type:* any
445
445
 
@@ -451,13 +451,13 @@ Any object.
451
451
 
452
452
  | **Name** | **Type** | **Description** |
453
453
  | --- | --- | --- |
454
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
455
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
456
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
454
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
455
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
456
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
457
457
 
458
458
  ---
459
459
 
460
- ##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.node"></a>
460
+ ##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.node"></a>
461
461
 
462
462
  ```typescript
463
463
  public readonly node: Node;
@@ -469,7 +469,7 @@ The tree node.
469
469
 
470
470
  ---
471
471
 
472
- ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.securityGroup"></a>
472
+ ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.securityGroup"></a>
473
473
 
474
474
  ```typescript
475
475
  public readonly securityGroup: ISecurityGroup;
@@ -479,7 +479,7 @@ public readonly securityGroup: ISecurityGroup;
479
479
 
480
480
  ---
481
481
 
482
- ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayV2Base.property.vpcLink"></a>
482
+ ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.property.vpcLink"></a>
483
483
 
484
484
  ```typescript
485
485
  public readonly vpcLink: IVpcLink;
@@ -1674,6 +1674,7 @@ CognitoUserPool.fromBasePlatform(scope: Construct, id: string, basePlatform: str
1674
1674
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.apiUserPoolClient">apiUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1675
1675
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.appUserPoolClient">appUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1676
1676
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
1677
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.userPoolDomain">userPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | *No description.* |
1677
1678
 
1678
1679
  ---
1679
1680
 
@@ -1719,6 +1720,16 @@ public readonly userPool: IUserPool;
1719
1720
 
1720
1721
  ---
1721
1722
 
1723
+ ##### `userPoolDomain`<sup>Required</sup> <a name="userPoolDomain" id="@btc-embedded/cdk-extensions.CognitoUserPool.property.userPoolDomain"></a>
1724
+
1725
+ ```typescript
1726
+ public readonly userPoolDomain: IUserPoolDomain;
1727
+ ```
1728
+
1729
+ - *Type:* aws-cdk-lib.aws_cognito.IUserPoolDomain
1730
+
1731
+ ---
1732
+
1722
1733
 
1723
1734
  ### CognitoUserPoolBase <a name="CognitoUserPoolBase" id="@btc-embedded/cdk-extensions.CognitoUserPoolBase"></a>
1724
1735
 
@@ -4749,85 +4760,85 @@ If provided then enable the access logs for the API Gateway.
4749
4760
 
4750
4761
  ---
4751
4762
 
4752
- ### ApiGatewayPropsV2 <a name="ApiGatewayPropsV2" id="@btc-embedded/cdk-extensions.ApiGatewayPropsV2"></a>
4763
+ ### ApiGatewayVpcLinkLookupOptions <a name="ApiGatewayVpcLinkLookupOptions" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions"></a>
4753
4764
 
4754
- #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayPropsV2.Initializer"></a>
4765
+ #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.Initializer"></a>
4755
4766
 
4756
4767
  ```typescript
4757
- import { ApiGatewayPropsV2 } from '@btc-embedded/cdk-extensions'
4768
+ import { ApiGatewayVpcLinkLookupOptions } from '@btc-embedded/cdk-extensions'
4758
4769
 
4759
- const apiGatewayPropsV2: ApiGatewayPropsV2 = { ... }
4770
+ const apiGatewayVpcLinkLookupOptions: ApiGatewayVpcLinkLookupOptions = { ... }
4760
4771
  ```
4761
4772
 
4762
4773
  #### Properties <a name="Properties" id="Properties"></a>
4763
4774
 
4764
4775
  | **Name** | **Type** | **Description** |
4765
4776
  | --- | --- | --- |
4766
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayPropsV2.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC where the API GW Security group and VPC Link will be created. |
4767
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayPropsV2.property.vpcLinkName">vpcLinkName</a></code> | <code>string</code> | Optional name for the VPC Link. |
4777
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.basePlatform">basePlatform</a></code> | <code>string</code> | *No description.* |
4778
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
4768
4779
 
4769
4780
  ---
4770
4781
 
4771
- ##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayPropsV2.property.vpc"></a>
4782
+ ##### `basePlatform`<sup>Required</sup> <a name="basePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.basePlatform"></a>
4772
4783
 
4773
4784
  ```typescript
4774
- public readonly vpc: IVpc;
4785
+ public readonly basePlatform: string;
4775
4786
  ```
4776
4787
 
4777
- - *Type:* aws-cdk-lib.aws_ec2.IVpc
4778
-
4779
- VPC where the API GW Security group and VPC Link will be created.
4788
+ - *Type:* string
4780
4789
 
4781
4790
  ---
4782
4791
 
4783
- ##### `vpcLinkName`<sup>Optional</sup> <a name="vpcLinkName" id="@btc-embedded/cdk-extensions.ApiGatewayPropsV2.property.vpcLinkName"></a>
4792
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.vpc"></a>
4784
4793
 
4785
4794
  ```typescript
4786
- public readonly vpcLinkName: string;
4795
+ public readonly vpc: IVpc;
4787
4796
  ```
4788
4797
 
4789
- - *Type:* string
4790
-
4791
- Optional name for the VPC Link.
4798
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
4792
4799
 
4793
4800
  ---
4794
4801
 
4795
- ### ApiGatewayV2LookupOptions <a name="ApiGatewayV2LookupOptions" id="@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions"></a>
4802
+ ### ApiGatewayVpcLinkProps <a name="ApiGatewayVpcLinkProps" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps"></a>
4796
4803
 
4797
- #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions.Initializer"></a>
4804
+ #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.Initializer"></a>
4798
4805
 
4799
4806
  ```typescript
4800
- import { ApiGatewayV2LookupOptions } from '@btc-embedded/cdk-extensions'
4807
+ import { ApiGatewayVpcLinkProps } from '@btc-embedded/cdk-extensions'
4801
4808
 
4802
- const apiGatewayV2LookupOptions: ApiGatewayV2LookupOptions = { ... }
4809
+ const apiGatewayVpcLinkProps: ApiGatewayVpcLinkProps = { ... }
4803
4810
  ```
4804
4811
 
4805
4812
  #### Properties <a name="Properties" id="Properties"></a>
4806
4813
 
4807
4814
  | **Name** | **Type** | **Description** |
4808
4815
  | --- | --- | --- |
4809
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions.property.basePlatform">basePlatform</a></code> | <code>string</code> | *No description.* |
4810
- | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
4816
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC where the API GW Security group and VPC Link will be created. |
4817
+ | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpcLinkName">vpcLinkName</a></code> | <code>string</code> | Optional name for the VPC Link. |
4811
4818
 
4812
4819
  ---
4813
4820
 
4814
- ##### `basePlatform`<sup>Required</sup> <a name="basePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions.property.basePlatform"></a>
4821
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpc"></a>
4815
4822
 
4816
4823
  ```typescript
4817
- public readonly basePlatform: string;
4824
+ public readonly vpc: IVpc;
4818
4825
  ```
4819
4826
 
4820
- - *Type:* string
4827
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
4828
+
4829
+ VPC where the API GW Security group and VPC Link will be created.
4821
4830
 
4822
4831
  ---
4823
4832
 
4824
- ##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayV2LookupOptions.property.vpc"></a>
4833
+ ##### `vpcLinkName`<sup>Optional</sup> <a name="vpcLinkName" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpcLinkName"></a>
4825
4834
 
4826
4835
  ```typescript
4827
- public readonly vpc: IVpc;
4836
+ public readonly vpcLinkName: string;
4828
4837
  ```
4829
4838
 
4830
- - *Type:* aws-cdk-lib.aws_ec2.IVpc
4839
+ - *Type:* string
4840
+
4841
+ Optional name for the VPC Link.
4831
4842
 
4832
4843
  ---
4833
4844
 
@@ -5098,7 +5109,7 @@ const applicationLoadBalancerPropsV2: ApplicationLoadBalancerPropsV2 = { ... }
5098
5109
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.healtCheckPath">healtCheckPath</a></code> | <code>string</code> | The health check path for the target group. |
5099
5110
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.hostedZone">hostedZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | The Route 53 hosted zone where the ALB's DNS record will be created. |
5100
5111
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.trafficPort">trafficPort</a></code> | <code>number</code> | The port on which the target group will receive traffic. |
5101
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.userPool">userPool</a></code> | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool">CognitoUserPool</a></code> | The Cognito User Pool of this base platform. |
5112
+ | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.userPool">userPool</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a></code> | The Cognito User Pool of this base platform. |
5102
5113
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.userPoolDomain">userPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | The Cognito User Pool Domain used for authentication. |
5103
5114
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC in which the Application Load Balancer will be deployed. |
5104
5115
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.additionalCallbackUrls">additionalCallbackUrls</a></code> | <code>string[]</code> | Additional callback URLs to be added to the Cognito User Pool Client. |
@@ -5158,10 +5169,10 @@ The port on which the target group will receive traffic.
5158
5169
  ##### `userPool`<sup>Required</sup> <a name="userPool" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerPropsV2.property.userPool"></a>
5159
5170
 
5160
5171
  ```typescript
5161
- public readonly userPool: CognitoUserPool;
5172
+ public readonly userPool: ICognitoUserPool;
5162
5173
  ```
5163
5174
 
5164
- - *Type:* <a href="#@btc-embedded/cdk-extensions.CognitoUserPool">CognitoUserPool</a>
5175
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a>
5165
5176
 
5166
5177
  The Cognito User Pool of this base platform.
5167
5178
 
@@ -5440,11 +5451,13 @@ const cognitoUserPoolProps: CognitoUserPoolProps = { ... }
5440
5451
  | **Name** | **Type** | **Description** |
5441
5452
  | --- | --- | --- |
5442
5453
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.fqdn">fqdn</a></code> | <code>string</code> | The fully qualified domain name which the ALB will listen to. |
5454
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.userPoolDomain">userPoolDomain</a></code> | <code>string</code> | *No description.* |
5443
5455
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.userPoolId">userPoolId</a></code> | <code>string</code> | The ID of the Cognito User Pool to be imported. |
5444
5456
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.additionalUserPoolIdentityProviders">additionalUserPoolIdentityProviders</a></code> | <code>string[]</code> | Specify additional user pool identity providers to enable federated login. |
5445
5457
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.apiClientOptions">apiClientOptions</a></code> | <code>aws-cdk-lib.aws_cognito.UserPoolClientOptions</code> | Client options for the API client, extending and overwriting the defaults. |
5446
5458
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.appClientOptions">appClientOptions</a></code> | <code>aws-cdk-lib.aws_cognito.UserPoolClientOptions</code> | Client options for the app client, extending and overwriting the defaults. |
5447
5459
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.callbackUrls">callbackUrls</a></code> | <code>string[]</code> | Specify additional callback URLs which the frontend uses for OIDC authentication. |
5460
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.createManagedLoginBranding">createManagedLoginBranding</a></code> | <code>boolean</code> | Enable creation of managed login branding for the user pool. |
5448
5461
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.logoutUrls">logoutUrls</a></code> | <code>string[]</code> | Specify valid logout URLs which should be added to the frontend user pool client. |
5449
5462
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.resourceServer">resourceServer</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ResourceServer">ResourceServer</a></code> | The resource server associated with the user pool client. |
5450
5463
 
@@ -5465,6 +5478,16 @@ client such that the ALB can perform authentication.
5465
5478
 
5466
5479
  ---
5467
5480
 
5481
+ ##### `userPoolDomain`<sup>Required</sup> <a name="userPoolDomain" id="@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.userPoolDomain"></a>
5482
+
5483
+ ```typescript
5484
+ public readonly userPoolDomain: string;
5485
+ ```
5486
+
5487
+ - *Type:* string
5488
+
5489
+ ---
5490
+
5468
5491
  ##### `userPoolId`<sup>Required</sup> <a name="userPoolId" id="@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.userPoolId"></a>
5469
5492
 
5470
5493
  ```typescript
@@ -5525,6 +5548,18 @@ Specify additional callback URLs which the frontend uses for OIDC authentication
5525
5548
 
5526
5549
  ---
5527
5550
 
5551
+ ##### `createManagedLoginBranding`<sup>Optional</sup> <a name="createManagedLoginBranding" id="@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.createManagedLoginBranding"></a>
5552
+
5553
+ ```typescript
5554
+ public readonly createManagedLoginBranding: boolean;
5555
+ ```
5556
+
5557
+ - *Type:* boolean
5558
+
5559
+ Enable creation of managed login branding for the user pool.
5560
+
5561
+ ---
5562
+
5528
5563
  ##### `logoutUrls`<sup>Optional</sup> <a name="logoutUrls" id="@btc-embedded/cdk-extensions.CognitoUserPoolProps.property.logoutUrls"></a>
5529
5564
 
5530
5565
  ```typescript
@@ -7597,47 +7632,48 @@ const hTTPApiExtensionProps: HTTPApiExtensionProps = { ... }
7597
7632
 
7598
7633
  | **Name** | **Type** | **Description** |
7599
7634
  | --- | --- | --- |
7600
- | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix">domainPrefix</a></code> | <code>string</code> | Domain prefix for the API Gateway endpoint. |
7601
7635
  | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.hostedZone">hostedZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | Hosted Zone to create the gateway domain A record. |
7602
7636
  | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.platformStackName">platformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
7637
+ | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix">domainPrefix</a></code> | <code>string</code> | Domain prefix for the API Gateway endpoint. |
7603
7638
  | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.enableAccessLogs">enableAccessLogs</a></code> | <code>boolean</code> | Enable access logs for the API Gateway. |
7604
- | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.prefix">prefix</a></code> | <code>string</code> | The prefix for the API Gateway endpoint. |
7639
+ | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.endpointPrefix">endpointPrefix</a></code> | <code>string</code> | The prefix for the API Gateway endpoint. |
7640
+ | <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.extraHttpApiAttributes">extraHttpApiAttributes</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.HttpApiAttributes</code> | Specify additional HTTP API Attributes. |
7605
7641
 
7606
7642
  ---
7607
7643
 
7608
- ##### `domainPrefix`<sup>Required</sup> <a name="domainPrefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix"></a>
7644
+ ##### `hostedZone`<sup>Required</sup> <a name="hostedZone" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.hostedZone"></a>
7609
7645
 
7610
7646
  ```typescript
7611
- public readonly domainPrefix: string;
7647
+ public readonly hostedZone: IHostedZone;
7612
7648
  ```
7613
7649
 
7614
- - *Type:* string
7650
+ - *Type:* aws-cdk-lib.aws_route53.IHostedZone
7615
7651
 
7616
- Domain prefix for the API Gateway endpoint.
7652
+ Hosted Zone to create the gateway domain A record.
7617
7653
 
7618
7654
  ---
7619
7655
 
7620
- ##### `hostedZone`<sup>Required</sup> <a name="hostedZone" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.hostedZone"></a>
7656
+ ##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.platformStackName"></a>
7621
7657
 
7622
7658
  ```typescript
7623
- public readonly hostedZone: IHostedZone;
7659
+ public readonly platformStackName: string;
7624
7660
  ```
7625
7661
 
7626
- - *Type:* aws-cdk-lib.aws_route53.IHostedZone
7662
+ - *Type:* string
7627
7663
 
7628
- Hosted Zone to create the gateway domain A record.
7664
+ The name of the base platform stack.
7629
7665
 
7630
7666
  ---
7631
7667
 
7632
- ##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.platformStackName"></a>
7668
+ ##### `domainPrefix`<sup>Optional</sup> <a name="domainPrefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix"></a>
7633
7669
 
7634
7670
  ```typescript
7635
- public readonly platformStackName: string;
7671
+ public readonly domainPrefix: string;
7636
7672
  ```
7637
7673
 
7638
7674
  - *Type:* string
7639
7675
 
7640
- The name of the base platform stack.
7676
+ Domain prefix for the API Gateway endpoint.
7641
7677
 
7642
7678
  ---
7643
7679
 
@@ -7655,10 +7691,10 @@ default: true
7655
7691
 
7656
7692
  ---
7657
7693
 
7658
- ##### `prefix`<sup>Optional</sup> <a name="prefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.prefix"></a>
7694
+ ##### `endpointPrefix`<sup>Optional</sup> <a name="endpointPrefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.endpointPrefix"></a>
7659
7695
 
7660
7696
  ```typescript
7661
- public readonly prefix: string;
7697
+ public readonly endpointPrefix: string;
7662
7698
  ```
7663
7699
 
7664
7700
  - *Type:* string
@@ -7667,6 +7703,18 @@ The prefix for the API Gateway endpoint.
7667
7703
 
7668
7704
  ---
7669
7705
 
7706
+ ##### `extraHttpApiAttributes`<sup>Optional</sup> <a name="extraHttpApiAttributes" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.extraHttpApiAttributes"></a>
7707
+
7708
+ ```typescript
7709
+ public readonly extraHttpApiAttributes: HttpApiAttributes;
7710
+ ```
7711
+
7712
+ - *Type:* aws-cdk-lib.aws_apigatewayv2.HttpApiAttributes
7713
+
7714
+ Specify additional HTTP API Attributes.
7715
+
7716
+ ---
7717
+
7670
7718
  ### ImportLogGroupOption <a name="ImportLogGroupOption" id="@btc-embedded/cdk-extensions.ImportLogGroupOption"></a>
7671
7719
 
7672
7720
  #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ImportLogGroupOption.Initializer"></a>
@@ -7798,7 +7846,6 @@ const postgresDbAccessExtensionProps: PostgresDbAccessExtensionProps = { ... }
7798
7846
  | --- | --- | --- |
7799
7847
  | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.basePlatformStackName">basePlatformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
7800
7848
  | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.dbName">dbName</a></code> | <code>string</code> | The name of the database. |
7801
- | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.securityGroupId">securityGroupId</a></code> | <code>string</code> | Security group ID of the Postgres DB cluster. |
7802
7849
  | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.dbConnectionProperties">dbConnectionProperties</a></code> | <code>{[ key: string ]: string}</code> | Additional connection properties to be added to the database connection string as query parameters. |
7803
7850
  | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.enableMigration">enableMigration</a></code> | <code>boolean</code> | Enable database migration by calling the default image with the migration parameter. |
7804
7851
  | <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.environmentVariableNames">environmentVariableNames</a></code> | <code><a href="#@btc-embedded/cdk-extensions.EnvironmentVariableNames">EnvironmentVariableNames</a></code> | Adjust the environment variables. |
@@ -7834,18 +7881,6 @@ The name of the database.
7834
7881
 
7835
7882
  ---
7836
7883
 
7837
- ##### `securityGroupId`<sup>Required</sup> <a name="securityGroupId" id="@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.securityGroupId"></a>
7838
-
7839
- ```typescript
7840
- public readonly securityGroupId: string;
7841
- ```
7842
-
7843
- - *Type:* string
7844
-
7845
- Security group ID of the Postgres DB cluster.
7846
-
7847
- ---
7848
-
7849
7884
  ##### `dbConnectionProperties`<sup>Optional</sup> <a name="dbConnectionProperties" id="@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.dbConnectionProperties"></a>
7850
7885
 
7851
7886
  ```typescript
@@ -13150,37 +13185,37 @@ public readonly props: TcpKeepAliveExtensionProps;
13150
13185
 
13151
13186
  ## Protocols <a name="Protocols" id="Protocols"></a>
13152
13187
 
13153
- ### IApiGatewayV2 <a name="IApiGatewayV2" id="@btc-embedded/cdk-extensions.IApiGatewayV2"></a>
13188
+ ### IApiGatewayVpcLink <a name="IApiGatewayVpcLink" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink"></a>
13154
13189
 
13155
- - *Implemented By:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayV2">ApiGatewayV2</a>, <a href="#@btc-embedded/cdk-extensions.ApiGatewayV2Base">ApiGatewayV2Base</a>, <a href="#@btc-embedded/cdk-extensions.IApiGatewayV2">IApiGatewayV2</a>
13190
+ - *Implemented By:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLink">ApiGatewayVpcLink</a>, <a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase">ApiGatewayVpcLinkBase</a>, <a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink">IApiGatewayVpcLink</a>
13156
13191
 
13157
13192
  #### Methods <a name="Methods" id="Methods"></a>
13158
13193
 
13159
13194
  | **Name** | **Description** |
13160
13195
  | --- | --- |
13161
- | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayV2.allowAccessTo">allowAccessTo</a></code> | *No description.* |
13196
+ | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo">allowAccessTo</a></code> | *No description.* |
13162
13197
 
13163
13198
  ---
13164
13199
 
13165
- ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.IApiGatewayV2.allowAccessTo"></a>
13200
+ ##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo"></a>
13166
13201
 
13167
13202
  ```typescript
13168
- public allowAccessTo(source: IConnectable, port: number, description?: string): void
13203
+ public allowAccessTo(other: IConnectable, port: number, description?: string): void
13169
13204
  ```
13170
13205
 
13171
- ###### `source`<sup>Required</sup> <a name="source" id="@btc-embedded/cdk-extensions.IApiGatewayV2.allowAccessTo.parameter.source"></a>
13206
+ ###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.other"></a>
13172
13207
 
13173
13208
  - *Type:* aws-cdk-lib.aws_ec2.IConnectable
13174
13209
 
13175
13210
  ---
13176
13211
 
13177
- ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.IApiGatewayV2.allowAccessTo.parameter.port"></a>
13212
+ ###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.port"></a>
13178
13213
 
13179
13214
  - *Type:* number
13180
13215
 
13181
13216
  ---
13182
13217
 
13183
- ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.IApiGatewayV2.allowAccessTo.parameter.description"></a>
13218
+ ###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.description"></a>
13184
13219
 
13185
13220
  - *Type:* string
13186
13221
 
@@ -13190,12 +13225,12 @@ public allowAccessTo(source: IConnectable, port: number, description?: string):
13190
13225
 
13191
13226
  | **Name** | **Type** | **Description** |
13192
13227
  | --- | --- | --- |
13193
- | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayV2.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
13194
- | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayV2.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
13228
+ | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
13229
+ | <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
13195
13230
 
13196
13231
  ---
13197
13232
 
13198
- ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.IApiGatewayV2.property.securityGroup"></a>
13233
+ ##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.securityGroup"></a>
13199
13234
 
13200
13235
  ```typescript
13201
13236
  public readonly securityGroup: ISecurityGroup;
@@ -13205,7 +13240,7 @@ public readonly securityGroup: ISecurityGroup;
13205
13240
 
13206
13241
  ---
13207
13242
 
13208
- ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.IApiGatewayV2.property.vpcLink"></a>
13243
+ ##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.vpcLink"></a>
13209
13244
 
13210
13245
  ```typescript
13211
13246
  public readonly vpcLink: IVpcLink;