@btc-embedded/cdk-extensions 0.15.0 → 0.16.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.
- package/.jsii +151 -149
- package/API.md +137 -137
- package/CHANGELOG.md +16 -0
- package/lib/constructs/EventPipe.js +1 -1
- package/lib/constructs/S3Bucket.js +1 -1
- package/lib/constructs/SecureRestApi.js +1 -1
- package/lib/constructs/SecureRestApiV2.js +1 -1
- package/lib/extensions/ApiGatewayExtension.js +1 -1
- package/lib/extensions/ApplicationLoadBalancerExtension.js +1 -1
- package/lib/extensions/ApplicationLoadBalancerExtensionV2.js +1 -1
- package/lib/extensions/CloudMapExtension.js +1 -1
- package/lib/extensions/DeactivatableServiceExtension.js +1 -1
- package/lib/extensions/DocumentDbAccessExtension.js +1 -1
- package/lib/extensions/DomainEventMessagingExtension.js +1 -1
- package/lib/extensions/EfsMountExtension.js +1 -1
- package/lib/extensions/ExtraContainerExtension.js +1 -1
- package/lib/extensions/HTTPApiExtension.d.ts +9 -2
- package/lib/extensions/HTTPApiExtension.js +22 -21
- package/lib/extensions/LogExtension.js +1 -1
- package/lib/extensions/ModifyContainerDefinitionExtension.js +1 -1
- package/lib/extensions/ModifyTaskDefinitionExtension.js +1 -1
- package/lib/extensions/OpenTelemetryExtension.js +1 -1
- package/lib/extensions/PostgresDbAccessExtension.d.ts +0 -4
- package/lib/extensions/PostgresDbAccessExtension.js +4 -3
- package/lib/extensions/SharedVolumeExtension.js +1 -1
- package/lib/extensions/TcpKeepAliveExtension.js +1 -1
- package/lib/platform/ApiGateway.js +1 -1
- package/lib/platform/{ApiGatewayV2.d.ts → ApiGatewayVpcLink.d.ts} +13 -13
- package/lib/platform/ApiGatewayVpcLink.js +78 -0
- package/lib/platform/ApplicationLoadBalancer.js +1 -1
- package/lib/platform/ApplicationLoadBalancerV2.js +2 -2
- package/lib/platform/BTCLogGroup.js +1 -1
- package/lib/platform/CognitoUserPool.js +2 -2
- package/lib/platform/DefaultUserPoolClients.js +1 -1
- package/lib/platform/DocumentDB.js +2 -2
- package/lib/platform/EfsFileSystem.js +1 -1
- package/lib/platform/PrivateDnsNamespace.js +1 -1
- package/lib/platform/ResourceServer.js +1 -1
- package/lib/platform/Vpc.js +1 -1
- package/lib/platform/index.d.ts +1 -1
- package/lib/platform/index.js +2 -2
- package/lib/utils/StackParameter.js +1 -1
- package/package.json +1 -1
- 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
|
-
###
|
|
131
|
+
### ApiGatewayVpcLink <a name="ApiGatewayVpcLink" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink"></a>
|
|
132
132
|
|
|
133
|
-
Constructs an API Gateway
|
|
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.
|
|
145
|
+
#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.Initializer"></a>
|
|
146
146
|
|
|
147
147
|
```typescript
|
|
148
|
-
import {
|
|
148
|
+
import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
|
|
149
149
|
|
|
150
|
-
new
|
|
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.
|
|
156
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
157
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
184
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
225
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
229
|
+
##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.isConstruct"></a>
|
|
230
230
|
|
|
231
231
|
```typescript
|
|
232
|
-
import {
|
|
232
|
+
import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
|
|
233
233
|
|
|
234
|
-
|
|
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.
|
|
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.
|
|
261
|
+
##### `fromBasePlatform` <a name="fromBasePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLink.fromBasePlatform"></a>
|
|
262
262
|
|
|
263
263
|
```typescript
|
|
264
|
-
import {
|
|
264
|
+
import { ApiGatewayVpcLink } from '@btc-embedded/cdk-extensions'
|
|
265
265
|
|
|
266
|
-
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
292
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
293
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
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
|
-
###
|
|
330
|
+
### ApiGatewayVpcLinkBase <a name="ApiGatewayVpcLinkBase" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase"></a>
|
|
331
331
|
|
|
332
|
-
- *Implements:* <a href="#@btc-embedded/cdk-extensions.
|
|
332
|
+
- *Implements:* <a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink">IApiGatewayVpcLink</a>
|
|
333
333
|
|
|
334
|
-
#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.
|
|
334
|
+
#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.Initializer"></a>
|
|
335
335
|
|
|
336
336
|
```typescript
|
|
337
|
-
import {
|
|
337
|
+
import { ApiGatewayVpcLinkBase } from '@btc-embedded/cdk-extensions'
|
|
338
338
|
|
|
339
|
-
new
|
|
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.
|
|
345
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
374
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
418
|
+
##### `isConstruct` <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkBase.isConstruct"></a>
|
|
419
419
|
|
|
420
420
|
```typescript
|
|
421
|
-
import {
|
|
421
|
+
import { ApiGatewayVpcLinkBase } from '@btc-embedded/cdk-extensions'
|
|
422
422
|
|
|
423
|
-
|
|
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.
|
|
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.
|
|
455
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
456
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
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.
|
|
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.
|
|
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.
|
|
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;
|
|
@@ -4749,85 +4749,85 @@ If provided then enable the access logs for the API Gateway.
|
|
|
4749
4749
|
|
|
4750
4750
|
---
|
|
4751
4751
|
|
|
4752
|
-
###
|
|
4752
|
+
### ApiGatewayVpcLinkLookupOptions <a name="ApiGatewayVpcLinkLookupOptions" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions"></a>
|
|
4753
4753
|
|
|
4754
|
-
#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.
|
|
4754
|
+
#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.Initializer"></a>
|
|
4755
4755
|
|
|
4756
4756
|
```typescript
|
|
4757
|
-
import {
|
|
4757
|
+
import { ApiGatewayVpcLinkLookupOptions } from '@btc-embedded/cdk-extensions'
|
|
4758
4758
|
|
|
4759
|
-
const
|
|
4759
|
+
const apiGatewayVpcLinkLookupOptions: ApiGatewayVpcLinkLookupOptions = { ... }
|
|
4760
4760
|
```
|
|
4761
4761
|
|
|
4762
4762
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
4763
4763
|
|
|
4764
4764
|
| **Name** | **Type** | **Description** |
|
|
4765
4765
|
| --- | --- | --- |
|
|
4766
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
4767
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
4766
|
+
| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.basePlatform">basePlatform</a></code> | <code>string</code> | *No description.* |
|
|
4767
|
+
| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
|
|
4768
4768
|
|
|
4769
4769
|
---
|
|
4770
4770
|
|
|
4771
|
-
##### `
|
|
4771
|
+
##### `basePlatform`<sup>Required</sup> <a name="basePlatform" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.basePlatform"></a>
|
|
4772
4772
|
|
|
4773
4773
|
```typescript
|
|
4774
|
-
public readonly
|
|
4774
|
+
public readonly basePlatform: string;
|
|
4775
4775
|
```
|
|
4776
4776
|
|
|
4777
|
-
- *Type:*
|
|
4778
|
-
|
|
4779
|
-
VPC where the API GW Security group and VPC Link will be created.
|
|
4777
|
+
- *Type:* string
|
|
4780
4778
|
|
|
4781
4779
|
---
|
|
4782
4780
|
|
|
4783
|
-
##### `
|
|
4781
|
+
##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkLookupOptions.property.vpc"></a>
|
|
4784
4782
|
|
|
4785
4783
|
```typescript
|
|
4786
|
-
public readonly
|
|
4784
|
+
public readonly vpc: IVpc;
|
|
4787
4785
|
```
|
|
4788
4786
|
|
|
4789
|
-
- *Type:*
|
|
4790
|
-
|
|
4791
|
-
Optional name for the VPC Link.
|
|
4787
|
+
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
4792
4788
|
|
|
4793
4789
|
---
|
|
4794
4790
|
|
|
4795
|
-
###
|
|
4791
|
+
### ApiGatewayVpcLinkProps <a name="ApiGatewayVpcLinkProps" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps"></a>
|
|
4796
4792
|
|
|
4797
|
-
#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.
|
|
4793
|
+
#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.Initializer"></a>
|
|
4798
4794
|
|
|
4799
4795
|
```typescript
|
|
4800
|
-
import {
|
|
4796
|
+
import { ApiGatewayVpcLinkProps } from '@btc-embedded/cdk-extensions'
|
|
4801
4797
|
|
|
4802
|
-
const
|
|
4798
|
+
const apiGatewayVpcLinkProps: ApiGatewayVpcLinkProps = { ... }
|
|
4803
4799
|
```
|
|
4804
4800
|
|
|
4805
4801
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
4806
4802
|
|
|
4807
4803
|
| **Name** | **Type** | **Description** |
|
|
4808
4804
|
| --- | --- | --- |
|
|
4809
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
4810
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
4805
|
+
| <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. |
|
|
4806
|
+
| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpcLinkName">vpcLinkName</a></code> | <code>string</code> | Optional name for the VPC Link. |
|
|
4811
4807
|
|
|
4812
4808
|
---
|
|
4813
4809
|
|
|
4814
|
-
##### `
|
|
4810
|
+
##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpc"></a>
|
|
4815
4811
|
|
|
4816
4812
|
```typescript
|
|
4817
|
-
public readonly
|
|
4813
|
+
public readonly vpc: IVpc;
|
|
4818
4814
|
```
|
|
4819
4815
|
|
|
4820
|
-
- *Type:*
|
|
4816
|
+
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
4817
|
+
|
|
4818
|
+
VPC where the API GW Security group and VPC Link will be created.
|
|
4821
4819
|
|
|
4822
4820
|
---
|
|
4823
4821
|
|
|
4824
|
-
##### `
|
|
4822
|
+
##### `vpcLinkName`<sup>Optional</sup> <a name="vpcLinkName" id="@btc-embedded/cdk-extensions.ApiGatewayVpcLinkProps.property.vpcLinkName"></a>
|
|
4825
4823
|
|
|
4826
4824
|
```typescript
|
|
4827
|
-
public readonly
|
|
4825
|
+
public readonly vpcLinkName: string;
|
|
4828
4826
|
```
|
|
4829
4827
|
|
|
4830
|
-
- *Type:*
|
|
4828
|
+
- *Type:* string
|
|
4829
|
+
|
|
4830
|
+
Optional name for the VPC Link.
|
|
4831
4831
|
|
|
4832
4832
|
---
|
|
4833
4833
|
|
|
@@ -7597,47 +7597,48 @@ const hTTPApiExtensionProps: HTTPApiExtensionProps = { ... }
|
|
|
7597
7597
|
|
|
7598
7598
|
| **Name** | **Type** | **Description** |
|
|
7599
7599
|
| --- | --- | --- |
|
|
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
7600
|
| <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
7601
|
| <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.platformStackName">platformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
|
|
7602
|
+
| <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix">domainPrefix</a></code> | <code>string</code> | Domain prefix for the API Gateway endpoint. |
|
|
7603
7603
|
| <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.
|
|
7604
|
+
| <code><a href="#@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.endpointPrefix">endpointPrefix</a></code> | <code>string</code> | The prefix for the API Gateway endpoint. |
|
|
7605
|
+
| <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
7606
|
|
|
7606
7607
|
---
|
|
7607
7608
|
|
|
7608
|
-
##### `
|
|
7609
|
+
##### `hostedZone`<sup>Required</sup> <a name="hostedZone" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.hostedZone"></a>
|
|
7609
7610
|
|
|
7610
7611
|
```typescript
|
|
7611
|
-
public readonly
|
|
7612
|
+
public readonly hostedZone: IHostedZone;
|
|
7612
7613
|
```
|
|
7613
7614
|
|
|
7614
|
-
- *Type:*
|
|
7615
|
+
- *Type:* aws-cdk-lib.aws_route53.IHostedZone
|
|
7615
7616
|
|
|
7616
|
-
|
|
7617
|
+
Hosted Zone to create the gateway domain A record.
|
|
7617
7618
|
|
|
7618
7619
|
---
|
|
7619
7620
|
|
|
7620
|
-
##### `
|
|
7621
|
+
##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.platformStackName"></a>
|
|
7621
7622
|
|
|
7622
7623
|
```typescript
|
|
7623
|
-
public readonly
|
|
7624
|
+
public readonly platformStackName: string;
|
|
7624
7625
|
```
|
|
7625
7626
|
|
|
7626
|
-
- *Type:*
|
|
7627
|
+
- *Type:* string
|
|
7627
7628
|
|
|
7628
|
-
|
|
7629
|
+
The name of the base platform stack.
|
|
7629
7630
|
|
|
7630
7631
|
---
|
|
7631
7632
|
|
|
7632
|
-
##### `
|
|
7633
|
+
##### `domainPrefix`<sup>Optional</sup> <a name="domainPrefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.domainPrefix"></a>
|
|
7633
7634
|
|
|
7634
7635
|
```typescript
|
|
7635
|
-
public readonly
|
|
7636
|
+
public readonly domainPrefix: string;
|
|
7636
7637
|
```
|
|
7637
7638
|
|
|
7638
7639
|
- *Type:* string
|
|
7639
7640
|
|
|
7640
|
-
|
|
7641
|
+
Domain prefix for the API Gateway endpoint.
|
|
7641
7642
|
|
|
7642
7643
|
---
|
|
7643
7644
|
|
|
@@ -7655,10 +7656,10 @@ default: true
|
|
|
7655
7656
|
|
|
7656
7657
|
---
|
|
7657
7658
|
|
|
7658
|
-
##### `
|
|
7659
|
+
##### `endpointPrefix`<sup>Optional</sup> <a name="endpointPrefix" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.endpointPrefix"></a>
|
|
7659
7660
|
|
|
7660
7661
|
```typescript
|
|
7661
|
-
public readonly
|
|
7662
|
+
public readonly endpointPrefix: string;
|
|
7662
7663
|
```
|
|
7663
7664
|
|
|
7664
7665
|
- *Type:* string
|
|
@@ -7667,6 +7668,18 @@ The prefix for the API Gateway endpoint.
|
|
|
7667
7668
|
|
|
7668
7669
|
---
|
|
7669
7670
|
|
|
7671
|
+
##### `extraHttpApiAttributes`<sup>Optional</sup> <a name="extraHttpApiAttributes" id="@btc-embedded/cdk-extensions.HTTPApiExtensionProps.property.extraHttpApiAttributes"></a>
|
|
7672
|
+
|
|
7673
|
+
```typescript
|
|
7674
|
+
public readonly extraHttpApiAttributes: HttpApiAttributes;
|
|
7675
|
+
```
|
|
7676
|
+
|
|
7677
|
+
- *Type:* aws-cdk-lib.aws_apigatewayv2.HttpApiAttributes
|
|
7678
|
+
|
|
7679
|
+
Specify additional HTTP API Attributes.
|
|
7680
|
+
|
|
7681
|
+
---
|
|
7682
|
+
|
|
7670
7683
|
### ImportLogGroupOption <a name="ImportLogGroupOption" id="@btc-embedded/cdk-extensions.ImportLogGroupOption"></a>
|
|
7671
7684
|
|
|
7672
7685
|
#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ImportLogGroupOption.Initializer"></a>
|
|
@@ -7798,7 +7811,6 @@ const postgresDbAccessExtensionProps: PostgresDbAccessExtensionProps = { ... }
|
|
|
7798
7811
|
| --- | --- | --- |
|
|
7799
7812
|
| <code><a href="#@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.basePlatformStackName">basePlatformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
|
|
7800
7813
|
| <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
7814
|
| <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
7815
|
| <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
7816
|
| <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 +7846,6 @@ The name of the database.
|
|
|
7834
7846
|
|
|
7835
7847
|
---
|
|
7836
7848
|
|
|
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
7849
|
##### `dbConnectionProperties`<sup>Optional</sup> <a name="dbConnectionProperties" id="@btc-embedded/cdk-extensions.PostgresDbAccessExtensionProps.property.dbConnectionProperties"></a>
|
|
7850
7850
|
|
|
7851
7851
|
```typescript
|
|
@@ -13150,37 +13150,37 @@ public readonly props: TcpKeepAliveExtensionProps;
|
|
|
13150
13150
|
|
|
13151
13151
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
13152
13152
|
|
|
13153
|
-
###
|
|
13153
|
+
### IApiGatewayVpcLink <a name="IApiGatewayVpcLink" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink"></a>
|
|
13154
13154
|
|
|
13155
|
-
- *Implemented By:* <a href="#@btc-embedded/cdk-extensions.
|
|
13155
|
+
- *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
13156
|
|
|
13157
13157
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
13158
13158
|
|
|
13159
13159
|
| **Name** | **Description** |
|
|
13160
13160
|
| --- | --- |
|
|
13161
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
13161
|
+
| <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo">allowAccessTo</a></code> | *No description.* |
|
|
13162
13162
|
|
|
13163
13163
|
---
|
|
13164
13164
|
|
|
13165
|
-
##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.
|
|
13165
|
+
##### `allowAccessTo` <a name="allowAccessTo" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo"></a>
|
|
13166
13166
|
|
|
13167
13167
|
```typescript
|
|
13168
|
-
public allowAccessTo(
|
|
13168
|
+
public allowAccessTo(other: IConnectable, port: number, description?: string): void
|
|
13169
13169
|
```
|
|
13170
13170
|
|
|
13171
|
-
###### `
|
|
13171
|
+
###### `other`<sup>Required</sup> <a name="other" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.other"></a>
|
|
13172
13172
|
|
|
13173
13173
|
- *Type:* aws-cdk-lib.aws_ec2.IConnectable
|
|
13174
13174
|
|
|
13175
13175
|
---
|
|
13176
13176
|
|
|
13177
|
-
###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.
|
|
13177
|
+
###### `port`<sup>Required</sup> <a name="port" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.port"></a>
|
|
13178
13178
|
|
|
13179
13179
|
- *Type:* number
|
|
13180
13180
|
|
|
13181
13181
|
---
|
|
13182
13182
|
|
|
13183
|
-
###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.
|
|
13183
|
+
###### `description`<sup>Optional</sup> <a name="description" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.allowAccessTo.parameter.description"></a>
|
|
13184
13184
|
|
|
13185
13185
|
- *Type:* string
|
|
13186
13186
|
|
|
@@ -13190,12 +13190,12 @@ public allowAccessTo(source: IConnectable, port: number, description?: string):
|
|
|
13190
13190
|
|
|
13191
13191
|
| **Name** | **Type** | **Description** |
|
|
13192
13192
|
| --- | --- | --- |
|
|
13193
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
13194
|
-
| <code><a href="#@btc-embedded/cdk-extensions.
|
|
13193
|
+
| <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | *No description.* |
|
|
13194
|
+
| <code><a href="#@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.vpcLink">vpcLink</a></code> | <code>aws-cdk-lib.aws_apigatewayv2.IVpcLink</code> | *No description.* |
|
|
13195
13195
|
|
|
13196
13196
|
---
|
|
13197
13197
|
|
|
13198
|
-
##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.
|
|
13198
|
+
##### `securityGroup`<sup>Required</sup> <a name="securityGroup" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.securityGroup"></a>
|
|
13199
13199
|
|
|
13200
13200
|
```typescript
|
|
13201
13201
|
public readonly securityGroup: ISecurityGroup;
|
|
@@ -13205,7 +13205,7 @@ public readonly securityGroup: ISecurityGroup;
|
|
|
13205
13205
|
|
|
13206
13206
|
---
|
|
13207
13207
|
|
|
13208
|
-
##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.
|
|
13208
|
+
##### `vpcLink`<sup>Required</sup> <a name="vpcLink" id="@btc-embedded/cdk-extensions.IApiGatewayVpcLink.property.vpcLink"></a>
|
|
13209
13209
|
|
|
13210
13210
|
```typescript
|
|
13211
13211
|
public readonly vpcLink: IVpcLink;
|