@@ -36,12 +36,20 @@ new AlbFargateServices(scope: Construct, id: string, props: AlbFargateServicesPr
36
36
37
37
##### ` externalAlb ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServices.property.externalAlb " ></a >
38
38
39
+ ``` typescript
40
+ public readonly externalAlb : ApplicationLoadBalancer ;
41
+ ```
42
+
39
43
- * Type:* [ ` @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer ` ] ( #@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer )
40
44
41
45
---
42
46
43
47
##### ` internalAlb ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServices.property.internalAlb " ></a >
44
48
49
+ ``` typescript
50
+ public readonly internalAlb : ApplicationLoadBalancer ;
51
+ ```
52
+
45
53
- * Type:* [ ` @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer ` ] ( #@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer )
46
54
47
55
---
@@ -81,6 +89,10 @@ new BaseFargateServices(scope: Construct, id: string, props: BaseFargateServices
81
89
82
90
##### ` service ` <sup >Required</sup > <a name =" serverless-container-constructs.BaseFargateServices.property.service " ></a >
83
91
92
+ ``` typescript
93
+ public readonly service : FargateService [];
94
+ ```
95
+
84
96
- * Type:* [ ` @aws-cdk/aws-ecs.FargateService ` ] ( #@aws-cdk/aws-ecs.FargateService ) [ ]
85
97
86
98
The service(s) created from the task(s).
@@ -89,6 +101,10 @@ The service(s) created from the task(s).
89
101
90
102
##### ` vpc ` <sup >Required</sup > <a name =" serverless-container-constructs.BaseFargateServices.property.vpc " ></a >
91
103
104
+ ``` typescript
105
+ public readonly vpc : IVpc ;
106
+ ```
107
+
92
108
- * Type:* [ ` @aws-cdk/aws-ec2.IVpc ` ] ( #@aws-cdk/aws-ec2.IVpc )
93
109
94
110
---
@@ -108,12 +124,20 @@ const albFargateServicesProps: AlbFargateServicesProps = { ... }
108
124
109
125
##### ` tasks ` <sup >Required</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.tasks " ></a >
110
126
127
+ ``` typescript
128
+ public readonly tasks : FargateTaskProps [];
129
+ ```
130
+
111
131
- * Type:* [ ` serverless-container-constructs.FargateTaskProps ` ] ( #serverless-container-constructs.FargateTaskProps ) [ ]
112
132
113
133
---
114
134
115
135
##### ` enableExecuteCommand ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.enableExecuteCommand " ></a >
116
136
137
+ ``` typescript
138
+ public readonly enableExecuteCommand : boolean ;
139
+ ```
140
+
117
141
- * Type:* ` boolean `
118
142
- * Default:* false
119
143
@@ -125,12 +149,20 @@ Whether to enable ECS Exec support.
125
149
126
150
##### ` route53Ops ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.route53Ops " ></a >
127
151
152
+ ``` typescript
153
+ public readonly route53Ops : Route53Options ;
154
+ ```
155
+
128
156
- * Type:* [ ` serverless-container-constructs.Route53Options ` ] ( #serverless-container-constructs.Route53Options )
129
157
130
158
---
131
159
132
160
##### ` spot ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.spot " ></a >
133
161
162
+ ``` typescript
163
+ public readonly spot : boolean ;
164
+ ```
165
+
134
166
- * Type:* ` boolean `
135
167
- * Default:* false
136
168
@@ -140,12 +172,20 @@ create a FARGATE_SPOT only cluster.
140
172
141
173
##### ` vpc ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.vpc " ></a >
142
174
175
+ ``` typescript
176
+ public readonly vpc : IVpc ;
177
+ ```
178
+
143
179
- * Type:* [ ` @aws-cdk/aws-ec2.IVpc ` ] ( #@aws-cdk/aws-ec2.IVpc )
144
180
145
181
---
146
182
147
183
##### ` vpcSubnets ` <sup >Optional</sup > <a name =" serverless-container-constructs.AlbFargateServicesProps.property.vpcSubnets " ></a >
148
184
185
+ ``` typescript
186
+ public readonly vpcSubnets : SubnetSelection ;
187
+ ```
188
+
149
189
- * Type:* [ ` @aws-cdk/aws-ec2.SubnetSelection ` ] ( #@aws-cdk/aws-ec2.SubnetSelection )
150
190
- * Default:* {
151
191
subnetType: ec2.SubnetType.PRIVATE,
@@ -167,12 +207,20 @@ const baseFargateServicesProps: BaseFargateServicesProps = { ... }
167
207
168
208
##### ` tasks ` <sup >Required</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.tasks " ></a >
169
209
210
+ ``` typescript
211
+ public readonly tasks : FargateTaskProps [];
212
+ ```
213
+
170
214
- * Type:* [ ` serverless-container-constructs.FargateTaskProps ` ] ( #serverless-container-constructs.FargateTaskProps ) [ ]
171
215
172
216
---
173
217
174
218
##### ` enableExecuteCommand ` <sup >Optional</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.enableExecuteCommand " ></a >
175
219
220
+ ``` typescript
221
+ public readonly enableExecuteCommand : boolean ;
222
+ ```
223
+
176
224
- * Type:* ` boolean `
177
225
- * Default:* false
178
226
@@ -184,12 +232,20 @@ Whether to enable ECS Exec support.
184
232
185
233
##### ` route53Ops ` <sup >Optional</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.route53Ops " ></a >
186
234
235
+ ``` typescript
236
+ public readonly route53Ops : Route53Options ;
237
+ ```
238
+
187
239
- * Type:* [ ` serverless-container-constructs.Route53Options ` ] ( #serverless-container-constructs.Route53Options )
188
240
189
241
---
190
242
191
243
##### ` spot ` <sup >Optional</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.spot " ></a >
192
244
245
+ ``` typescript
246
+ public readonly spot : boolean ;
247
+ ```
248
+
193
249
- * Type:* ` boolean `
194
250
- * Default:* false
195
251
@@ -199,12 +255,20 @@ create a FARGATE_SPOT only cluster.
199
255
200
256
##### ` vpc ` <sup >Optional</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.vpc " ></a >
201
257
258
+ ``` typescript
259
+ public readonly vpc : IVpc ;
260
+ ```
261
+
202
262
- * Type:* [ ` @aws-cdk/aws-ec2.IVpc ` ] ( #@aws-cdk/aws-ec2.IVpc )
203
263
204
264
---
205
265
206
266
##### ` vpcSubnets ` <sup >Optional</sup > <a name =" serverless-container-constructs.BaseFargateServicesProps.property.vpcSubnets " ></a >
207
267
268
+ ``` typescript
269
+ public readonly vpcSubnets : SubnetSelection ;
270
+ ```
271
+
208
272
- * Type:* [ ` @aws-cdk/aws-ec2.SubnetSelection ` ] ( #@aws-cdk/aws-ec2.SubnetSelection )
209
273
- * Default:* {
210
274
subnetType: ec2.SubnetType.PRIVATE,
@@ -226,18 +290,30 @@ const fargateTaskProps: FargateTaskProps = { ... }
226
290
227
291
##### ` listenerPort ` <sup >Required</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.listenerPort " ></a >
228
292
293
+ ``` typescript
294
+ public readonly listenerPort : number ;
295
+ ```
296
+
229
297
- * Type:* ` number `
230
298
231
299
---
232
300
233
301
##### ` task ` <sup >Required</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.task " ></a >
234
302
303
+ ``` typescript
304
+ public readonly task : FargateTaskDefinition ;
305
+ ```
306
+
235
307
- * Type:* [ ` @aws-cdk/aws-ecs.FargateTaskDefinition ` ] ( #@aws-cdk/aws-ecs.FargateTaskDefinition )
236
308
237
309
---
238
310
239
311
##### ` accessibility ` <sup >Optional</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.accessibility " ></a >
240
312
313
+ ``` typescript
314
+ public readonly accessibility : LoadBalancerAccessibility ;
315
+ ```
316
+
241
317
- * Type:* [ ` serverless-container-constructs.LoadBalancerAccessibility ` ] ( #serverless-container-constructs.LoadBalancerAccessibility )
242
318
- * Default:* both
243
319
@@ -247,12 +323,20 @@ Register the service to internal ELB, external ELB or both.
247
323
248
324
##### ` capacityProviderStrategy ` <sup >Optional</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.capacityProviderStrategy " ></a >
249
325
326
+ ``` typescript
327
+ public readonly capacityProviderStrategy : CapacityProviderStrategy [];
328
+ ```
329
+
250
330
- * Type:* [ ` @aws-cdk/aws-ecs.CapacityProviderStrategy ` ] ( #@aws-cdk/aws-ecs.CapacityProviderStrategy ) [ ]
251
331
252
332
---
253
333
254
334
##### ` desiredCount ` <sup >Optional</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.desiredCount " ></a >
255
335
336
+ ``` typescript
337
+ public readonly desiredCount : number ;
338
+ ```
339
+
256
340
- * Type:* ` number `
257
341
- * Default:* 1
258
342
@@ -262,6 +346,10 @@ desired number of tasks for the service.
262
346
263
347
##### ` scalingPolicy ` <sup >Optional</sup > <a name =" serverless-container-constructs.FargateTaskProps.property.scalingPolicy " ></a >
264
348
349
+ ``` typescript
350
+ public readonly scalingPolicy : ServiceScalingPolicy ;
351
+ ```
352
+
265
353
- * Type:* [ ` serverless-container-constructs.ServiceScalingPolicy ` ] ( #serverless-container-constructs.ServiceScalingPolicy )
266
354
- * Default:* { maxCapacity: 10, targetCpuUtilization: 50, requestsPerTarget: 1000 }
267
355
@@ -281,6 +369,10 @@ const route53Options: Route53Options = { ... }
281
369
282
370
##### ` externalElbRecordName ` <sup >Optional</sup > <a name =" serverless-container-constructs.Route53Options.property.externalElbRecordName " ></a >
283
371
372
+ ``` typescript
373
+ public readonly externalElbRecordName : string ;
374
+ ```
375
+
284
376
- * Type:* ` string `
285
377
- * Default:* external
286
378
@@ -290,6 +382,10 @@ the external ELB record name.
290
382
291
383
##### ` internalElbRecordName ` <sup >Optional</sup > <a name =" serverless-container-constructs.Route53Options.property.internalElbRecordName " ></a >
292
384
385
+ ``` typescript
386
+ public readonly internalElbRecordName : string ;
387
+ ```
388
+
293
389
- * Type:* ` string `
294
390
- * Default:* internal
295
391
@@ -299,6 +395,10 @@ the internal ELB record name.
299
395
300
396
##### ` zoneName ` <sup >Optional</sup > <a name =" serverless-container-constructs.Route53Options.property.zoneName " ></a >
301
397
398
+ ``` typescript
399
+ public readonly zoneName : string ;
400
+ ```
401
+
302
402
- * Type:* ` string `
303
403
- * Default:* svc.local
304
404
@@ -318,6 +418,10 @@ const serviceScalingPolicy: ServiceScalingPolicy = { ... }
318
418
319
419
##### ` maxCapacity ` <sup >Optional</sup > <a name =" serverless-container-constructs.ServiceScalingPolicy.property.maxCapacity " ></a >
320
420
421
+ ``` typescript
422
+ public readonly maxCapacity : number ;
423
+ ```
424
+
321
425
- * Type:* ` number `
322
426
- * Default:* 10
323
427
@@ -327,6 +431,10 @@ max capacity for the service autoscaling.
327
431
328
432
##### ` requestPerTarget ` <sup >Optional</sup > <a name =" serverless-container-constructs.ServiceScalingPolicy.property.requestPerTarget " ></a >
329
433
434
+ ``` typescript
435
+ public readonly requestPerTarget : number ;
436
+ ```
437
+
330
438
- * Type:* ` number `
331
439
- * Default:* 1000
332
440
@@ -336,6 +444,10 @@ request per target.
336
444
337
445
##### ` targetCpuUtilization ` <sup >Optional</sup > <a name =" serverless-container-constructs.ServiceScalingPolicy.property.targetCpuUtilization " ></a >
338
446
447
+ ``` typescript
448
+ public readonly targetCpuUtilization : number ;
449
+ ```
450
+
339
451
- * Type:* ` number `
340
452
- * Default:* 50
341
453
0 commit comments