UNPKG

1.24 MBPlain TextView Raw
1{
2 "author": {
3 "name": "Amazon Web Services",
4 "organization": true,
5 "roles": [
6 "author"
7 ],
8 "url": "https://aws.amazon.com"
9 },
10 "dependencies": {
11 "@aws-cdk/aws-applicationautoscaling": "1.156.1",
12 "@aws-cdk/aws-autoscaling": "1.156.1",
13 "@aws-cdk/aws-autoscaling-hooktargets": "1.156.1",
14 "@aws-cdk/aws-certificatemanager": "1.156.1",
15 "@aws-cdk/aws-cloudwatch": "1.156.1",
16 "@aws-cdk/aws-ec2": "1.156.1",
17 "@aws-cdk/aws-ecr": "1.156.1",
18 "@aws-cdk/aws-ecr-assets": "1.156.1",
19 "@aws-cdk/aws-elasticloadbalancing": "1.156.1",
20 "@aws-cdk/aws-elasticloadbalancingv2": "1.156.1",
21 "@aws-cdk/aws-iam": "1.156.1",
22 "@aws-cdk/aws-kms": "1.156.1",
23 "@aws-cdk/aws-lambda": "1.156.1",
24 "@aws-cdk/aws-logs": "1.156.1",
25 "@aws-cdk/aws-route53": "1.156.1",
26 "@aws-cdk/aws-route53-targets": "1.156.1",
27 "@aws-cdk/aws-s3": "1.156.1",
28 "@aws-cdk/aws-s3-assets": "1.156.1",
29 "@aws-cdk/aws-secretsmanager": "1.156.1",
30 "@aws-cdk/aws-servicediscovery": "1.156.1",
31 "@aws-cdk/aws-sns": "1.156.1",
32 "@aws-cdk/aws-sqs": "1.156.1",
33 "@aws-cdk/aws-ssm": "1.156.1",
34 "@aws-cdk/core": "1.156.1",
35 "@aws-cdk/cx-api": "1.156.1",
36 "constructs": "^3.3.69"
37 },
38 "dependencyClosure": {
39 "@aws-cdk/assets": {
40 "targets": {
41 "dotnet": {
42 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
43 "namespace": "Amazon.CDK.Assets",
44 "packageId": "Amazon.CDK.Assets"
45 },
46 "java": {
47 "maven": {
48 "artifactId": "cdk-assets",
49 "groupId": "software.amazon.awscdk"
50 },
51 "package": "software.amazon.awscdk.assets"
52 },
53 "js": {
54 "npm": "@aws-cdk/assets"
55 },
56 "python": {
57 "classifiers": [
58 "Framework :: AWS CDK",
59 "Framework :: AWS CDK :: 1"
60 ],
61 "distName": "aws-cdk.assets",
62 "module": "aws_cdk.assets"
63 }
64 }
65 },
66 "@aws-cdk/aws-acmpca": {
67 "targets": {
68 "dotnet": {
69 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
70 "namespace": "Amazon.CDK.AWS.ACMPCA",
71 "packageId": "Amazon.CDK.AWS.ACMPCA"
72 },
73 "java": {
74 "maven": {
75 "artifactId": "acmpca",
76 "groupId": "software.amazon.awscdk"
77 },
78 "package": "software.amazon.awscdk.services.acmpca"
79 },
80 "js": {
81 "npm": "@aws-cdk/aws-acmpca"
82 },
83 "python": {
84 "classifiers": [
85 "Framework :: AWS CDK",
86 "Framework :: AWS CDK :: 1"
87 ],
88 "distName": "aws-cdk.aws-acmpca",
89 "module": "aws_cdk.aws_acmpca"
90 }
91 }
92 },
93 "@aws-cdk/aws-apigateway": {
94 "targets": {
95 "dotnet": {
96 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
97 "namespace": "Amazon.CDK.AWS.APIGateway",
98 "packageId": "Amazon.CDK.AWS.APIGateway"
99 },
100 "java": {
101 "maven": {
102 "artifactId": "apigateway",
103 "groupId": "software.amazon.awscdk"
104 },
105 "package": "software.amazon.awscdk.services.apigateway"
106 },
107 "js": {
108 "npm": "@aws-cdk/aws-apigateway"
109 },
110 "python": {
111 "classifiers": [
112 "Framework :: AWS CDK",
113 "Framework :: AWS CDK :: 1"
114 ],
115 "distName": "aws-cdk.aws-apigateway",
116 "module": "aws_cdk.aws_apigateway"
117 }
118 }
119 },
120 "@aws-cdk/aws-applicationautoscaling": {
121 "targets": {
122 "dotnet": {
123 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
124 "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling",
125 "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling"
126 },
127 "java": {
128 "maven": {
129 "artifactId": "applicationautoscaling",
130 "groupId": "software.amazon.awscdk"
131 },
132 "package": "software.amazon.awscdk.services.applicationautoscaling"
133 },
134 "js": {
135 "npm": "@aws-cdk/aws-applicationautoscaling"
136 },
137 "python": {
138 "classifiers": [
139 "Framework :: AWS CDK",
140 "Framework :: AWS CDK :: 1"
141 ],
142 "distName": "aws-cdk.aws-applicationautoscaling",
143 "module": "aws_cdk.aws_applicationautoscaling"
144 }
145 }
146 },
147 "@aws-cdk/aws-autoscaling": {
148 "targets": {
149 "dotnet": {
150 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
151 "namespace": "Amazon.CDK.AWS.AutoScaling",
152 "packageId": "Amazon.CDK.AWS.AutoScaling"
153 },
154 "java": {
155 "maven": {
156 "artifactId": "autoscaling",
157 "groupId": "software.amazon.awscdk"
158 },
159 "package": "software.amazon.awscdk.services.autoscaling"
160 },
161 "js": {
162 "npm": "@aws-cdk/aws-autoscaling"
163 },
164 "python": {
165 "classifiers": [
166 "Framework :: AWS CDK",
167 "Framework :: AWS CDK :: 1"
168 ],
169 "distName": "aws-cdk.aws-autoscaling",
170 "module": "aws_cdk.aws_autoscaling"
171 }
172 }
173 },
174 "@aws-cdk/aws-autoscaling-common": {
175 "targets": {
176 "dotnet": {
177 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
178 "namespace": "Amazon.CDK.AWS.AutoScaling.Common",
179 "packageId": "Amazon.CDK.AWS.AutoScaling.Common"
180 },
181 "java": {
182 "maven": {
183 "artifactId": "autoscaling-common",
184 "groupId": "software.amazon.awscdk"
185 },
186 "package": "software.amazon.awscdk.services.autoscaling.common"
187 },
188 "js": {
189 "npm": "@aws-cdk/aws-autoscaling-common"
190 },
191 "python": {
192 "classifiers": [
193 "Framework :: AWS CDK",
194 "Framework :: AWS CDK :: 1"
195 ],
196 "distName": "aws-cdk.aws-autoscaling-common",
197 "module": "aws_cdk.aws_autoscaling_common"
198 }
199 }
200 },
201 "@aws-cdk/aws-autoscaling-hooktargets": {
202 "targets": {
203 "dotnet": {
204 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
205 "namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets",
206 "packageId": "Amazon.CDK.AWS.AutoScaling.HookTargets"
207 },
208 "java": {
209 "maven": {
210 "artifactId": "autoscaling-hooktargets",
211 "groupId": "software.amazon.awscdk"
212 },
213 "package": "software.amazon.awscdk.services.autoscaling.hooktargets"
214 },
215 "js": {
216 "npm": "@aws-cdk/aws-autoscaling-hooktargets"
217 },
218 "python": {
219 "classifiers": [
220 "Framework :: AWS CDK",
221 "Framework :: AWS CDK :: 1"
222 ],
223 "distName": "aws-cdk.aws-autoscaling-hooktargets",
224 "module": "aws_cdk.aws_autoscaling_hooktargets"
225 }
226 }
227 },
228 "@aws-cdk/aws-certificatemanager": {
229 "targets": {
230 "dotnet": {
231 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
232 "namespace": "Amazon.CDK.AWS.CertificateManager",
233 "packageId": "Amazon.CDK.AWS.CertificateManager"
234 },
235 "java": {
236 "maven": {
237 "artifactId": "certificatemanager",
238 "groupId": "software.amazon.awscdk"
239 },
240 "package": "software.amazon.awscdk.services.certificatemanager"
241 },
242 "js": {
243 "npm": "@aws-cdk/aws-certificatemanager"
244 },
245 "python": {
246 "classifiers": [
247 "Framework :: AWS CDK",
248 "Framework :: AWS CDK :: 1"
249 ],
250 "distName": "aws-cdk.aws-certificatemanager",
251 "module": "aws_cdk.aws_certificatemanager"
252 }
253 }
254 },
255 "@aws-cdk/aws-cloudformation": {
256 "targets": {
257 "dotnet": {
258 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
259 "namespace": "Amazon.CDK.AWS.CloudFormation",
260 "packageId": "Amazon.CDK.AWS.CloudFormation"
261 },
262 "java": {
263 "maven": {
264 "artifactId": "cloudformation",
265 "groupId": "software.amazon.awscdk"
266 },
267 "package": "software.amazon.awscdk.services.cloudformation"
268 },
269 "js": {
270 "npm": "@aws-cdk/aws-cloudformation"
271 },
272 "python": {
273 "classifiers": [
274 "Framework :: AWS CDK",
275 "Framework :: AWS CDK :: 1"
276 ],
277 "distName": "aws-cdk.aws-cloudformation",
278 "module": "aws_cdk.aws_cloudformation"
279 }
280 }
281 },
282 "@aws-cdk/aws-cloudfront": {
283 "submodules": {
284 "@aws-cdk/aws-cloudfront.experimental": {}
285 },
286 "targets": {
287 "dotnet": {
288 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
289 "namespace": "Amazon.CDK.AWS.CloudFront",
290 "packageId": "Amazon.CDK.AWS.CloudFront"
291 },
292 "java": {
293 "maven": {
294 "artifactId": "cloudfront",
295 "groupId": "software.amazon.awscdk"
296 },
297 "package": "software.amazon.awscdk.services.cloudfront"
298 },
299 "js": {
300 "npm": "@aws-cdk/aws-cloudfront"
301 },
302 "python": {
303 "classifiers": [
304 "Framework :: AWS CDK",
305 "Framework :: AWS CDK :: 1"
306 ],
307 "distName": "aws-cdk.aws-cloudfront",
308 "module": "aws_cdk.aws_cloudfront"
309 }
310 }
311 },
312 "@aws-cdk/aws-cloudwatch": {
313 "targets": {
314 "dotnet": {
315 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
316 "namespace": "Amazon.CDK.AWS.CloudWatch",
317 "packageId": "Amazon.CDK.AWS.CloudWatch"
318 },
319 "java": {
320 "maven": {
321 "artifactId": "cloudwatch",
322 "groupId": "software.amazon.awscdk"
323 },
324 "package": "software.amazon.awscdk.services.cloudwatch"
325 },
326 "js": {
327 "npm": "@aws-cdk/aws-cloudwatch"
328 },
329 "python": {
330 "classifiers": [
331 "Framework :: AWS CDK",
332 "Framework :: AWS CDK :: 1"
333 ],
334 "distName": "aws-cdk.aws-cloudwatch",
335 "module": "aws_cdk.aws_cloudwatch"
336 }
337 }
338 },
339 "@aws-cdk/aws-codeguruprofiler": {
340 "targets": {
341 "dotnet": {
342 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
343 "namespace": "Amazon.CDK.AWS.CodeGuruProfiler",
344 "packageId": "Amazon.CDK.AWS.CodeGuruProfiler"
345 },
346 "java": {
347 "maven": {
348 "artifactId": "codeguruprofiler",
349 "groupId": "software.amazon.awscdk"
350 },
351 "package": "software.amazon.awscdk.services.codeguruprofiler"
352 },
353 "js": {
354 "npm": "@aws-cdk/aws-codeguruprofiler"
355 },
356 "python": {
357 "classifiers": [
358 "Framework :: AWS CDK",
359 "Framework :: AWS CDK :: 1"
360 ],
361 "distName": "aws-cdk.aws-codeguruprofiler",
362 "module": "aws_cdk.aws_codeguruprofiler"
363 }
364 }
365 },
366 "@aws-cdk/aws-codestarnotifications": {
367 "targets": {
368 "dotnet": {
369 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
370 "namespace": "Amazon.CDK.AWS.CodeStarNotifications",
371 "packageId": "Amazon.CDK.AWS.CodeStarNotifications"
372 },
373 "java": {
374 "maven": {
375 "artifactId": "codestarnotifications",
376 "groupId": "software.amazon.awscdk"
377 },
378 "package": "software.amazon.awscdk.services.codestarnotifications"
379 },
380 "js": {
381 "npm": "@aws-cdk/aws-codestarnotifications"
382 },
383 "python": {
384 "classifiers": [
385 "Framework :: AWS CDK",
386 "Framework :: AWS CDK :: 1"
387 ],
388 "distName": "aws-cdk.aws-codestarnotifications",
389 "module": "aws_cdk.aws_codestarnotifications"
390 }
391 }
392 },
393 "@aws-cdk/aws-cognito": {
394 "targets": {
395 "dotnet": {
396 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
397 "namespace": "Amazon.CDK.AWS.Cognito",
398 "packageId": "Amazon.CDK.AWS.Cognito"
399 },
400 "java": {
401 "maven": {
402 "artifactId": "cognito",
403 "groupId": "software.amazon.awscdk"
404 },
405 "package": "software.amazon.awscdk.services.cognito"
406 },
407 "js": {
408 "npm": "@aws-cdk/aws-cognito"
409 },
410 "python": {
411 "classifiers": [
412 "Framework :: AWS CDK",
413 "Framework :: AWS CDK :: 1"
414 ],
415 "distName": "aws-cdk.aws-cognito",
416 "module": "aws_cdk.aws_cognito"
417 }
418 }
419 },
420 "@aws-cdk/aws-ec2": {
421 "targets": {
422 "dotnet": {
423 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
424 "namespace": "Amazon.CDK.AWS.EC2",
425 "packageId": "Amazon.CDK.AWS.EC2"
426 },
427 "java": {
428 "maven": {
429 "artifactId": "ec2",
430 "groupId": "software.amazon.awscdk"
431 },
432 "package": "software.amazon.awscdk.services.ec2"
433 },
434 "js": {
435 "npm": "@aws-cdk/aws-ec2"
436 },
437 "python": {
438 "classifiers": [
439 "Framework :: AWS CDK",
440 "Framework :: AWS CDK :: 1"
441 ],
442 "distName": "aws-cdk.aws-ec2",
443 "module": "aws_cdk.aws_ec2"
444 }
445 }
446 },
447 "@aws-cdk/aws-ecr": {
448 "targets": {
449 "dotnet": {
450 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
451 "namespace": "Amazon.CDK.AWS.ECR",
452 "packageId": "Amazon.CDK.AWS.ECR"
453 },
454 "java": {
455 "maven": {
456 "artifactId": "ecr",
457 "groupId": "software.amazon.awscdk"
458 },
459 "package": "software.amazon.awscdk.services.ecr"
460 },
461 "js": {
462 "npm": "@aws-cdk/aws-ecr"
463 },
464 "python": {
465 "classifiers": [
466 "Framework :: AWS CDK",
467 "Framework :: AWS CDK :: 1"
468 ],
469 "distName": "aws-cdk.aws-ecr",
470 "module": "aws_cdk.aws_ecr"
471 }
472 }
473 },
474 "@aws-cdk/aws-ecr-assets": {
475 "targets": {
476 "dotnet": {
477 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
478 "namespace": "Amazon.CDK.AWS.Ecr.Assets",
479 "packageId": "Amazon.CDK.ECR.Assets"
480 },
481 "java": {
482 "maven": {
483 "artifactId": "ecr-assets",
484 "groupId": "software.amazon.awscdk"
485 },
486 "package": "software.amazon.awscdk.services.ecr.assets"
487 },
488 "js": {
489 "npm": "@aws-cdk/aws-ecr-assets"
490 },
491 "python": {
492 "classifiers": [
493 "Framework :: AWS CDK",
494 "Framework :: AWS CDK :: 1"
495 ],
496 "distName": "aws-cdk.aws-ecr-assets",
497 "module": "aws_cdk.aws_ecr_assets"
498 }
499 }
500 },
501 "@aws-cdk/aws-efs": {
502 "targets": {
503 "dotnet": {
504 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
505 "namespace": "Amazon.CDK.AWS.EFS",
506 "packageId": "Amazon.CDK.AWS.EFS"
507 },
508 "java": {
509 "maven": {
510 "artifactId": "efs",
511 "groupId": "software.amazon.awscdk"
512 },
513 "package": "software.amazon.awscdk.services.efs"
514 },
515 "js": {
516 "npm": "@aws-cdk/aws-efs"
517 },
518 "python": {
519 "classifiers": [
520 "Framework :: AWS CDK",
521 "Framework :: AWS CDK :: 1"
522 ],
523 "distName": "aws-cdk.aws-efs",
524 "module": "aws_cdk.aws_efs"
525 }
526 }
527 },
528 "@aws-cdk/aws-elasticloadbalancing": {
529 "targets": {
530 "dotnet": {
531 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
532 "namespace": "Amazon.CDK.AWS.ElasticLoadBalancing",
533 "packageId": "Amazon.CDK.AWS.ElasticLoadBalancing"
534 },
535 "java": {
536 "maven": {
537 "artifactId": "elasticloadbalancing",
538 "groupId": "software.amazon.awscdk"
539 },
540 "package": "software.amazon.awscdk.services.elasticloadbalancing"
541 },
542 "js": {
543 "npm": "@aws-cdk/aws-elasticloadbalancing"
544 },
545 "python": {
546 "classifiers": [
547 "Framework :: AWS CDK",
548 "Framework :: AWS CDK :: 1"
549 ],
550 "distName": "aws-cdk.aws-elasticloadbalancing",
551 "module": "aws_cdk.aws_elasticloadbalancing"
552 }
553 }
554 },
555 "@aws-cdk/aws-elasticloadbalancingv2": {
556 "targets": {
557 "dotnet": {
558 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
559 "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2",
560 "packageId": "Amazon.CDK.AWS.ElasticLoadBalancingV2"
561 },
562 "java": {
563 "maven": {
564 "artifactId": "elasticloadbalancingv2",
565 "groupId": "software.amazon.awscdk"
566 },
567 "package": "software.amazon.awscdk.services.elasticloadbalancingv2"
568 },
569 "js": {
570 "npm": "@aws-cdk/aws-elasticloadbalancingv2"
571 },
572 "python": {
573 "classifiers": [
574 "Framework :: AWS CDK",
575 "Framework :: AWS CDK :: 1"
576 ],
577 "distName": "aws-cdk.aws-elasticloadbalancingv2",
578 "module": "aws_cdk.aws_elasticloadbalancingv2"
579 }
580 }
581 },
582 "@aws-cdk/aws-events": {
583 "targets": {
584 "dotnet": {
585 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
586 "namespace": "Amazon.CDK.AWS.Events",
587 "packageId": "Amazon.CDK.AWS.Events"
588 },
589 "java": {
590 "maven": {
591 "artifactId": "events",
592 "groupId": "software.amazon.awscdk"
593 },
594 "package": "software.amazon.awscdk.services.events"
595 },
596 "js": {
597 "npm": "@aws-cdk/aws-events"
598 },
599 "python": {
600 "classifiers": [
601 "Framework :: AWS CDK",
602 "Framework :: AWS CDK :: 1"
603 ],
604 "distName": "aws-cdk.aws-events",
605 "module": "aws_cdk.aws_events"
606 }
607 }
608 },
609 "@aws-cdk/aws-globalaccelerator": {
610 "targets": {
611 "dotnet": {
612 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
613 "namespace": "Amazon.CDK.AWS.GlobalAccelerator",
614 "packageId": "Amazon.CDK.AWS.GlobalAccelerator"
615 },
616 "java": {
617 "maven": {
618 "artifactId": "globalaccelerator",
619 "groupId": "software.amazon.awscdk"
620 },
621 "package": "software.amazon.awscdk.services.globalaccelerator"
622 },
623 "js": {
624 "npm": "@aws-cdk/aws-globalaccelerator"
625 },
626 "python": {
627 "classifiers": [
628 "Framework :: AWS CDK",
629 "Framework :: AWS CDK :: 1"
630 ],
631 "distName": "aws-cdk.aws-globalaccelerator",
632 "module": "aws_cdk.aws_globalaccelerator"
633 }
634 }
635 },
636 "@aws-cdk/aws-iam": {
637 "targets": {
638 "dotnet": {
639 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
640 "namespace": "Amazon.CDK.AWS.IAM",
641 "packageId": "Amazon.CDK.AWS.IAM"
642 },
643 "java": {
644 "maven": {
645 "artifactId": "iam",
646 "groupId": "software.amazon.awscdk"
647 },
648 "package": "software.amazon.awscdk.services.iam"
649 },
650 "js": {
651 "npm": "@aws-cdk/aws-iam"
652 },
653 "python": {
654 "classifiers": [
655 "Framework :: AWS CDK",
656 "Framework :: AWS CDK :: 1"
657 ],
658 "distName": "aws-cdk.aws-iam",
659 "module": "aws_cdk.aws_iam"
660 }
661 }
662 },
663 "@aws-cdk/aws-kms": {
664 "targets": {
665 "dotnet": {
666 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
667 "namespace": "Amazon.CDK.AWS.KMS",
668 "packageId": "Amazon.CDK.AWS.KMS"
669 },
670 "java": {
671 "maven": {
672 "artifactId": "kms",
673 "groupId": "software.amazon.awscdk"
674 },
675 "package": "software.amazon.awscdk.services.kms"
676 },
677 "js": {
678 "npm": "@aws-cdk/aws-kms"
679 },
680 "python": {
681 "classifiers": [
682 "Framework :: AWS CDK",
683 "Framework :: AWS CDK :: 1"
684 ],
685 "distName": "aws-cdk.aws-kms",
686 "module": "aws_cdk.aws_kms"
687 }
688 }
689 },
690 "@aws-cdk/aws-lambda": {
691 "targets": {
692 "dotnet": {
693 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
694 "namespace": "Amazon.CDK.AWS.Lambda",
695 "packageId": "Amazon.CDK.AWS.Lambda"
696 },
697 "java": {
698 "maven": {
699 "artifactId": "lambda",
700 "groupId": "software.amazon.awscdk"
701 },
702 "package": "software.amazon.awscdk.services.lambda"
703 },
704 "js": {
705 "npm": "@aws-cdk/aws-lambda"
706 },
707 "python": {
708 "classifiers": [
709 "Framework :: AWS CDK",
710 "Framework :: AWS CDK :: 1"
711 ],
712 "distName": "aws-cdk.aws-lambda",
713 "module": "aws_cdk.aws_lambda"
714 }
715 }
716 },
717 "@aws-cdk/aws-logs": {
718 "targets": {
719 "dotnet": {
720 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
721 "namespace": "Amazon.CDK.AWS.Logs",
722 "packageId": "Amazon.CDK.AWS.Logs"
723 },
724 "java": {
725 "maven": {
726 "artifactId": "logs",
727 "groupId": "software.amazon.awscdk"
728 },
729 "package": "software.amazon.awscdk.services.logs"
730 },
731 "js": {
732 "npm": "@aws-cdk/aws-logs"
733 },
734 "python": {
735 "classifiers": [
736 "Framework :: AWS CDK",
737 "Framework :: AWS CDK :: 1"
738 ],
739 "distName": "aws-cdk.aws-logs",
740 "module": "aws_cdk.aws_logs"
741 }
742 }
743 },
744 "@aws-cdk/aws-route53": {
745 "targets": {
746 "dotnet": {
747 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
748 "namespace": "Amazon.CDK.AWS.Route53",
749 "packageId": "Amazon.CDK.AWS.Route53"
750 },
751 "java": {
752 "maven": {
753 "artifactId": "route53",
754 "groupId": "software.amazon.awscdk"
755 },
756 "package": "software.amazon.awscdk.services.route53"
757 },
758 "js": {
759 "npm": "@aws-cdk/aws-route53"
760 },
761 "python": {
762 "classifiers": [
763 "Framework :: AWS CDK",
764 "Framework :: AWS CDK :: 1"
765 ],
766 "distName": "aws-cdk.aws-route53",
767 "module": "aws_cdk.aws_route53"
768 }
769 }
770 },
771 "@aws-cdk/aws-route53-targets": {
772 "targets": {
773 "dotnet": {
774 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
775 "namespace": "Amazon.CDK.AWS.Route53.Targets",
776 "packageId": "Amazon.CDK.AWS.Route53.Targets"
777 },
778 "java": {
779 "maven": {
780 "artifactId": "route53-targets",
781 "groupId": "software.amazon.awscdk"
782 },
783 "package": "software.amazon.awscdk.services.route53.targets"
784 },
785 "js": {
786 "npm": "@aws-cdk/aws-route53-targets"
787 },
788 "python": {
789 "classifiers": [
790 "Framework :: AWS CDK",
791 "Framework :: AWS CDK :: 1"
792 ],
793 "distName": "aws-cdk.aws-route53-targets",
794 "module": "aws_cdk.aws_route53_targets"
795 }
796 }
797 },
798 "@aws-cdk/aws-s3": {
799 "targets": {
800 "dotnet": {
801 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
802 "namespace": "Amazon.CDK.AWS.S3",
803 "packageId": "Amazon.CDK.AWS.S3"
804 },
805 "java": {
806 "maven": {
807 "artifactId": "s3",
808 "groupId": "software.amazon.awscdk"
809 },
810 "package": "software.amazon.awscdk.services.s3"
811 },
812 "js": {
813 "npm": "@aws-cdk/aws-s3"
814 },
815 "python": {
816 "classifiers": [
817 "Framework :: AWS CDK",
818 "Framework :: AWS CDK :: 1"
819 ],
820 "distName": "aws-cdk.aws-s3",
821 "module": "aws_cdk.aws_s3"
822 }
823 }
824 },
825 "@aws-cdk/aws-s3-assets": {
826 "targets": {
827 "dotnet": {
828 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
829 "namespace": "Amazon.CDK.AWS.S3.Assets",
830 "packageId": "Amazon.CDK.AWS.S3.Assets"
831 },
832 "java": {
833 "maven": {
834 "artifactId": "s3-assets",
835 "groupId": "software.amazon.awscdk"
836 },
837 "package": "software.amazon.awscdk.services.s3.assets"
838 },
839 "js": {
840 "npm": "@aws-cdk/aws-s3-assets"
841 },
842 "python": {
843 "classifiers": [
844 "Framework :: AWS CDK",
845 "Framework :: AWS CDK :: 1"
846 ],
847 "distName": "aws-cdk.aws-s3-assets",
848 "module": "aws_cdk.aws_s3_assets"
849 }
850 }
851 },
852 "@aws-cdk/aws-sam": {
853 "targets": {
854 "dotnet": {
855 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
856 "namespace": "Amazon.CDK.AWS.SAM",
857 "packageId": "Amazon.CDK.AWS.SAM"
858 },
859 "java": {
860 "maven": {
861 "artifactId": "sam",
862 "groupId": "software.amazon.awscdk"
863 },
864 "package": "software.amazon.awscdk.services.sam"
865 },
866 "js": {
867 "npm": "@aws-cdk/aws-sam"
868 },
869 "python": {
870 "classifiers": [
871 "Framework :: AWS CDK",
872 "Framework :: AWS CDK :: 1"
873 ],
874 "distName": "aws-cdk.aws-sam",
875 "module": "aws_cdk.aws_sam"
876 }
877 }
878 },
879 "@aws-cdk/aws-secretsmanager": {
880 "targets": {
881 "dotnet": {
882 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
883 "namespace": "Amazon.CDK.AWS.SecretsManager",
884 "packageId": "Amazon.CDK.AWS.SecretsManager"
885 },
886 "java": {
887 "maven": {
888 "artifactId": "secretsmanager",
889 "groupId": "software.amazon.awscdk"
890 },
891 "package": "software.amazon.awscdk.services.secretsmanager"
892 },
893 "js": {
894 "npm": "@aws-cdk/aws-secretsmanager"
895 },
896 "python": {
897 "classifiers": [
898 "Framework :: AWS CDK",
899 "Framework :: AWS CDK :: 1"
900 ],
901 "distName": "aws-cdk.aws-secretsmanager",
902 "module": "aws_cdk.aws_secretsmanager"
903 }
904 }
905 },
906 "@aws-cdk/aws-servicediscovery": {
907 "targets": {
908 "dotnet": {
909 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
910 "namespace": "Amazon.CDK.AWS.ServiceDiscovery",
911 "packageId": "Amazon.CDK.AWS.ServiceDiscovery"
912 },
913 "java": {
914 "maven": {
915 "artifactId": "servicediscovery",
916 "groupId": "software.amazon.awscdk"
917 },
918 "package": "software.amazon.awscdk.services.servicediscovery"
919 },
920 "js": {
921 "npm": "@aws-cdk/aws-servicediscovery"
922 },
923 "python": {
924 "classifiers": [
925 "Framework :: AWS CDK",
926 "Framework :: AWS CDK :: 1"
927 ],
928 "distName": "aws-cdk.aws-servicediscovery",
929 "module": "aws_cdk.aws_servicediscovery"
930 }
931 }
932 },
933 "@aws-cdk/aws-signer": {
934 "targets": {
935 "dotnet": {
936 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
937 "namespace": "Amazon.CDK.AWS.Signer",
938 "packageId": "Amazon.CDK.AWS.Signer"
939 },
940 "java": {
941 "maven": {
942 "artifactId": "signer",
943 "groupId": "software.amazon.awscdk"
944 },
945 "package": "software.amazon.awscdk.services.signer"
946 },
947 "js": {
948 "npm": "@aws-cdk/aws-signer"
949 },
950 "python": {
951 "classifiers": [
952 "Framework :: AWS CDK",
953 "Framework :: AWS CDK :: 1"
954 ],
955 "distName": "aws-cdk.aws-signer",
956 "module": "aws_cdk.aws_signer"
957 }
958 }
959 },
960 "@aws-cdk/aws-sns": {
961 "targets": {
962 "dotnet": {
963 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
964 "namespace": "Amazon.CDK.AWS.SNS",
965 "packageId": "Amazon.CDK.AWS.SNS"
966 },
967 "java": {
968 "maven": {
969 "artifactId": "sns",
970 "groupId": "software.amazon.awscdk"
971 },
972 "package": "software.amazon.awscdk.services.sns"
973 },
974 "js": {
975 "npm": "@aws-cdk/aws-sns"
976 },
977 "python": {
978 "classifiers": [
979 "Framework :: AWS CDK",
980 "Framework :: AWS CDK :: 1"
981 ],
982 "distName": "aws-cdk.aws-sns",
983 "module": "aws_cdk.aws_sns"
984 }
985 }
986 },
987 "@aws-cdk/aws-sns-subscriptions": {
988 "targets": {
989 "dotnet": {
990 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
991 "namespace": "Amazon.CDK.AWS.SNS.Subscriptions",
992 "packageId": "Amazon.CDK.AWS.SNS.Subscriptions"
993 },
994 "java": {
995 "maven": {
996 "artifactId": "sns-subscriptions",
997 "groupId": "software.amazon.awscdk"
998 },
999 "package": "software.amazon.awscdk.services.sns.subscriptions"
1000 },
1001 "js": {
1002 "npm": "@aws-cdk/aws-sns-subscriptions"
1003 },
1004 "python": {
1005 "classifiers": [
1006 "Framework :: AWS CDK",
1007 "Framework :: AWS CDK :: 1"
1008 ],
1009 "distName": "aws-cdk.aws-sns-subscriptions",
1010 "module": "aws_cdk.aws_sns_subscriptions"
1011 }
1012 }
1013 },
1014 "@aws-cdk/aws-sqs": {
1015 "targets": {
1016 "dotnet": {
1017 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1018 "namespace": "Amazon.CDK.AWS.SQS",
1019 "packageId": "Amazon.CDK.AWS.SQS"
1020 },
1021 "java": {
1022 "maven": {
1023 "artifactId": "sqs",
1024 "groupId": "software.amazon.awscdk"
1025 },
1026 "package": "software.amazon.awscdk.services.sqs"
1027 },
1028 "js": {
1029 "npm": "@aws-cdk/aws-sqs"
1030 },
1031 "python": {
1032 "classifiers": [
1033 "Framework :: AWS CDK",
1034 "Framework :: AWS CDK :: 1"
1035 ],
1036 "distName": "aws-cdk.aws-sqs",
1037 "module": "aws_cdk.aws_sqs"
1038 }
1039 }
1040 },
1041 "@aws-cdk/aws-ssm": {
1042 "targets": {
1043 "dotnet": {
1044 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1045 "namespace": "Amazon.CDK.AWS.SSM",
1046 "packageId": "Amazon.CDK.AWS.SSM"
1047 },
1048 "java": {
1049 "maven": {
1050 "artifactId": "ssm",
1051 "groupId": "software.amazon.awscdk"
1052 },
1053 "package": "software.amazon.awscdk.services.ssm"
1054 },
1055 "js": {
1056 "npm": "@aws-cdk/aws-ssm"
1057 },
1058 "python": {
1059 "classifiers": [
1060 "Framework :: AWS CDK",
1061 "Framework :: AWS CDK :: 1"
1062 ],
1063 "distName": "aws-cdk.aws-ssm",
1064 "module": "aws_cdk.aws_ssm"
1065 }
1066 }
1067 },
1068 "@aws-cdk/aws-stepfunctions": {
1069 "targets": {
1070 "dotnet": {
1071 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1072 "namespace": "Amazon.CDK.AWS.StepFunctions",
1073 "packageId": "Amazon.CDK.AWS.StepFunctions"
1074 },
1075 "java": {
1076 "maven": {
1077 "artifactId": "stepfunctions",
1078 "groupId": "software.amazon.awscdk"
1079 },
1080 "package": "software.amazon.awscdk.services.stepfunctions"
1081 },
1082 "js": {
1083 "npm": "@aws-cdk/aws-stepfunctions"
1084 },
1085 "python": {
1086 "classifiers": [
1087 "Framework :: AWS CDK",
1088 "Framework :: AWS CDK :: 1"
1089 ],
1090 "distName": "aws-cdk.aws-stepfunctions",
1091 "module": "aws_cdk.aws_stepfunctions"
1092 }
1093 }
1094 },
1095 "@aws-cdk/cloud-assembly-schema": {
1096 "targets": {
1097 "dotnet": {
1098 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1099 "namespace": "Amazon.CDK.CloudAssembly.Schema",
1100 "packageId": "Amazon.CDK.CloudAssembly.Schema"
1101 },
1102 "java": {
1103 "maven": {
1104 "artifactId": "cdk-cloud-assembly-schema",
1105 "groupId": "software.amazon.awscdk"
1106 },
1107 "package": "software.amazon.awscdk.cloudassembly.schema"
1108 },
1109 "js": {
1110 "npm": "@aws-cdk/cloud-assembly-schema"
1111 },
1112 "python": {
1113 "classifiers": [
1114 "Framework :: AWS CDK",
1115 "Framework :: AWS CDK :: 1"
1116 ],
1117 "distName": "aws-cdk.cloud-assembly-schema",
1118 "module": "aws_cdk.cloud_assembly_schema"
1119 }
1120 }
1121 },
1122 "@aws-cdk/core": {
1123 "targets": {
1124 "dotnet": {
1125 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1126 "namespace": "Amazon.CDK",
1127 "packageId": "Amazon.CDK"
1128 },
1129 "java": {
1130 "maven": {
1131 "artifactId": "core",
1132 "groupId": "software.amazon.awscdk"
1133 },
1134 "package": "software.amazon.awscdk.core"
1135 },
1136 "js": {
1137 "npm": "@aws-cdk/core"
1138 },
1139 "python": {
1140 "classifiers": [
1141 "Framework :: AWS CDK",
1142 "Framework :: AWS CDK :: 1"
1143 ],
1144 "distName": "aws-cdk.core",
1145 "module": "aws_cdk.core"
1146 }
1147 }
1148 },
1149 "@aws-cdk/custom-resources": {
1150 "targets": {
1151 "dotnet": {
1152 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1153 "namespace": "Amazon.CDK.CustomResources",
1154 "packageId": "Amazon.CDK.AWS.CustomResources"
1155 },
1156 "java": {
1157 "maven": {
1158 "artifactId": "cdk-customresources",
1159 "groupId": "software.amazon.awscdk"
1160 },
1161 "package": "software.amazon.awscdk.customresources"
1162 },
1163 "js": {
1164 "npm": "@aws-cdk/custom-resources"
1165 },
1166 "python": {
1167 "classifiers": [
1168 "Framework :: AWS CDK",
1169 "Framework :: AWS CDK :: 1"
1170 ],
1171 "distName": "aws-cdk.custom-resources",
1172 "module": "aws_cdk.custom_resources"
1173 }
1174 }
1175 },
1176 "@aws-cdk/cx-api": {
1177 "targets": {
1178 "dotnet": {
1179 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1180 "namespace": "Amazon.CDK.CXAPI",
1181 "packageId": "Amazon.CDK.CXAPI"
1182 },
1183 "java": {
1184 "maven": {
1185 "artifactId": "cdk-cx-api",
1186 "groupId": "software.amazon.awscdk"
1187 },
1188 "package": "software.amazon.awscdk.cxapi"
1189 },
1190 "js": {
1191 "npm": "@aws-cdk/cx-api"
1192 },
1193 "python": {
1194 "classifiers": [
1195 "Framework :: AWS CDK",
1196 "Framework :: AWS CDK :: 1"
1197 ],
1198 "distName": "aws-cdk.cx-api",
1199 "module": "aws_cdk.cx_api"
1200 }
1201 }
1202 },
1203 "@aws-cdk/region-info": {
1204 "targets": {
1205 "dotnet": {
1206 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1207 "namespace": "Amazon.CDK.RegionInfo",
1208 "packageId": "Amazon.CDK.RegionInfo"
1209 },
1210 "java": {
1211 "maven": {
1212 "artifactId": "cdk-region-info",
1213 "groupId": "software.amazon.awscdk"
1214 },
1215 "package": "software.amazon.awscdk.regioninfo"
1216 },
1217 "js": {
1218 "npm": "@aws-cdk/region-info"
1219 },
1220 "python": {
1221 "classifiers": [
1222 "Framework :: AWS CDK",
1223 "Framework :: AWS CDK :: 1"
1224 ],
1225 "distName": "aws-cdk.region-info",
1226 "module": "aws_cdk.region_info"
1227 }
1228 }
1229 },
1230 "constructs": {
1231 "targets": {
1232 "dotnet": {
1233 "namespace": "Constructs",
1234 "packageId": "Constructs"
1235 },
1236 "go": {
1237 "moduleName": "github.com/aws/constructs-go"
1238 },
1239 "java": {
1240 "maven": {
1241 "artifactId": "constructs",
1242 "groupId": "software.constructs"
1243 },
1244 "package": "software.constructs"
1245 },
1246 "js": {
1247 "npm": "constructs"
1248 },
1249 "python": {
1250 "distName": "constructs",
1251 "module": "constructs"
1252 }
1253 }
1254 }
1255 },
1256 "description": "The CDK Construct Library for AWS::ECS",
1257 "docs": {
1258 "stability": "stable"
1259 },
1260 "homepage": "https://github.com/aws/aws-cdk",
1261 "jsiiVersion": "1.58.0 (build f8ba112)",
1262 "keywords": [
1263 "aws",
1264 "cdk",
1265 "constructs",
1266 "ecs"
1267 ],
1268 "license": "Apache-2.0",
1269 "metadata": {
1270 "jsii": {
1271 "compiledWithDeprecationWarnings": true,
1272 "pacmak": {
1273 "hasDefaultInterfaces": true
1274 },
1275 "rosetta": {
1276 "strict": true
1277 }
1278 }
1279 },
1280 "name": "@aws-cdk/aws-ecs",
1281 "readme": {
1282 "markdown": "# Amazon ECS Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis package contains constructs for working with **Amazon Elastic Container\nService** (Amazon ECS).\n\nAmazon Elastic Container Service (Amazon ECS) is a fully managed container orchestration service.\n\nFor further information on Amazon ECS,\nsee the [Amazon ECS documentation](https://docs.aws.amazon.com/ecs)\n\nThe following example creates an Amazon ECS cluster, adds capacity to it, and\nruns a service on it:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\n// Create an ECS cluster\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\n// Add capacity to it\ncluster.addCapacity('DefaultAutoScalingGroupCapacity', {\n instanceType: new ec2.InstanceType(\"t2.xlarge\"),\n desiredCapacity: 3,\n});\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('DefaultContainer', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 512,\n});\n\n// Instantiate an Amazon ECS Service\nconst ecsService = new ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n});\n```\n\nFor a set of constructs defining common ECS architectural patterns, see the `@aws-cdk/aws-ecs-patterns` package.\n\n## Launch Types: AWS Fargate vs Amazon EC2\n\nThere are two sets of constructs in this library; one to run tasks on Amazon EC2 and\none to run tasks on AWS Fargate.\n\n- Use the `Ec2TaskDefinition` and `Ec2Service` constructs to run tasks on Amazon EC2 instances running in your account.\n- Use the `FargateTaskDefinition` and `FargateService` constructs to run tasks on\n instances that are managed for you by AWS.\n- Use the `ExternalTaskDefinition` and `ExternalService` constructs to run AWS ECS Anywhere tasks on self-managed infrastructure.\n\nHere are the main differences:\n\n- **Amazon EC2**: instances are under your control. Complete control of task to host\n allocation. Required to specify at least a memory reservation or limit for\n every container. Can use Host, Bridge and AwsVpc networking modes. Can attach\n Classic Load Balancer. Can share volumes between container and host.\n- **AWS Fargate**: tasks run on AWS-managed instances, AWS manages task to host\n allocation for you. Requires specification of memory and cpu sizes at the\n taskdefinition level. Only supports AwsVpc networking modes and\n Application/Network Load Balancers. Only the AWS log driver is supported.\n Many host features are not supported such as adding kernel capabilities\n and mounting host devices/volumes inside the container.\n- **AWS ECSAnywhere**: tasks are run and managed by AWS ECS Anywhere on infrastructure owned by the customer. Only Bridge networking mode is supported. Does not support autoscaling, load balancing, cloudmap or attachment of volumes.\n\nFor more information on Amazon EC2 vs AWS Fargate, networking and ECS Anywhere see the AWS Documentation:\n[AWS Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html),\n[Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html),\n[ECS Anywhere](https://aws.amazon.com/ecs/anywhere/)\n\n## Clusters\n\nA `Cluster` defines the infrastructure to run your\ntasks on. You can run many tasks on a single cluster.\n\nThe following code creates a cluster that can run AWS Fargate tasks:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n```\n\nThe following code imports an existing cluster using the ARN which can be used to\nimport an Amazon ECS service either EC2 or Fargate.\n\n```ts\nconst clusterArn = 'arn:aws:ecs:us-east-1:012345678910:cluster/clusterName';\n\nconst cluster = ecs.Cluster.fromClusterArn(this, 'Cluster', clusterArn);\n```\n\nTo use tasks with Amazon EC2 launch-type, you have to add capacity to\nthe cluster in order for tasks to be scheduled on your instances. Typically,\nyou add an AutoScalingGroup with instances running the latest\nAmazon ECS-optimized AMI to the cluster. There is a method to build and add such an\nAutoScalingGroup automatically, or you can supply a customized AutoScalingGroup\nthat you construct yourself. It's possible to add multiple AutoScalingGroups\nwith various instance types.\n\nThe following example creates an Amazon ECS cluster and adds capacity to it:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\n// Either add default capacity\ncluster.addCapacity('DefaultAutoScalingGroupCapacity', {\n instanceType: new ec2.InstanceType(\"t2.xlarge\"),\n desiredCapacity: 3,\n});\n\n// Or add customized capacity. Be sure to start the Amazon ECS-optimized AMI.\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.xlarge'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux(),\n // Or use Amazon ECS-Optimized Amazon Linux 2 AMI\n // machineImage: EcsOptimizedImage.amazonLinux2(),\n desiredCapacity: 3,\n // ... other options here ...\n});\n\ncluster.addAutoScalingGroup(autoScalingGroup);\n```\n\nIf you omit the property `vpc`, the construct will create a new VPC with two AZs.\n\nBy default, all machine images will auto-update to the latest version\non each deployment, causing a replacement of the instances in your AutoScalingGroup\nif the AMI has been updated since the last deployment.\n\nIf task draining is enabled, ECS will transparently reschedule tasks on to the new\ninstances before terminating your old instances. If you have disabled task draining,\nthe tasks will be terminated along with the instance. To prevent that, you\ncan pick a non-updating AMI by passing `cacheInContext: true`, but be sure\nto periodically update to the latest AMI manually by using the [CDK CLI\ncontext management commands](https://docs.aws.amazon.com/cdk/latest/guide/context.html):\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n machineImage: ecs.EcsOptimizedImage.amazonLinux({ cachedInContext: true }),\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n});\n```\n\n### Bottlerocket\n\n[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open source operating system that is\npurpose-built by AWS for running containers. You can launch Amazon ECS container instances with the Bottlerocket AMI.\n\nThe following example will create a capacity with self-managed Amazon EC2 capacity of 2 `c5.large` Linux instances running with `Bottlerocket` AMI.\n\nThe following example adds Bottlerocket capacity to the cluster:\n\n```ts\ndeclare const cluster: ecs.Cluster;\n\ncluster.addCapacity('bottlerocket-asg', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c5.large'),\n machineImage: new ecs.BottleRocketImage(),\n});\n```\n\n### ARM64 (Graviton) Instances\n\nTo launch instances with ARM64 hardware, you can use the Amazon ECS-optimized\nAmazon Linux 2 (arm64) AMI. Based on Amazon Linux 2, this AMI is recommended\nfor use when launching your EC2 instances that are powered by Arm-based AWS\nGraviton Processors.\n\n```ts\ndeclare const cluster: ecs.Cluster;\n\ncluster.addCapacity('graviton-cluster', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c6g.large'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(ecs.AmiHardwareType.ARM),\n});\n```\n\nBottlerocket is also supported:\n\n```ts\ndeclare const cluster: ecs.Cluster;\n\ncluster.addCapacity('graviton-cluster', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c6g.large'),\n machineImageType: ecs.MachineImageType.BOTTLEROCKET,\n});\n```\n\n### Spot Instances\n\nTo add spot instances into the cluster, you must specify the `spotPrice` in the `ecs.AddCapacityOptions` and optionally enable the `spotInstanceDraining` property.\n\n```ts\ndeclare const cluster: ecs.Cluster;\n\n// Add an AutoScalingGroup with spot instances to the existing cluster\ncluster.addCapacity('AsgSpot', {\n maxCapacity: 2,\n minCapacity: 2,\n desiredCapacity: 2,\n instanceType: new ec2.InstanceType('c5.xlarge'),\n spotPrice: '0.0735',\n // Enable the Automated Spot Draining support for Amazon ECS\n spotInstanceDraining: true,\n});\n```\n\n### SNS Topic Encryption\n\nWhen the `ecs.AddCapacityOptions` that you provide has a non-zero `taskDrainTime` (the default) then an SNS topic and Lambda are created to ensure that the\ncluster's instances have been properly drained of tasks before terminating. The SNS Topic is sent the instance-terminating lifecycle event from the AutoScalingGroup,\nand the Lambda acts on that event. If you wish to engage [server-side encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for this SNS Topic\nthen you may do so by providing a KMS key for the `topicEncryptionKey` property of `ecs.AddCapacityOptions`.\n\n```ts\n// Given\ndeclare const cluster: ecs.Cluster;\ndeclare const key: kms.Key;\n// Then, use that key to encrypt the lifecycle-event SNS Topic.\ncluster.addCapacity('ASGEncryptedSNS', {\n instanceType: new ec2.InstanceType(\"t2.xlarge\"),\n desiredCapacity: 3,\n topicEncryptionKey: key,\n});\n```\n\n## Task definitions\n\nA task definition describes what a single copy of a **task** should look like.\nA task definition has one or more containers; typically, it has one\nmain container (the *default container* is the first one that's added\nto the task definition, and it is marked *essential*) and optionally\nsome supporting containers which are used to support the main container,\ndoings things like upload logs or metrics to monitoring services.\n\nTo run a task or service with Amazon EC2 launch type, use the `Ec2TaskDefinition`. For AWS Fargate tasks/services, use the\n`FargateTaskDefinition`. For AWS ECS Anywhere use the `ExternalTaskDefinition`. These classes\nprovide simplified APIs that only contain properties relevant for each specific launch type.\n\nFor a `FargateTaskDefinition`, specify the task size (`memoryLimitMiB` and `cpu`):\n\n```ts\nconst fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\n```\n\nOn Fargate Platform Version 1.4.0 or later, you may specify up to 200GiB of\n[ephemeral storage](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-storage.html#fargate-task-storage-pv14):\n\n```ts\nconst fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n ephemeralStorageGiB: 100,\n});\n```\n\nTo add containers to a task definition, call `addContainer()`:\n\n```ts\nconst fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\nconst container = fargateTaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n // ... other options here ...\n});\n```\n\nFor a `Ec2TaskDefinition`:\n\n```ts\nconst ec2TaskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef', {\n networkMode: ecs.NetworkMode.BRIDGE,\n});\n\nconst container = ec2TaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n // ... other options here ...\n});\n```\n\nFor an `ExternalTaskDefinition`:\n\n```ts\nconst externalTaskDefinition = new ecs.ExternalTaskDefinition(this, 'TaskDef');\n\nconst container = externalTaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n // ... other options here ...\n});\n```\n\nYou can specify container properties when you add them to the task definition, or with various methods, e.g.:\n\nTo add a port mapping when adding a container to the task definition, specify the `portMappings` option:\n\n```ts\ndeclare const taskDefinition: ecs.TaskDefinition;\n\ntaskDefinition.addContainer(\"WebContainer\", {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n portMappings: [{ containerPort: 3000 }],\n});\n```\n\nTo add port mappings directly to a container definition, call `addPortMappings()`:\n\n```ts\ndeclare const container: ecs.ContainerDefinition;\n\ncontainer.addPortMappings({\n containerPort: 3000,\n});\n```\n\nTo add data volumes to a task definition, call `addVolume()`:\n\n```ts\nconst fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\nconst volume = {\n // Use an Elastic FileSystem\n name: \"mydatavolume\",\n efsVolumeConfiguration: {\n fileSystemId: \"EFS\",\n // ... other options here ...\n },\n};\n\nconst container = fargateTaskDefinition.addVolume(volume);\n```\n\n> Note: ECS Anywhere doesn't support volume attachments in the task definition.\n\nTo use a TaskDefinition that can be used with either Amazon EC2 or\nAWS Fargate launch types, use the `TaskDefinition` construct.\n\nWhen creating a task definition you have to specify what kind of\ntasks you intend to run: Amazon EC2, AWS Fargate, or both.\nThe following example uses both:\n\n```ts\nconst taskDefinition = new ecs.TaskDefinition(this, 'TaskDef', {\n memoryMiB: '512',\n cpu: '256',\n networkMode: ecs.NetworkMode.AWS_VPC,\n compatibility: ecs.Compatibility.EC2_AND_FARGATE,\n});\n```\n\n### Images\n\nImages supply the software that runs inside the container. Images can be\nobtained from either DockerHub or from ECR repositories, built directly from a local Dockerfile, or use an existing tarball.\n\n- `ecs.ContainerImage.fromRegistry(imageName)`: use a public image.\n- `ecs.ContainerImage.fromRegistry(imageName, { credentials: mySecret })`: use a private image that requires credentials.\n- `ecs.ContainerImage.fromEcrRepository(repo, tagOrDigest)`: use the given ECR repository as the image\n to start. If no tag or digest is provided, \"latest\" is assumed.\n- `ecs.ContainerImage.fromAsset('./image')`: build and upload an\n image directly from a `Dockerfile` in your source directory.\n- `ecs.ContainerImage.fromDockerImageAsset(asset)`: uses an existing\n `@aws-cdk/aws-ecr-assets.DockerImageAsset` as a container image.\n- `ecs.ContainerImage.fromTarball(file)`: use an existing tarball.\n- `new ecs.TagParameterContainerImage(repository)`: use the given ECR repository as the image\n but a CloudFormation parameter as the tag.\n\n### Environment variables\n\nTo pass environment variables to the container, you can use the `environment`, `environmentFiles`, and `secrets` props.\n\n```ts\ndeclare const secret: secretsmanager.Secret;\ndeclare const dbSecret: secretsmanager.Secret;\ndeclare const parameter: ssm.StringParameter;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const s3Bucket: s3.Bucket;\n\nconst newContainer = taskDefinition.addContainer('container', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n environment: { // clear text, not for sensitive data\n STAGE: 'prod',\n },\n environmentFiles: [ // list of environment files hosted either on local disk or S3\n ecs.EnvironmentFile.fromAsset('./demo-env-file.env'),\n ecs.EnvironmentFile.fromBucket(s3Bucket, 'assets/demo-env-file.env'),\n ],\n secrets: { // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store at container start-up.\n SECRET: ecs.Secret.fromSecretsManager(secret),\n DB_PASSWORD: ecs.Secret.fromSecretsManager(dbSecret, 'password'), // Reference a specific JSON field, (requires platform version 1.4.0 or later for Fargate tasks)\n API_KEY: ecs.Secret.fromSecretsManagerVersion(secret, { versionId: '12345' }, 'apiKey'), // Reference a specific version of the secret by its version id or version stage (requires platform version 1.4.0 or later for Fargate tasks)\n PARAMETER: ecs.Secret.fromSsmParameter(parameter),\n },\n});\nnewContainer.addEnvironment('QUEUE_NAME', 'MyQueue');\n```\n\nThe task execution role is automatically granted read permissions on the secrets/parameters. Support for environment\nfiles is restricted to the EC2 launch type for files hosted on S3. Further details provided in the AWS documentation\nabout [specifying environment variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html).\n\n### System controls\n\nTo set system controls (kernel parameters) on the container, use the `systemControls` prop:\n\n```ts\ndeclare const taskDefinition: ecs.TaskDefinition;\n\ntaskDefinition.addContainer('container', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n systemControls: [\n {\n namespace: 'net',\n value: 'ipv4.tcp_tw_recycle',\n },\n ],\n});\n```\n\n### Using Windows containers on Fargate\n\nAWS Fargate supports Amazon ECS Windows containers. For more details, please see this [blog post](https://aws.amazon.com/tw/blogs/containers/running-windows-containers-with-amazon-ecs-on-aws-fargate/)\n\n```ts\n// Create a Task Definition for the Windows container to start\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,\n cpuArchitecture: ecs.CpuArchitecture.X86_64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('windowsservercore', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),\n});\n```\n\n### Using Graviton2 with Fargate\n\nAWS Graviton2 supports AWS Fargate. For more details, please see this [blog post](https://aws.amazon.com/blogs/aws/announcing-aws-graviton2-support-for-aws-fargate-get-up-to-40-better-price-performance-for-your-serverless-containers/)\n\n```ts\n// Create a Task Definition for running container on Graviton Runtime.\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.LINUX,\n cpuArchitecture: ecs.CpuArchitecture.ARM64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('webarm64', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'graviton2-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('public.ecr.aws/nginx/nginx:latest-arm64v8'),\n});\n```\n\n## Service\n\nA `Service` instantiates a `TaskDefinition` on a `Cluster` a given number of\ntimes, optionally associating them with a load balancer.\nIf a task fails,\nAmazon ECS automatically restarts the task.\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\n\nconst service = new ecs.FargateService(this, 'Service', {\n cluster,\n taskDefinition,\n desiredCount: 5,\n});\n```\n\nECS Anywhere service definition looks like:\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\n\nconst service = new ecs.ExternalService(this, 'Service', {\n cluster,\n taskDefinition,\n desiredCount: 5,\n});\n```\n\n`Services` by default will create a security group if not provided.\nIf you'd like to specify which security groups to use you can override the `securityGroups` property.\n\n### Deployment circuit breaker and rollback\n\nAmazon ECS [deployment circuit breaker](https://aws.amazon.com/tw/blogs/containers/announcing-amazon-ecs-deployment-circuit-breaker/)\nautomatically rolls back unhealthy service deployments without the need for manual intervention. Use `circuitBreaker` to enable\ndeployment circuit breaker and optionally enable `rollback` for automatic rollback. See [Using the deployment circuit breaker](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)\nfor more details.\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst service = new ecs.FargateService(this, 'Service', {\n cluster,\n taskDefinition,\n circuitBreaker: { rollback: true },\n});\n```\n\n> Note: ECS Anywhere doesn't support deployment circuit breakers and rollback.\n\n### Include an application/network load balancer\n\n`Services` are load balancing targets and can be added to a target group, which will be attached to an application/network load balancers:\n\n```ts\ndeclare const vpc: ec2.Vpc;\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nconst targetGroup1 = listener.addTargets('ECS1', {\n port: 80,\n targets: [service],\n});\nconst targetGroup2 = listener.addTargets('ECS2', {\n port: 80,\n targets: [service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 8080\n })],\n});\n```\n\n> Note: ECS Anywhere doesn't support application/network load balancers.\n\nNote that in the example above, the default `service` only allows you to register the first essential container or the first mapped port on the container as a target and add it to a new target group. To have more control over which container and port to register as targets, you can use `service.loadBalancerTarget()` to return a load balancing target for a specific container and port.\n\nAlternatively, you can also create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly.\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);\n```\n\n### Using a Load Balancer from a different Stack\n\nIf you want to put your Load Balancer and the Service it is load balancing to in\ndifferent stacks, you may not be able to use the convenience methods\n`loadBalancer.addListener()` and `listener.addTargets()`.\n\nThe reason is that these methods will create resources in the same Stack as the\nobject they're called on, which may lead to cyclic references between stacks.\nInstead, you will have to create an `ApplicationListener` in the service stack,\nor an empty `TargetGroup` in the load balancer stack that you attach your\nservice to.\n\nSee the [ecs/cross-stack-load-balancer example](https://github.com/aws-samples/aws-cdk-examples/tree/master/typescript/ecs/cross-stack-load-balancer/)\nfor the alternatives.\n\n### Include a classic load balancer\n\n`Services` can also be directly attached to a classic load balancer as targets:\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elb.LoadBalancer(this, 'LB', { vpc });\nlb.addListener({ externalPort: 80 });\nlb.addTarget(service);\n```\n\nSimilarly, if you want to have more control over load balancer targeting:\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elb.LoadBalancer(this, 'LB', { vpc });\nlb.addListener({ externalPort: 80 });\nlb.addTarget(service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 80,\n}));\n```\n\nThere are two higher-level constructs available which include a load balancer for you that can be found in the aws-ecs-patterns module:\n\n- `LoadBalancedFargateService`\n- `LoadBalancedEc2Service`\n\n## Task Auto-Scaling\n\nYou can configure the task count of a service to match demand. Task auto-scaling is\nconfigured by calling `autoScaleTaskCount()`:\n\n```ts\ndeclare const target: elbv2.ApplicationTargetGroup;\ndeclare const service: ecs.BaseService;\nconst scaling = service.autoScaleTaskCount({ maxCapacity: 10 });\nscaling.scaleOnCpuUtilization('CpuScaling', {\n targetUtilizationPercent: 50,\n});\n\nscaling.scaleOnRequestCount('RequestScaling', {\n requestsPerTarget: 10000,\n targetGroup: target,\n});\n```\n\nTask auto-scaling is powered by *Application Auto-Scaling*.\nSee that section for details.\n\n## Integration with CloudWatch Events\n\nTo start an Amazon ECS task on an Amazon EC2-backed Cluster, instantiate an\n`@aws-cdk/aws-events-targets.EcsTask` instead of an `Ec2Service`:\n\n```ts\ndeclare const cluster: ecs.Cluster;\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromAsset(path.resolve(__dirname, '..', 'eventhandler-image')),\n memoryLimitMiB: 256,\n logging: new ecs.AwsLogDriver({ streamPrefix: 'EventDemo', mode: ecs.AwsLogDriverMode.NON_BLOCKING }),\n});\n\n// An Rule that describes the event trigger (in this case a scheduled run)\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.expression('rate(1 min)'),\n});\n\n// Pass an environment variable to the container 'TheContainer' in the task\nrule.addTarget(new targets.EcsTask({\n cluster,\n taskDefinition,\n taskCount: 1,\n containerOverrides: [{\n containerName: 'TheContainer',\n environment: [{\n name: 'I_WAS_TRIGGERED',\n value: 'From CloudWatch Events'\n }],\n }],\n}));\n```\n\n## Log Drivers\n\nCurrently Supported Log Drivers:\n\n- awslogs\n- fluentd\n- gelf\n- journald\n- json-file\n- splunk\n- syslog\n- awsfirelens\n- Generic\n\n### awslogs Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.awsLogs({ streamPrefix: 'EventDemo' }),\n});\n```\n\n### fluentd Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.fluentd(),\n});\n```\n\n### gelf Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.gelf({ address: 'my-gelf-address' }),\n});\n```\n\n### journald Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.journald(),\n});\n```\n\n### json-file Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.jsonFile(),\n});\n```\n\n### splunk Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.splunk({\n token: SecretValue.secretsManager('my-splunk-token'),\n url: 'my-splunk-url',\n }),\n});\n```\n\n### syslog Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.syslog(),\n});\n```\n\n### firelens Log Driver\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.firelens({\n options: {\n Name: 'firehose',\n region: 'us-west-2',\n delivery_stream: 'my-stream',\n },\n }),\n});\n```\n\nTo pass secrets to the log configuration, use the `secretOptions` property of the log configuration. The task execution role is automatically granted read permissions on the secrets/parameters.\n\n```ts\ndeclare const secret: secretsmanager.Secret;\ndeclare const parameter: ssm.StringParameter;\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.firelens({\n options: {\n // ... log driver options here ...\n },\n secretOptions: { // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store\n apikey: ecs.Secret.fromSecretsManager(secret),\n host: ecs.Secret.fromSsmParameter(parameter),\n },\n }),\n});\n```\n\n### Generic Log Driver\n\nA generic log driver object exists to provide a lower level abstraction of the log driver configuration.\n\n```ts\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: new ecs.GenericLogDriver({\n logDriver: 'fluentd',\n options: {\n tag: 'example-tag',\n },\n }),\n});\n```\n\n## CloudMap Service Discovery\n\nTo register your ECS service with a CloudMap Service Registry, you may add the\n`cloudMapOptions` property to your service:\n\n```ts\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\nconst service = new ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create A records - useful for AWSVPC network mode.\n dnsRecordType: cloudmap.DnsRecordType.A,\n },\n});\n```\n\nWith `bridge` or `host` network modes, only `SRV` DNS record types are supported.\nBy default, `SRV` DNS record types will target the default container and default\nport. However, you may target a different container and port on the same ECS task:\n\n```ts\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\n// Add a container to the task definition\nconst specificContainer = taskDefinition.addContainer('Container', {\n image: ecs.ContainerImage.fromRegistry('/aws/aws-example-app'),\n memoryLimitMiB: 2048,\n});\n\n// Add a port mapping\nspecificContainer.addPortMappings({\n containerPort: 7600,\n protocol: ecs.Protocol.TCP,\n});\n\nnew ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create SRV records - useful for bridge networking\n dnsRecordType: cloudmap.DnsRecordType.SRV,\n // Targets port TCP port 7600 `specificContainer`\n container: specificContainer,\n containerPort: 7600,\n },\n});\n```\n\n### Associate With a Specific CloudMap Service\n\nYou may associate an ECS service with a specific CloudMap service. To do\nthis, use the service's `associateCloudMapService` method:\n\n```ts\ndeclare const cloudMapService: cloudmap.Service;\ndeclare const ecsService: ecs.FargateService;\n\necsService.associateCloudMapService({\n service: cloudMapService,\n});\n```\n\n## Capacity Providers\n\nThere are two major families of Capacity Providers: [AWS\nFargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html)\n(including Fargate Spot) and EC2 [Auto Scaling\nGroup](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html)\nCapacity Providers. Both are supported.\n\n### Fargate Capacity Providers\n\nTo enable Fargate capacity providers, you can either set\n`enableFargateCapacityProviders` to `true` when creating your cluster, or by\ninvoking the `enableFargateCapacityProviders()` method after creating your\ncluster. This will add both `FARGATE` and `FARGATE_SPOT` as available capacity\nproviders on your cluster.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'FargateCPCluster', {\n vpc,\n enableFargateCapacityProviders: true,\n});\n\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n});\n\nnew ecs.FargateService(this, 'FargateService', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: 'FARGATE_SPOT',\n weight: 2,\n },\n {\n capacityProvider: 'FARGATE',\n weight: 1,\n },\n ],\n});\n```\n\n### Auto Scaling Group Capacity Providers\n\nTo add an Auto Scaling Group Capacity Provider, first create an EC2 Auto Scaling\nGroup. Then, create an `AsgCapacityProvider` and pass the Auto Scaling Group to\nit in the constructor. Then add the Capacity Provider to the cluster. Finally,\nyou can refer to the Provider by its name in your service's or task's Capacity\nProvider strategy.\n\nBy default, an Auto Scaling Group Capacity Provider will manage the Auto Scaling\nGroup's size for you. It will also enable managed termination protection, in\norder to prevent EC2 Auto Scaling from terminating EC2 instances that have tasks\nrunning on them. If you want to disable this behavior, set both\n`enableManagedScaling` to and `enableManagedTerminationProtection` to `false`.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(),\n minCapacity: 0,\n maxCapacity: 100,\n});\n\nconst capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {\n autoScalingGroup,\n});\ncluster.addAsgCapacityProvider(capacityProvider);\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n memoryReservationMiB: 256,\n});\n\nnew ecs.Ec2Service(this, 'EC2Service', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: capacityProvider.capacityProviderName,\n weight: 1,\n },\n ],\n});\n```\n\n## Elastic Inference Accelerators\n\nCurrently, this feature is only supported for services with EC2 launch types.\n\nTo add elastic inference accelerators to your EC2 instance, first add\n`inferenceAccelerators` field to the Ec2TaskDefinition and set the `deviceName`\nand `deviceType` properties.\n\n```ts\nconst inferenceAccelerators = [{\n deviceName: 'device1',\n deviceType: 'eia2.medium',\n}];\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'Ec2TaskDef', {\n inferenceAccelerators,\n});\n```\n\nTo enable using the inference accelerators in the containers, add `inferenceAcceleratorResources`\nfield and set it to a list of device names used for the inference accelerators. Each value in the\nlist should match a `DeviceName` for an `InferenceAccelerator` specified in the task definition.\n\n```ts\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst inferenceAcceleratorResources = ['device1'];\n\ntaskDefinition.addContainer('cont', {\n image: ecs.ContainerImage.fromRegistry('test'),\n memoryLimitMiB: 1024,\n inferenceAcceleratorResources,\n});\n```\n\n## ECS Exec command\n\nPlease note, ECS Exec leverages AWS Systems Manager (SSM). So as a prerequisite for the exec command\nto work, you need to have the SSM plugin for the AWS CLI installed locally. For more information, see\n[Install Session Manager plugin for AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html).\n\nTo enable the ECS Exec feature for your containers, set the boolean flag `enableExecuteCommand` to `true` in\nyour `Ec2Service` or `FargateService`.\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\n\nconst service = new ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n enableExecuteCommand: true,\n});\n```\n\n### Enabling logging\n\nYou can enable sending logs of your execute session commands to a CloudWatch log group or S3 bucket by configuring\nthe `executeCommandConfiguration` property for your cluster. The default configuration will send the\nlogs to the CloudWatch Logs using the `awslogs` log driver that is configured in your task definition. Please note,\nwhen using your own `logConfiguration` the log group or S3 Bucket specified must already be created.\n\nTo encrypt data using your own KMS Customer Key (CMK), you must create a CMK and provide the key in the `kmsKey` field\nof the `executeCommandConfiguration`. To use this key for encrypting CloudWatch log data or S3 bucket, make sure to associate the key\nto these resources on creation.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst kmsKey = new kms.Key(this, 'KmsKey');\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the log group\nconst logGroup = new logs.LogGroup(this, 'LogGroup', {\n encryptionKey: kmsKey,\n});\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket\nconst execBucket = new s3.Bucket(this, 'EcsExecBucket', {\n encryptionKey: kmsKey,\n});\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n executeCommandConfiguration: {\n kmsKey,\n logConfiguration: {\n cloudWatchLogGroup: logGroup,\n cloudWatchEncryptionEnabled: true,\n s3Bucket: execBucket,\n s3EncryptionEnabled: true,\n s3KeyPrefix: 'exec-command-output',\n },\n logging: ecs.ExecuteCommandLogging.OVERRIDE,\n },\n});\n```\n"
1283 },
1284 "repository": {
1285 "directory": "packages/@aws-cdk/aws-ecs",
1286 "type": "git",
1287 "url": "https://github.com/aws/aws-cdk.git"
1288 },
1289 "schema": "jsii/0.10.0",
1290 "targets": {
1291 "dotnet": {
1292 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
1293 "namespace": "Amazon.CDK.AWS.ECS",
1294 "packageId": "Amazon.CDK.AWS.ECS"
1295 },
1296 "java": {
1297 "maven": {
1298 "artifactId": "ecs",
1299 "groupId": "software.amazon.awscdk"
1300 },
1301 "package": "software.amazon.awscdk.services.ecs"
1302 },
1303 "js": {
1304 "npm": "@aws-cdk/aws-ecs"
1305 },
1306 "python": {
1307 "classifiers": [
1308 "Framework :: AWS CDK",
1309 "Framework :: AWS CDK :: 1"
1310 ],
1311 "distName": "aws-cdk.aws-ecs",
1312 "module": "aws_cdk.aws_ecs"
1313 }
1314 },
1315 "types": {
1316 "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions": {
1317 "assembly": "@aws-cdk/aws-ecs",
1318 "datatype": true,
1319 "docs": {
1320 "stability": "stable",
1321 "summary": "The properties for adding an AutoScalingGroup.",
1322 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const key: kms.Key;\nconst addAutoScalingGroupCapacityOptions: ecs.AddAutoScalingGroupCapacityOptions = {\n canContainersAccessInstanceRole: false,\n machineImageType: ecs.MachineImageType.AMAZON_LINUX_2,\n spotInstanceDraining: false,\n taskDrainTime: cdk.Duration.minutes(30),\n topicEncryptionKey: key,\n};",
1323 "custom": {
1324 "exampleMetadata": "fixture=_generated"
1325 }
1326 },
1327 "fqn": "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions",
1328 "kind": "interface",
1329 "locationInModule": {
1330 "filename": "lib/cluster.ts",
1331 "line": 783
1332 },
1333 "name": "AddAutoScalingGroupCapacityOptions",
1334 "properties": [
1335 {
1336 "abstract": true,
1337 "docs": {
1338 "default": "false",
1339 "stability": "stable",
1340 "summary": "Specifies whether the containers can access the container instance role."
1341 },
1342 "immutable": true,
1343 "locationInModule": {
1344 "filename": "lib/cluster.ts",
1345 "line": 789
1346 },
1347 "name": "canContainersAccessInstanceRole",
1348 "optional": true,
1349 "type": {
1350 "primitive": "boolean"
1351 }
1352 },
1353 {
1354 "abstract": true,
1355 "docs": {
1356 "default": "- Automatically determined from `machineImage`, if available, otherwise `MachineImageType.AMAZON_LINUX_2`.",
1357 "remarks": "Depending on the setting, different UserData will automatically be added\nto the `AutoScalingGroup` to configure it properly for use with ECS.\n\nIf you create an `AutoScalingGroup` yourself and are adding it via\n`addAutoScalingGroup()`, you must specify this value. If you are adding an\n`autoScalingGroup` via `addCapacity`, this value will be determined\nfrom the `machineImage` you pass.",
1358 "stability": "stable",
1359 "summary": "What type of machine image this is."
1360 },
1361 "immutable": true,
1362 "locationInModule": {
1363 "filename": "lib/cluster.ts",
1364 "line": 836
1365 },
1366 "name": "machineImageType",
1367 "optional": true,
1368 "type": {
1369 "fqn": "@aws-cdk/aws-ecs.MachineImageType"
1370 }
1371 },
1372 {
1373 "abstract": true,
1374 "docs": {
1375 "default": "false",
1376 "remarks": "For more information, see [Using Spot Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html).",
1377 "stability": "stable",
1378 "summary": "Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services."
1379 },
1380 "immutable": true,
1381 "locationInModule": {
1382 "filename": "lib/cluster.ts",
1383 "line": 811
1384 },
1385 "name": "spotInstanceDraining",
1386 "optional": true,
1387 "type": {
1388 "primitive": "boolean"
1389 }
1390 },
1391 {
1392 "abstract": true,
1393 "docs": {
1394 "default": "Duration.minutes(5)",
1395 "deprecated": "The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead.",
1396 "remarks": "This creates a Lambda function that is used by a lifecycle hook for the\nAutoScalingGroup that will delay instance termination until all ECS tasks\nhave drained from the instance. Set to 0 to disable task draining.\n\nSet to 0 to disable task draining.",
1397 "stability": "deprecated",
1398 "summary": "The time period to wait before force terminating an instance that is draining."
1399 },
1400 "immutable": true,
1401 "locationInModule": {
1402 "filename": "lib/cluster.ts",
1403 "line": 803
1404 },
1405 "name": "taskDrainTime",
1406 "optional": true,
1407 "type": {
1408 "fqn": "@aws-cdk/core.Duration"
1409 }
1410 },
1411 {
1412 "abstract": true,
1413 "docs": {
1414 "default": "The SNS Topic will not be encrypted.",
1415 "stability": "stable",
1416 "summary": "If {@link AddAutoScalingGroupCapacityOptions.taskDrainTime} is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information."
1417 },
1418 "immutable": true,
1419 "locationInModule": {
1420 "filename": "lib/cluster.ts",
1421 "line": 821
1422 },
1423 "name": "topicEncryptionKey",
1424 "optional": true,
1425 "type": {
1426 "fqn": "@aws-cdk/aws-kms.IKey"
1427 }
1428 }
1429 ],
1430 "symbolId": "lib/cluster:AddAutoScalingGroupCapacityOptions"
1431 },
1432 "@aws-cdk/aws-ecs.AddCapacityOptions": {
1433 "assembly": "@aws-cdk/aws-ecs",
1434 "datatype": true,
1435 "docs": {
1436 "custom": {
1437 "exampleMetadata": "infused"
1438 },
1439 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\n// Either add default capacity\ncluster.addCapacity('DefaultAutoScalingGroupCapacity', {\n instanceType: new ec2.InstanceType(\"t2.xlarge\"),\n desiredCapacity: 3,\n});\n\n// Or add customized capacity. Be sure to start the Amazon ECS-optimized AMI.\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.xlarge'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux(),\n // Or use Amazon ECS-Optimized Amazon Linux 2 AMI\n // machineImage: EcsOptimizedImage.amazonLinux2(),\n desiredCapacity: 3,\n // ... other options here ...\n});\n\ncluster.addAutoScalingGroup(autoScalingGroup);",
1440 "stability": "stable",
1441 "summary": "The properties for adding instance capacity to an AutoScalingGroup."
1442 },
1443 "fqn": "@aws-cdk/aws-ecs.AddCapacityOptions",
1444 "interfaces": [
1445 "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions",
1446 "@aws-cdk/aws-autoscaling.CommonAutoScalingGroupProps"
1447 ],
1448 "kind": "interface",
1449 "locationInModule": {
1450 "filename": "lib/cluster.ts",
1451 "line": 842
1452 },
1453 "name": "AddCapacityOptions",
1454 "properties": [
1455 {
1456 "abstract": true,
1457 "docs": {
1458 "stability": "stable",
1459 "summary": "The EC2 instance type to use when launching instances into the AutoScalingGroup."
1460 },
1461 "immutable": true,
1462 "locationInModule": {
1463 "filename": "lib/cluster.ts",
1464 "line": 846
1465 },
1466 "name": "instanceType",
1467 "type": {
1468 "fqn": "@aws-cdk/aws-ec2.InstanceType"
1469 }
1470 },
1471 {
1472 "abstract": true,
1473 "docs": {
1474 "default": "- Automatically updated, ECS-optimized Amazon Linux 2",
1475 "remarks": "The default is to use an ECS-optimized AMI of Amazon Linux 2 which is\nautomatically updated to the latest version on every deployment. This will\nreplace the instances in the AutoScalingGroup. Make sure you have not disabled\ntask draining, to avoid downtime when the AMI updates.\n\nTo use an image that does not update on every deployment, pass:\n\n```ts\nconst machineImage = ecs.EcsOptimizedImage.amazonLinux2(ecs.AmiHardwareType.STANDARD, {\n cachedInContext: true,\n});\n```\n\nFor more information, see [Amazon ECS-optimized\nAMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).\n\nYou must define either `machineImage` or `machineImageType`, not both.",
1476 "stability": "stable",
1477 "summary": "The ECS-optimized AMI variant to use."
1478 },
1479 "immutable": true,
1480 "locationInModule": {
1481 "filename": "lib/cluster.ts",
1482 "line": 871
1483 },
1484 "name": "machineImage",
1485 "optional": true,
1486 "type": {
1487 "fqn": "@aws-cdk/aws-ec2.IMachineImage"
1488 }
1489 }
1490 ],
1491 "symbolId": "lib/cluster:AddCapacityOptions"
1492 },
1493 "@aws-cdk/aws-ecs.AmiHardwareType": {
1494 "assembly": "@aws-cdk/aws-ecs",
1495 "docs": {
1496 "custom": {
1497 "exampleMetadata": "infused"
1498 },
1499 "example": "declare const cluster: ecs.Cluster;\n\ncluster.addCapacity('graviton-cluster', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c6g.large'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(ecs.AmiHardwareType.ARM),\n});",
1500 "remarks": "For more information, see\n[Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).",
1501 "stability": "stable",
1502 "summary": "The ECS-optimized AMI variant to use."
1503 },
1504 "fqn": "@aws-cdk/aws-ecs.AmiHardwareType",
1505 "kind": "enum",
1506 "locationInModule": {
1507 "filename": "lib/amis.ts",
1508 "line": 12
1509 },
1510 "members": [
1511 {
1512 "docs": {
1513 "stability": "stable",
1514 "summary": "Use the standard Amazon ECS-optimized AMI."
1515 },
1516 "name": "STANDARD"
1517 },
1518 {
1519 "docs": {
1520 "stability": "stable",
1521 "summary": "Use the Amazon ECS GPU-optimized AMI."
1522 },
1523 "name": "GPU"
1524 },
1525 {
1526 "docs": {
1527 "stability": "stable",
1528 "summary": "Use the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI."
1529 },
1530 "name": "ARM"
1531 }
1532 ],
1533 "name": "AmiHardwareType",
1534 "symbolId": "lib/amis:AmiHardwareType"
1535 },
1536 "@aws-cdk/aws-ecs.AppMeshProxyConfiguration": {
1537 "assembly": "@aws-cdk/aws-ecs",
1538 "base": "@aws-cdk/aws-ecs.ProxyConfiguration",
1539 "docs": {
1540 "remarks": "For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version\n1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized\nAMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init.\nFor more information, see [Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).\n\nFor tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.",
1541 "stability": "stable",
1542 "summary": "The class for App Mesh proxy configurations.",
1543 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst appMeshProxyConfiguration = new ecs.AppMeshProxyConfiguration({\n containerName: 'containerName',\n properties: {\n appPorts: [123],\n proxyEgressPort: 123,\n proxyIngressPort: 123,\n\n // the properties below are optional\n egressIgnoredIPs: ['egressIgnoredIPs'],\n egressIgnoredPorts: [123],\n ignoredGID: 123,\n ignoredUID: 123,\n },\n});",
1544 "custom": {
1545 "exampleMetadata": "fixture=_generated"
1546 }
1547 },
1548 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfiguration",
1549 "initializer": {
1550 "docs": {
1551 "stability": "stable",
1552 "summary": "Constructs a new instance of the AppMeshProxyConfiguration class."
1553 },
1554 "locationInModule": {
1555 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1556 "line": 81
1557 },
1558 "parameters": [
1559 {
1560 "name": "props",
1561 "type": {
1562 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfigurationConfigProps"
1563 }
1564 }
1565 ]
1566 },
1567 "kind": "class",
1568 "locationInModule": {
1569 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1570 "line": 77
1571 },
1572 "methods": [
1573 {
1574 "docs": {
1575 "stability": "stable",
1576 "summary": "Called when the proxy configuration is configured on a task definition."
1577 },
1578 "locationInModule": {
1579 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1580 "line": 93
1581 },
1582 "name": "bind",
1583 "overrides": "@aws-cdk/aws-ecs.ProxyConfiguration",
1584 "parameters": [
1585 {
1586 "name": "_scope",
1587 "type": {
1588 "fqn": "@aws-cdk/core.Construct"
1589 }
1590 },
1591 {
1592 "name": "_taskDefinition",
1593 "type": {
1594 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
1595 }
1596 }
1597 ],
1598 "returns": {
1599 "type": {
1600 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty"
1601 }
1602 }
1603 }
1604 ],
1605 "name": "AppMeshProxyConfiguration",
1606 "symbolId": "lib/proxy-configuration/app-mesh-proxy-configuration:AppMeshProxyConfiguration"
1607 },
1608 "@aws-cdk/aws-ecs.AppMeshProxyConfigurationConfigProps": {
1609 "assembly": "@aws-cdk/aws-ecs",
1610 "datatype": true,
1611 "docs": {
1612 "stability": "stable",
1613 "summary": "The configuration to use when setting an App Mesh proxy configuration.",
1614 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst appMeshProxyConfigurationConfigProps: ecs.AppMeshProxyConfigurationConfigProps = {\n containerName: 'containerName',\n properties: {\n appPorts: [123],\n proxyEgressPort: 123,\n proxyIngressPort: 123,\n\n // the properties below are optional\n egressIgnoredIPs: ['egressIgnoredIPs'],\n egressIgnoredPorts: [123],\n ignoredGID: 123,\n ignoredUID: 123,\n },\n};",
1615 "custom": {
1616 "exampleMetadata": "fixture=_generated"
1617 }
1618 },
1619 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfigurationConfigProps",
1620 "kind": "interface",
1621 "locationInModule": {
1622 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1623 "line": 55
1624 },
1625 "name": "AppMeshProxyConfigurationConfigProps",
1626 "properties": [
1627 {
1628 "abstract": true,
1629 "docs": {
1630 "stability": "stable",
1631 "summary": "The name of the container that will serve as the App Mesh proxy."
1632 },
1633 "immutable": true,
1634 "locationInModule": {
1635 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1636 "line": 59
1637 },
1638 "name": "containerName",
1639 "type": {
1640 "primitive": "string"
1641 }
1642 },
1643 {
1644 "abstract": true,
1645 "docs": {
1646 "stability": "stable",
1647 "summary": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin."
1648 },
1649 "immutable": true,
1650 "locationInModule": {
1651 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1652 "line": 64
1653 },
1654 "name": "properties",
1655 "type": {
1656 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfigurationProps"
1657 }
1658 }
1659 ],
1660 "symbolId": "lib/proxy-configuration/app-mesh-proxy-configuration:AppMeshProxyConfigurationConfigProps"
1661 },
1662 "@aws-cdk/aws-ecs.AppMeshProxyConfigurationProps": {
1663 "assembly": "@aws-cdk/aws-ecs",
1664 "datatype": true,
1665 "docs": {
1666 "stability": "stable",
1667 "summary": "Interface for setting the properties of proxy configuration.",
1668 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst appMeshProxyConfigurationProps: ecs.AppMeshProxyConfigurationProps = {\n appPorts: [123],\n proxyEgressPort: 123,\n proxyIngressPort: 123,\n\n // the properties below are optional\n egressIgnoredIPs: ['egressIgnoredIPs'],\n egressIgnoredPorts: [123],\n ignoredGID: 123,\n ignoredUID: 123,\n};",
1669 "custom": {
1670 "exampleMetadata": "fixture=_generated"
1671 }
1672 },
1673 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfigurationProps",
1674 "kind": "interface",
1675 "locationInModule": {
1676 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1677 "line": 12
1678 },
1679 "name": "AppMeshProxyConfigurationProps",
1680 "properties": [
1681 {
1682 "abstract": true,
1683 "docs": {
1684 "remarks": "Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.",
1685 "stability": "stable",
1686 "summary": "The list of ports that the application uses."
1687 },
1688 "immutable": true,
1689 "locationInModule": {
1690 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1691 "line": 29
1692 },
1693 "name": "appPorts",
1694 "type": {
1695 "collection": {
1696 "elementtype": {
1697 "primitive": "number"
1698 },
1699 "kind": "array"
1700 }
1701 }
1702 },
1703 {
1704 "abstract": true,
1705 "docs": {
1706 "stability": "stable",
1707 "summary": "Specifies the port that outgoing traffic from the AppPorts is directed to."
1708 },
1709 "immutable": true,
1710 "locationInModule": {
1711 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1712 "line": 39
1713 },
1714 "name": "proxyEgressPort",
1715 "type": {
1716 "primitive": "number"
1717 }
1718 },
1719 {
1720 "abstract": true,
1721 "docs": {
1722 "stability": "stable",
1723 "summary": "Specifies the port that incoming traffic to the AppPorts is directed to."
1724 },
1725 "immutable": true,
1726 "locationInModule": {
1727 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1728 "line": 34
1729 },
1730 "name": "proxyIngressPort",
1731 "type": {
1732 "primitive": "number"
1733 }
1734 },
1735 {
1736 "abstract": true,
1737 "docs": {
1738 "remarks": "It can be an empty list.",
1739 "stability": "stable",
1740 "summary": "The egress traffic going to these specified IP addresses is ignored and not redirected to the ProxyEgressPort."
1741 },
1742 "immutable": true,
1743 "locationInModule": {
1744 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1745 "line": 49
1746 },
1747 "name": "egressIgnoredIPs",
1748 "optional": true,
1749 "type": {
1750 "collection": {
1751 "elementtype": {
1752 "primitive": "string"
1753 },
1754 "kind": "array"
1755 }
1756 }
1757 },
1758 {
1759 "abstract": true,
1760 "docs": {
1761 "remarks": "It can be an empty list.",
1762 "stability": "stable",
1763 "summary": "The egress traffic going to these specified ports is ignored and not redirected to the ProxyEgressPort."
1764 },
1765 "immutable": true,
1766 "locationInModule": {
1767 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1768 "line": 44
1769 },
1770 "name": "egressIgnoredPorts",
1771 "optional": true,
1772 "type": {
1773 "collection": {
1774 "elementtype": {
1775 "primitive": "number"
1776 },
1777 "kind": "array"
1778 }
1779 }
1780 },
1781 {
1782 "abstract": true,
1783 "docs": {
1784 "remarks": "This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.",
1785 "stability": "stable",
1786 "summary": "The group ID (GID) of the proxy container as defined by the user parameter in a container definition."
1787 },
1788 "immutable": true,
1789 "locationInModule": {
1790 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1791 "line": 23
1792 },
1793 "name": "ignoredGID",
1794 "optional": true,
1795 "type": {
1796 "primitive": "number"
1797 }
1798 },
1799 {
1800 "abstract": true,
1801 "docs": {
1802 "remarks": "This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.",
1803 "stability": "stable",
1804 "summary": "The user ID (UID) of the proxy container as defined by the user parameter in a container definition."
1805 },
1806 "immutable": true,
1807 "locationInModule": {
1808 "filename": "lib/proxy-configuration/app-mesh-proxy-configuration.ts",
1809 "line": 17
1810 },
1811 "name": "ignoredUID",
1812 "optional": true,
1813 "type": {
1814 "primitive": "number"
1815 }
1816 }
1817 ],
1818 "symbolId": "lib/proxy-configuration/app-mesh-proxy-configuration:AppMeshProxyConfigurationProps"
1819 },
1820 "@aws-cdk/aws-ecs.AsgCapacityProvider": {
1821 "assembly": "@aws-cdk/aws-ecs",
1822 "base": "@aws-cdk/core.Construct",
1823 "docs": {
1824 "custom": {
1825 "exampleMetadata": "infused"
1826 },
1827 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(),\n minCapacity: 0,\n maxCapacity: 100,\n});\n\nconst capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {\n autoScalingGroup,\n});\ncluster.addAsgCapacityProvider(capacityProvider);\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n memoryReservationMiB: 256,\n});\n\nnew ecs.Ec2Service(this, 'EC2Service', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: capacityProvider.capacityProviderName,\n weight: 1,\n },\n ],\n});",
1828 "remarks": "This allows an ECS cluster to target\na specific EC2 Auto Scaling Group for the placement of tasks. Optionally (and\nrecommended), ECS can manage the number of instances in the ASG to fit the\ntasks, and can ensure that instances are not prematurely terminated while\nthere are still tasks running on them.",
1829 "stability": "stable",
1830 "summary": "An Auto Scaling Group Capacity Provider."
1831 },
1832 "fqn": "@aws-cdk/aws-ecs.AsgCapacityProvider",
1833 "initializer": {
1834 "docs": {
1835 "stability": "stable"
1836 },
1837 "locationInModule": {
1838 "filename": "lib/cluster.ts",
1839 "line": 1112
1840 },
1841 "parameters": [
1842 {
1843 "name": "scope",
1844 "type": {
1845 "fqn": "constructs.Construct"
1846 }
1847 },
1848 {
1849 "name": "id",
1850 "type": {
1851 "primitive": "string"
1852 }
1853 },
1854 {
1855 "name": "props",
1856 "type": {
1857 "fqn": "@aws-cdk/aws-ecs.AsgCapacityProviderProps"
1858 }
1859 }
1860 ]
1861 },
1862 "kind": "class",
1863 "locationInModule": {
1864 "filename": "lib/cluster.ts",
1865 "line": 1090
1866 },
1867 "name": "AsgCapacityProvider",
1868 "properties": [
1869 {
1870 "docs": {
1871 "stability": "stable",
1872 "summary": "Auto Scaling Group."
1873 },
1874 "immutable": true,
1875 "locationInModule": {
1876 "filename": "lib/cluster.ts",
1877 "line": 1100
1878 },
1879 "name": "autoScalingGroup",
1880 "type": {
1881 "fqn": "@aws-cdk/aws-autoscaling.AutoScalingGroup"
1882 }
1883 },
1884 {
1885 "docs": {
1886 "default": "Chosen by CloudFormation",
1887 "stability": "stable",
1888 "summary": "Capacity provider name."
1889 },
1890 "immutable": true,
1891 "locationInModule": {
1892 "filename": "lib/cluster.ts",
1893 "line": 1095
1894 },
1895 "name": "capacityProviderName",
1896 "type": {
1897 "primitive": "string"
1898 }
1899 },
1900 {
1901 "docs": {
1902 "stability": "stable",
1903 "summary": "Auto Scaling Group machineImageType."
1904 },
1905 "immutable": true,
1906 "locationInModule": {
1907 "filename": "lib/cluster.ts",
1908 "line": 1105
1909 },
1910 "name": "machineImageType",
1911 "type": {
1912 "fqn": "@aws-cdk/aws-ecs.MachineImageType"
1913 }
1914 },
1915 {
1916 "docs": {
1917 "stability": "stable",
1918 "summary": "Whether managed termination protection is enabled."
1919 },
1920 "immutable": true,
1921 "locationInModule": {
1922 "filename": "lib/cluster.ts",
1923 "line": 1110
1924 },
1925 "name": "enableManagedTerminationProtection",
1926 "optional": true,
1927 "type": {
1928 "primitive": "boolean"
1929 }
1930 }
1931 ],
1932 "symbolId": "lib/cluster:AsgCapacityProvider"
1933 },
1934 "@aws-cdk/aws-ecs.AsgCapacityProviderProps": {
1935 "assembly": "@aws-cdk/aws-ecs",
1936 "datatype": true,
1937 "docs": {
1938 "custom": {
1939 "exampleMetadata": "infused"
1940 },
1941 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(),\n minCapacity: 0,\n maxCapacity: 100,\n});\n\nconst capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {\n autoScalingGroup,\n});\ncluster.addAsgCapacityProvider(capacityProvider);\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n memoryReservationMiB: 256,\n});\n\nnew ecs.Ec2Service(this, 'EC2Service', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: capacityProvider.capacityProviderName,\n weight: 1,\n },\n ],\n});",
1942 "stability": "stable",
1943 "summary": "The options for creating an Auto Scaling Group Capacity Provider."
1944 },
1945 "fqn": "@aws-cdk/aws-ecs.AsgCapacityProviderProps",
1946 "interfaces": [
1947 "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions"
1948 ],
1949 "kind": "interface",
1950 "locationInModule": {
1951 "filename": "lib/cluster.ts",
1952 "line": 1032
1953 },
1954 "name": "AsgCapacityProviderProps",
1955 "properties": [
1956 {
1957 "abstract": true,
1958 "docs": {
1959 "stability": "stable",
1960 "summary": "The autoscaling group to add as a Capacity Provider."
1961 },
1962 "immutable": true,
1963 "locationInModule": {
1964 "filename": "lib/cluster.ts",
1965 "line": 1045
1966 },
1967 "name": "autoScalingGroup",
1968 "type": {
1969 "fqn": "@aws-cdk/aws-autoscaling.IAutoScalingGroup"
1970 }
1971 },
1972 {
1973 "abstract": true,
1974 "docs": {
1975 "default": "CloudFormation-generated name",
1976 "remarks": "If a name is specified,\nit cannot start with `aws`, `ecs`, or `fargate`. If no name is specified,\na default name in the CFNStackName-CFNResourceName-RandomString format is used.",
1977 "stability": "stable",
1978 "summary": "The name of the capacity provider."
1979 },
1980 "immutable": true,
1981 "locationInModule": {
1982 "filename": "lib/cluster.ts",
1983 "line": 1040
1984 },
1985 "name": "capacityProviderName",
1986 "optional": true,
1987 "type": {
1988 "primitive": "string"
1989 }
1990 },
1991 {
1992 "abstract": true,
1993 "docs": {
1994 "default": "true",
1995 "stability": "stable",
1996 "summary": "Whether to enable managed scaling."
1997 },
1998 "immutable": true,
1999 "locationInModule": {
2000 "filename": "lib/cluster.ts",
2001 "line": 1052
2002 },
2003 "name": "enableManagedScaling",
2004 "optional": true,
2005 "type": {
2006 "primitive": "boolean"
2007 }
2008 },
2009 {
2010 "abstract": true,
2011 "docs": {
2012 "default": "true",
2013 "stability": "stable",
2014 "summary": "Whether to enable managed termination protection."
2015 },
2016 "immutable": true,
2017 "locationInModule": {
2018 "filename": "lib/cluster.ts",
2019 "line": 1059
2020 },
2021 "name": "enableManagedTerminationProtection",
2022 "optional": true,
2023 "type": {
2024 "primitive": "boolean"
2025 }
2026 },
2027 {
2028 "abstract": true,
2029 "docs": {
2030 "default": "1000",
2031 "remarks": "In most cases this should be left alone.",
2032 "stability": "stable",
2033 "summary": "Maximum scaling step size."
2034 },
2035 "immutable": true,
2036 "locationInModule": {
2037 "filename": "lib/cluster.ts",
2038 "line": 1066
2039 },
2040 "name": "maximumScalingStepSize",
2041 "optional": true,
2042 "type": {
2043 "primitive": "number"
2044 }
2045 },
2046 {
2047 "abstract": true,
2048 "docs": {
2049 "default": "1",
2050 "remarks": "In most cases this should be left alone.",
2051 "stability": "stable",
2052 "summary": "Minimum scaling step size."
2053 },
2054 "immutable": true,
2055 "locationInModule": {
2056 "filename": "lib/cluster.ts",
2057 "line": 1073
2058 },
2059 "name": "minimumScalingStepSize",
2060 "optional": true,
2061 "type": {
2062 "primitive": "number"
2063 }
2064 },
2065 {
2066 "abstract": true,
2067 "docs": {
2068 "default": "100",
2069 "remarks": "In most cases this should be left alone.",
2070 "stability": "stable",
2071 "summary": "Target capacity percent."
2072 },
2073 "immutable": true,
2074 "locationInModule": {
2075 "filename": "lib/cluster.ts",
2076 "line": 1080
2077 },
2078 "name": "targetCapacityPercent",
2079 "optional": true,
2080 "type": {
2081 "primitive": "number"
2082 }
2083 }
2084 ],
2085 "symbolId": "lib/cluster:AsgCapacityProviderProps"
2086 },
2087 "@aws-cdk/aws-ecs.AssetEnvironmentFile": {
2088 "assembly": "@aws-cdk/aws-ecs",
2089 "base": "@aws-cdk/aws-ecs.EnvironmentFile",
2090 "docs": {
2091 "stability": "stable",
2092 "summary": "Environment file from a local directory.",
2093 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const dockerImage: cdk.DockerImage;\ndeclare const grantable: iam.IGrantable;\ndeclare const localBundling: cdk.ILocalBundling;\nconst assetEnvironmentFile = new ecs.AssetEnvironmentFile('path', /* all optional props */ {\n assetHash: 'assetHash',\n assetHashType: cdk.AssetHashType.SOURCE,\n bundling: {\n image: dockerImage,\n\n // the properties below are optional\n command: ['command'],\n entrypoint: ['entrypoint'],\n environment: {\n environmentKey: 'environment',\n },\n local: localBundling,\n outputType: cdk.BundlingOutput.ARCHIVED,\n securityOpt: 'securityOpt',\n user: 'user',\n volumes: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n\n // the properties below are optional\n consistency: cdk.DockerVolumeConsistency.CONSISTENT,\n }],\n workingDirectory: 'workingDirectory',\n },\n exclude: ['exclude'],\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n readers: [grantable],\n sourceHash: 'sourceHash',\n});",
2094 "custom": {
2095 "exampleMetadata": "fixture=_generated"
2096 }
2097 },
2098 "fqn": "@aws-cdk/aws-ecs.AssetEnvironmentFile",
2099 "initializer": {
2100 "docs": {
2101 "stability": "stable"
2102 },
2103 "locationInModule": {
2104 "filename": "lib/environment-file.ts",
2105 "line": 50
2106 },
2107 "parameters": [
2108 {
2109 "docs": {
2110 "summary": "The path to the asset file or directory."
2111 },
2112 "name": "path",
2113 "type": {
2114 "primitive": "string"
2115 }
2116 },
2117 {
2118 "name": "options",
2119 "optional": true,
2120 "type": {
2121 "fqn": "@aws-cdk/aws-s3-assets.AssetOptions"
2122 }
2123 }
2124 ]
2125 },
2126 "kind": "class",
2127 "locationInModule": {
2128 "filename": "lib/environment-file.ts",
2129 "line": 43
2130 },
2131 "methods": [
2132 {
2133 "docs": {
2134 "stability": "stable",
2135 "summary": "Called when the container is initialized to allow this object to bind to the stack."
2136 },
2137 "locationInModule": {
2138 "filename": "lib/environment-file.ts",
2139 "line": 54
2140 },
2141 "name": "bind",
2142 "overrides": "@aws-cdk/aws-ecs.EnvironmentFile",
2143 "parameters": [
2144 {
2145 "name": "scope",
2146 "type": {
2147 "fqn": "@aws-cdk/core.Construct"
2148 }
2149 }
2150 ],
2151 "returns": {
2152 "type": {
2153 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileConfig"
2154 }
2155 }
2156 }
2157 ],
2158 "name": "AssetEnvironmentFile",
2159 "properties": [
2160 {
2161 "docs": {
2162 "stability": "stable",
2163 "summary": "The path to the asset file or directory."
2164 },
2165 "immutable": true,
2166 "locationInModule": {
2167 "filename": "lib/environment-file.ts",
2168 "line": 50
2169 },
2170 "name": "path",
2171 "type": {
2172 "primitive": "string"
2173 }
2174 }
2175 ],
2176 "symbolId": "lib/environment-file:AssetEnvironmentFile"
2177 },
2178 "@aws-cdk/aws-ecs.AssetImage": {
2179 "assembly": "@aws-cdk/aws-ecs",
2180 "base": "@aws-cdk/aws-ecs.ContainerImage",
2181 "docs": {
2182 "custom": {
2183 "exampleMetadata": "nofixture infused"
2184 },
2185 "example": "import { App, Stack } from '@aws-cdk/core';\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as ecsPatterns from '@aws-cdk/aws-ecs-patterns';\nimport * as cxapi from '@aws-cdk/cx-api';\nimport * as path from 'path';\n\nconst app = new App();\n\nconst stack = new Stack(app, 'aws-ecs-patterns-queue');\nstack.node.setContext(cxapi.ECS_REMOVE_DEFAULT_DESIRED_COUNT, true);\n\nconst vpc = new ec2.Vpc(stack, 'VPC', {\n maxAzs: 2,\n});\n\nnew ecsPatterns.QueueProcessingFargateService(stack, 'QueueProcessingService', {\n vpc,\n memoryLimitMiB: 512,\n image: new ecs.AssetImage(path.join(__dirname, '..', 'sqs-reader')),\n});",
2186 "stability": "stable",
2187 "summary": "An image that will be built from a local directory with a Dockerfile."
2188 },
2189 "fqn": "@aws-cdk/aws-ecs.AssetImage",
2190 "initializer": {
2191 "docs": {
2192 "stability": "stable",
2193 "summary": "Constructs a new instance of the AssetImage class."
2194 },
2195 "locationInModule": {
2196 "filename": "lib/images/asset-image.ts",
2197 "line": 24
2198 },
2199 "parameters": [
2200 {
2201 "docs": {
2202 "summary": "The directory containing the Dockerfile."
2203 },
2204 "name": "directory",
2205 "type": {
2206 "primitive": "string"
2207 }
2208 },
2209 {
2210 "name": "props",
2211 "optional": true,
2212 "type": {
2213 "fqn": "@aws-cdk/aws-ecs.AssetImageProps"
2214 }
2215 }
2216 ]
2217 },
2218 "kind": "class",
2219 "locationInModule": {
2220 "filename": "lib/images/asset-image.ts",
2221 "line": 18
2222 },
2223 "methods": [
2224 {
2225 "docs": {
2226 "stability": "stable",
2227 "summary": "Called when the image is used by a ContainerDefinition."
2228 },
2229 "locationInModule": {
2230 "filename": "lib/images/asset-image.ts",
2231 "line": 28
2232 },
2233 "name": "bind",
2234 "overrides": "@aws-cdk/aws-ecs.ContainerImage",
2235 "parameters": [
2236 {
2237 "name": "scope",
2238 "type": {
2239 "fqn": "@aws-cdk/core.Construct"
2240 }
2241 },
2242 {
2243 "name": "containerDefinition",
2244 "type": {
2245 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
2246 }
2247 }
2248 ],
2249 "returns": {
2250 "type": {
2251 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig"
2252 }
2253 }
2254 }
2255 ],
2256 "name": "AssetImage",
2257 "symbolId": "lib/images/asset-image:AssetImage"
2258 },
2259 "@aws-cdk/aws-ecs.AssetImageProps": {
2260 "assembly": "@aws-cdk/aws-ecs",
2261 "datatype": true,
2262 "docs": {
2263 "stability": "stable",
2264 "summary": "The properties for building an AssetImage.",
2265 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as ecr_assets from '@aws-cdk/aws-ecr-assets';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const networkMode: ecr_assets.NetworkMode;\nconst assetImageProps: ecs.AssetImageProps = {\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n exclude: ['exclude'],\n extraHash: 'extraHash',\n file: 'file',\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n invalidation: {\n buildArgs: false,\n extraHash: false,\n file: false,\n networkMode: false,\n repositoryName: false,\n target: false,\n },\n networkMode: networkMode,\n repositoryName: 'repositoryName',\n target: 'target',\n};",
2266 "custom": {
2267 "exampleMetadata": "fixture=_generated"
2268 }
2269 },
2270 "fqn": "@aws-cdk/aws-ecs.AssetImageProps",
2271 "interfaces": [
2272 "@aws-cdk/aws-ecr-assets.DockerImageAssetOptions"
2273 ],
2274 "kind": "interface",
2275 "locationInModule": {
2276 "filename": "lib/images/asset-image.ts",
2277 "line": 12
2278 },
2279 "name": "AssetImageProps",
2280 "symbolId": "lib/images/asset-image:AssetImageProps"
2281 },
2282 "@aws-cdk/aws-ecs.AssociateCloudMapServiceOptions": {
2283 "assembly": "@aws-cdk/aws-ecs",
2284 "datatype": true,
2285 "docs": {
2286 "custom": {
2287 "exampleMetadata": "infused"
2288 },
2289 "example": "declare const cloudMapService: cloudmap.Service;\ndeclare const ecsService: ecs.FargateService;\n\necsService.associateCloudMapService({\n service: cloudMapService,\n});",
2290 "stability": "stable",
2291 "summary": "The options for using a cloudmap service."
2292 },
2293 "fqn": "@aws-cdk/aws-ecs.AssociateCloudMapServiceOptions",
2294 "kind": "interface",
2295 "locationInModule": {
2296 "filename": "lib/base/base-service.ts",
2297 "line": 1020
2298 },
2299 "name": "AssociateCloudMapServiceOptions",
2300 "properties": [
2301 {
2302 "abstract": true,
2303 "docs": {
2304 "stability": "stable",
2305 "summary": "The cloudmap service to register with."
2306 },
2307 "immutable": true,
2308 "locationInModule": {
2309 "filename": "lib/base/base-service.ts",
2310 "line": 1024
2311 },
2312 "name": "service",
2313 "type": {
2314 "fqn": "@aws-cdk/aws-servicediscovery.IService"
2315 }
2316 },
2317 {
2318 "abstract": true,
2319 "docs": {
2320 "default": "- the task definition's default container",
2321 "stability": "stable",
2322 "summary": "The container to point to for a SRV record."
2323 },
2324 "immutable": true,
2325 "locationInModule": {
2326 "filename": "lib/base/base-service.ts",
2327 "line": 1030
2328 },
2329 "name": "container",
2330 "optional": true,
2331 "type": {
2332 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
2333 }
2334 },
2335 {
2336 "abstract": true,
2337 "docs": {
2338 "default": "- the default port of the task definition's default container",
2339 "stability": "stable",
2340 "summary": "The port to point to for a SRV record."
2341 },
2342 "immutable": true,
2343 "locationInModule": {
2344 "filename": "lib/base/base-service.ts",
2345 "line": 1036
2346 },
2347 "name": "containerPort",
2348 "optional": true,
2349 "type": {
2350 "primitive": "number"
2351 }
2352 }
2353 ],
2354 "symbolId": "lib/base/base-service:AssociateCloudMapServiceOptions"
2355 },
2356 "@aws-cdk/aws-ecs.AuthorizationConfig": {
2357 "assembly": "@aws-cdk/aws-ecs",
2358 "datatype": true,
2359 "docs": {
2360 "stability": "stable",
2361 "summary": "The authorization configuration details for the Amazon EFS file system.",
2362 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst authorizationConfig: ecs.AuthorizationConfig = {\n accessPointId: 'accessPointId',\n iam: 'iam',\n};",
2363 "custom": {
2364 "exampleMetadata": "fixture=_generated"
2365 }
2366 },
2367 "fqn": "@aws-cdk/aws-ecs.AuthorizationConfig",
2368 "kind": "interface",
2369 "locationInModule": {
2370 "filename": "lib/base/task-definition.ts",
2371 "line": 988
2372 },
2373 "name": "AuthorizationConfig",
2374 "properties": [
2375 {
2376 "abstract": true,
2377 "docs": {
2378 "default": "No id",
2379 "remarks": "If an access point is specified, the root directory value will be\nrelative to the directory set for the access point.\nIf specified, transit encryption must be enabled in the EFSVolumeConfiguration.",
2380 "stability": "stable",
2381 "summary": "The access point ID to use."
2382 },
2383 "immutable": true,
2384 "locationInModule": {
2385 "filename": "lib/base/task-definition.ts",
2386 "line": 997
2387 },
2388 "name": "accessPointId",
2389 "optional": true,
2390 "type": {
2391 "primitive": "string"
2392 }
2393 },
2394 {
2395 "abstract": true,
2396 "docs": {
2397 "default": "If this parameter is omitted, the default value of DISABLED is used.",
2398 "remarks": "If enabled, transit encryption must be enabled in the EFSVolumeConfiguration.\n\nValid values: ENABLED | DISABLED",
2399 "stability": "stable",
2400 "summary": "Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system."
2401 },
2402 "immutable": true,
2403 "locationInModule": {
2404 "filename": "lib/base/task-definition.ts",
2405 "line": 1007
2406 },
2407 "name": "iam",
2408 "optional": true,
2409 "type": {
2410 "primitive": "string"
2411 }
2412 }
2413 ],
2414 "symbolId": "lib/base/task-definition:AuthorizationConfig"
2415 },
2416 "@aws-cdk/aws-ecs.AwsLogDriver": {
2417 "assembly": "@aws-cdk/aws-ecs",
2418 "base": "@aws-cdk/aws-ecs.LogDriver",
2419 "docs": {
2420 "custom": {
2421 "exampleMetadata": "infused"
2422 },
2423 "example": "declare const cluster: ecs.Cluster;\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromAsset(path.resolve(__dirname, '..', 'eventhandler-image')),\n memoryLimitMiB: 256,\n logging: new ecs.AwsLogDriver({ streamPrefix: 'EventDemo', mode: ecs.AwsLogDriverMode.NON_BLOCKING }),\n});\n\n// An Rule that describes the event trigger (in this case a scheduled run)\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.expression('rate(1 min)'),\n});\n\n// Pass an environment variable to the container 'TheContainer' in the task\nrule.addTarget(new targets.EcsTask({\n cluster,\n taskDefinition,\n taskCount: 1,\n containerOverrides: [{\n containerName: 'TheContainer',\n environment: [{\n name: 'I_WAS_TRIGGERED',\n value: 'From CloudWatch Events'\n }],\n }],\n}));",
2424 "stability": "stable",
2425 "summary": "A log driver that sends log information to CloudWatch Logs."
2426 },
2427 "fqn": "@aws-cdk/aws-ecs.AwsLogDriver",
2428 "initializer": {
2429 "docs": {
2430 "stability": "stable",
2431 "summary": "Constructs a new instance of the AwsLogDriver class."
2432 },
2433 "locationInModule": {
2434 "filename": "lib/log-drivers/aws-log-driver.ts",
2435 "line": 106
2436 },
2437 "parameters": [
2438 {
2439 "docs": {
2440 "summary": "the awslogs log driver configuration options."
2441 },
2442 "name": "props",
2443 "type": {
2444 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverProps"
2445 }
2446 }
2447 ]
2448 },
2449 "kind": "class",
2450 "locationInModule": {
2451 "filename": "lib/log-drivers/aws-log-driver.ts",
2452 "line": 93
2453 },
2454 "methods": [
2455 {
2456 "docs": {
2457 "stability": "stable",
2458 "summary": "Called when the log driver is configured on a container."
2459 },
2460 "locationInModule": {
2461 "filename": "lib/log-drivers/aws-log-driver.ts",
2462 "line": 117
2463 },
2464 "name": "bind",
2465 "overrides": "@aws-cdk/aws-ecs.LogDriver",
2466 "parameters": [
2467 {
2468 "name": "scope",
2469 "type": {
2470 "fqn": "@aws-cdk/core.Construct"
2471 }
2472 },
2473 {
2474 "name": "containerDefinition",
2475 "type": {
2476 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
2477 }
2478 }
2479 ],
2480 "returns": {
2481 "type": {
2482 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
2483 }
2484 }
2485 }
2486 ],
2487 "name": "AwsLogDriver",
2488 "properties": [
2489 {
2490 "docs": {
2491 "remarks": "Only available after the LogDriver has been bound to a ContainerDefinition.",
2492 "stability": "stable",
2493 "summary": "The log group to send log streams to."
2494 },
2495 "locationInModule": {
2496 "filename": "lib/log-drivers/aws-log-driver.ts",
2497 "line": 99
2498 },
2499 "name": "logGroup",
2500 "optional": true,
2501 "type": {
2502 "fqn": "@aws-cdk/aws-logs.ILogGroup"
2503 }
2504 }
2505 ],
2506 "symbolId": "lib/log-drivers/aws-log-driver:AwsLogDriver"
2507 },
2508 "@aws-cdk/aws-ecs.AwsLogDriverMode": {
2509 "assembly": "@aws-cdk/aws-ecs",
2510 "docs": {
2511 "custom": {
2512 "exampleMetadata": "infused"
2513 },
2514 "example": "declare const cluster: ecs.Cluster;\n// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromAsset(path.resolve(__dirname, '..', 'eventhandler-image')),\n memoryLimitMiB: 256,\n logging: new ecs.AwsLogDriver({ streamPrefix: 'EventDemo', mode: ecs.AwsLogDriverMode.NON_BLOCKING }),\n});\n\n// An Rule that describes the event trigger (in this case a scheduled run)\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.expression('rate(1 min)'),\n});\n\n// Pass an environment variable to the container 'TheContainer' in the task\nrule.addTarget(new targets.EcsTask({\n cluster,\n taskDefinition,\n taskCount: 1,\n containerOverrides: [{\n containerName: 'TheContainer',\n environment: [{\n name: 'I_WAS_TRIGGERED',\n value: 'From CloudWatch Events'\n }],\n }],\n}));",
2515 "stability": "stable",
2516 "summary": "awslogs provides two modes for delivering messages from the container to the log driver."
2517 },
2518 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverMode",
2519 "kind": "enum",
2520 "locationInModule": {
2521 "filename": "lib/log-drivers/aws-log-driver.ts",
2522 "line": 13
2523 },
2524 "members": [
2525 {
2526 "docs": {
2527 "stability": "stable",
2528 "summary": "(default) direct, blocking delivery from container to driver."
2529 },
2530 "name": "BLOCKING"
2531 },
2532 {
2533 "docs": {
2534 "remarks": "Applications are likely to fail in unexpected ways when STDERR or STDOUT streams block.",
2535 "stability": "stable",
2536 "summary": "The non-blocking message delivery mode prevents applications from blocking due to logging back pressure."
2537 },
2538 "name": "NON_BLOCKING"
2539 }
2540 ],
2541 "name": "AwsLogDriverMode",
2542 "symbolId": "lib/log-drivers/aws-log-driver:AwsLogDriverMode"
2543 },
2544 "@aws-cdk/aws-ecs.AwsLogDriverProps": {
2545 "assembly": "@aws-cdk/aws-ecs",
2546 "datatype": true,
2547 "docs": {
2548 "custom": {
2549 "exampleMetadata": "infused"
2550 },
2551 "example": "// Create a Task Definition for the Windows container to start\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,\n cpuArchitecture: ecs.CpuArchitecture.X86_64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('windowsservercore', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),\n});",
2552 "stability": "stable",
2553 "summary": "Specifies the awslogs log driver configuration options."
2554 },
2555 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverProps",
2556 "kind": "interface",
2557 "locationInModule": {
2558 "filename": "lib/log-drivers/aws-log-driver.ts",
2559 "line": 30
2560 },
2561 "name": "AwsLogDriverProps",
2562 "properties": [
2563 {
2564 "abstract": true,
2565 "docs": {
2566 "remarks": "The awslogs-stream-prefix option allows you to associate a log stream\nwith the specified prefix, the container name, and the ID of the Amazon\nECS task to which the container belongs. If you specify a prefix with\nthis option, then the log stream takes the following format:\n\n prefix-name/container-name/ecs-task-id",
2567 "stability": "stable",
2568 "summary": "Prefix for the log streams."
2569 },
2570 "immutable": true,
2571 "locationInModule": {
2572 "filename": "lib/log-drivers/aws-log-driver.ts",
2573 "line": 41
2574 },
2575 "name": "streamPrefix",
2576 "type": {
2577 "primitive": "string"
2578 }
2579 },
2580 {
2581 "abstract": true,
2582 "docs": {
2583 "default": "- No multiline matching.",
2584 "remarks": "A log message consists of a line that matches the pattern and any\nfollowing lines that don’t match the pattern. Thus the matched line is\nthe delimiter between log messages.",
2585 "stability": "stable",
2586 "summary": "This option defines a multiline start pattern in Python strftime format."
2587 },
2588 "immutable": true,
2589 "locationInModule": {
2590 "filename": "lib/log-drivers/aws-log-driver.ts",
2591 "line": 67
2592 },
2593 "name": "datetimeFormat",
2594 "optional": true,
2595 "type": {
2596 "primitive": "string"
2597 }
2598 },
2599 {
2600 "abstract": true,
2601 "docs": {
2602 "default": "- A log group is automatically created.",
2603 "stability": "stable",
2604 "summary": "The log group to log to."
2605 },
2606 "immutable": true,
2607 "locationInModule": {
2608 "filename": "lib/log-drivers/aws-log-driver.ts",
2609 "line": 48
2610 },
2611 "name": "logGroup",
2612 "optional": true,
2613 "type": {
2614 "fqn": "@aws-cdk/aws-logs.ILogGroup"
2615 }
2616 },
2617 {
2618 "abstract": true,
2619 "docs": {
2620 "default": "- Logs never expire.",
2621 "stability": "stable",
2622 "summary": "The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct."
2623 },
2624 "immutable": true,
2625 "locationInModule": {
2626 "filename": "lib/log-drivers/aws-log-driver.ts",
2627 "line": 56
2628 },
2629 "name": "logRetention",
2630 "optional": true,
2631 "type": {
2632 "fqn": "@aws-cdk/aws-logs.RetentionDays"
2633 }
2634 },
2635 {
2636 "abstract": true,
2637 "docs": {
2638 "default": "- AwsLogDriverMode.BLOCKING",
2639 "stability": "stable",
2640 "summary": "The delivery mode of log messages from the container to awslogs."
2641 },
2642 "immutable": true,
2643 "locationInModule": {
2644 "filename": "lib/log-drivers/aws-log-driver.ts",
2645 "line": 87
2646 },
2647 "name": "mode",
2648 "optional": true,
2649 "type": {
2650 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverMode"
2651 }
2652 },
2653 {
2654 "abstract": true,
2655 "docs": {
2656 "default": "- No multiline matching.",
2657 "remarks": "A log message consists of a line that matches the pattern and any\nfollowing lines that don’t match the pattern. Thus the matched line is\nthe delimiter between log messages.\n\nThis option is ignored if datetimeFormat is also configured.",
2658 "stability": "stable",
2659 "summary": "This option defines a multiline start pattern using a regular expression."
2660 },
2661 "immutable": true,
2662 "locationInModule": {
2663 "filename": "lib/log-drivers/aws-log-driver.ts",
2664 "line": 80
2665 },
2666 "name": "multilinePattern",
2667 "optional": true,
2668 "type": {
2669 "primitive": "string"
2670 }
2671 }
2672 ],
2673 "symbolId": "lib/log-drivers/aws-log-driver:AwsLogDriverProps"
2674 },
2675 "@aws-cdk/aws-ecs.BaseLogDriverProps": {
2676 "assembly": "@aws-cdk/aws-ecs",
2677 "datatype": true,
2678 "docs": {
2679 "stability": "stable",
2680 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst baseLogDriverProps: ecs.BaseLogDriverProps = {\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n tag: 'tag',\n};",
2681 "custom": {
2682 "exampleMetadata": "fixture=_generated"
2683 }
2684 },
2685 "fqn": "@aws-cdk/aws-ecs.BaseLogDriverProps",
2686 "kind": "interface",
2687 "locationInModule": {
2688 "filename": "lib/log-drivers/base-log-driver.ts",
2689 "line": 1
2690 },
2691 "name": "BaseLogDriverProps",
2692 "properties": [
2693 {
2694 "abstract": true,
2695 "docs": {
2696 "default": "- No env",
2697 "remarks": "If there is collision between\nlabel and env keys, the value of the env takes precedence. Adds additional fields\nto the extra attributes of a logging message.",
2698 "stability": "stable",
2699 "summary": "The env option takes an array of keys."
2700 },
2701 "immutable": true,
2702 "locationInModule": {
2703 "filename": "lib/log-drivers/base-log-driver.ts",
2704 "line": 27
2705 },
2706 "name": "env",
2707 "optional": true,
2708 "type": {
2709 "collection": {
2710 "elementtype": {
2711 "primitive": "string"
2712 },
2713 "kind": "array"
2714 }
2715 }
2716 },
2717 {
2718 "abstract": true,
2719 "docs": {
2720 "default": "- No envRegex",
2721 "remarks": "Its value is a regular\nexpression to match logging-related environment variables. It is used for advanced\nlog tag options.",
2722 "stability": "stable",
2723 "summary": "The env-regex option is similar to and compatible with env."
2724 },
2725 "immutable": true,
2726 "locationInModule": {
2727 "filename": "lib/log-drivers/base-log-driver.ts",
2728 "line": 36
2729 },
2730 "name": "envRegex",
2731 "optional": true,
2732 "type": {
2733 "primitive": "string"
2734 }
2735 },
2736 {
2737 "abstract": true,
2738 "docs": {
2739 "default": "- No labels",
2740 "remarks": "If there is collision\nbetween label and env keys, the value of the env takes precedence. Adds additional\nfields to the extra attributes of a logging message.",
2741 "stability": "stable",
2742 "summary": "The labels option takes an array of keys."
2743 },
2744 "immutable": true,
2745 "locationInModule": {
2746 "filename": "lib/log-drivers/base-log-driver.ts",
2747 "line": 18
2748 },
2749 "name": "labels",
2750 "optional": true,
2751 "type": {
2752 "collection": {
2753 "elementtype": {
2754 "primitive": "string"
2755 },
2756 "kind": "array"
2757 }
2758 }
2759 },
2760 {
2761 "abstract": true,
2762 "docs": {
2763 "default": "- The first 12 characters of the container ID",
2764 "remarks": "Refer to the log tag option documentation for customizing the\nlog tag format.",
2765 "stability": "stable",
2766 "summary": "By default, Docker uses the first 12 characters of the container ID to tag log messages."
2767 },
2768 "immutable": true,
2769 "locationInModule": {
2770 "filename": "lib/log-drivers/base-log-driver.ts",
2771 "line": 9
2772 },
2773 "name": "tag",
2774 "optional": true,
2775 "type": {
2776 "primitive": "string"
2777 }
2778 }
2779 ],
2780 "symbolId": "lib/log-drivers/base-log-driver:BaseLogDriverProps"
2781 },
2782 "@aws-cdk/aws-ecs.BaseService": {
2783 "abstract": true,
2784 "assembly": "@aws-cdk/aws-ecs",
2785 "base": "@aws-cdk/core.Resource",
2786 "docs": {
2787 "custom": {
2788 "exampleMetadata": "infused"
2789 },
2790 "example": "import * as ecs from '@aws-cdk/aws-ecs';\n\nconst service = ecs.BaseService.fromServiceArnWithCluster(this, 'EcsService',\n 'arn:aws:ecs:us-east-1:123456789012:service/myClusterName/myServiceName'\n);\nconst pipeline = new codepipeline.Pipeline(this, 'MyPipeline');\nconst buildOutput = new codepipeline.Artifact();\n// add source and build stages to the pipeline as usual...\nconst deployStage = pipeline.addStage({\n stageName: 'Deploy',\n actions: [\n new codepipeline_actions.EcsDeployAction({\n actionName: 'DeployAction',\n service: service,\n input: buildOutput,\n }),\n ],\n});",
2791 "stability": "stable",
2792 "summary": "The base class for Ec2Service and FargateService services."
2793 },
2794 "fqn": "@aws-cdk/aws-ecs.BaseService",
2795 "initializer": {
2796 "docs": {
2797 "stability": "stable",
2798 "summary": "Constructs a new instance of the BaseService class."
2799 },
2800 "locationInModule": {
2801 "filename": "lib/base/base-service.ts",
2802 "line": 415
2803 },
2804 "parameters": [
2805 {
2806 "name": "scope",
2807 "type": {
2808 "fqn": "constructs.Construct"
2809 }
2810 },
2811 {
2812 "name": "id",
2813 "type": {
2814 "primitive": "string"
2815 }
2816 },
2817 {
2818 "name": "props",
2819 "type": {
2820 "fqn": "@aws-cdk/aws-ecs.BaseServiceProps"
2821 }
2822 },
2823 {
2824 "name": "additionalProps",
2825 "type": {
2826 "primitive": "any"
2827 }
2828 },
2829 {
2830 "name": "taskDefinition",
2831 "type": {
2832 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
2833 }
2834 }
2835 ]
2836 },
2837 "interfaces": [
2838 "@aws-cdk/aws-ecs.IBaseService",
2839 "@aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget",
2840 "@aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget",
2841 "@aws-cdk/aws-elasticloadbalancing.ILoadBalancerTarget"
2842 ],
2843 "kind": "class",
2844 "locationInModule": {
2845 "filename": "lib/base/base-service.ts",
2846 "line": 316
2847 },
2848 "methods": [
2849 {
2850 "docs": {
2851 "remarks": "The format is the \"new\" format \"arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name\".",
2852 "see": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids",
2853 "stability": "stable",
2854 "summary": "Import an existing ECS/Fargate Service using the service cluster format."
2855 },
2856 "locationInModule": {
2857 "filename": "lib/base/base-service.ts",
2858 "line": 323
2859 },
2860 "name": "fromServiceArnWithCluster",
2861 "parameters": [
2862 {
2863 "name": "scope",
2864 "type": {
2865 "fqn": "constructs.Construct"
2866 }
2867 },
2868 {
2869 "name": "id",
2870 "type": {
2871 "primitive": "string"
2872 }
2873 },
2874 {
2875 "name": "serviceArn",
2876 "type": {
2877 "primitive": "string"
2878 }
2879 }
2880 ],
2881 "returns": {
2882 "type": {
2883 "fqn": "@aws-cdk/aws-ecs.IBaseService"
2884 }
2885 },
2886 "static": true
2887 },
2888 {
2889 "docs": {
2890 "stability": "stable",
2891 "summary": "Associates this service with a CloudMap service."
2892 },
2893 "locationInModule": {
2894 "filename": "lib/base/base-service.ts",
2895 "line": 768
2896 },
2897 "name": "associateCloudMapService",
2898 "parameters": [
2899 {
2900 "name": "options",
2901 "type": {
2902 "fqn": "@aws-cdk/aws-ecs.AssociateCloudMapServiceOptions"
2903 }
2904 }
2905 ]
2906 },
2907 {
2908 "docs": {
2909 "remarks": "Don't call this function directly. Instead, call `listener.addTargets()`\nto add this service to a load balancer.",
2910 "stability": "stable",
2911 "summary": "This method is called to attach this service to an Application Load Balancer."
2912 },
2913 "locationInModule": {
2914 "filename": "lib/base/base-service.ts",
2915 "line": 588
2916 },
2917 "name": "attachToApplicationTargetGroup",
2918 "overrides": "@aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget",
2919 "parameters": [
2920 {
2921 "name": "targetGroup",
2922 "type": {
2923 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.IApplicationTargetGroup"
2924 }
2925 }
2926 ],
2927 "returns": {
2928 "type": {
2929 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps"
2930 }
2931 }
2932 },
2933 {
2934 "docs": {
2935 "remarks": "Don't call this. Call `loadBalancer.addTarget()` instead.",
2936 "stability": "stable",
2937 "summary": "Registers the service as a target of a Classic Load Balancer (CLB)."
2938 },
2939 "locationInModule": {
2940 "filename": "lib/base/base-service.ts",
2941 "line": 597
2942 },
2943 "name": "attachToClassicLB",
2944 "overrides": "@aws-cdk/aws-elasticloadbalancing.ILoadBalancerTarget",
2945 "parameters": [
2946 {
2947 "name": "loadBalancer",
2948 "type": {
2949 "fqn": "@aws-cdk/aws-elasticloadbalancing.LoadBalancer"
2950 }
2951 }
2952 ]
2953 },
2954 {
2955 "docs": {
2956 "remarks": "Don't call this function directly. Instead, call `listener.addTargets()`\nto add this service to a load balancer.",
2957 "stability": "stable",
2958 "summary": "This method is called to attach this service to a Network Load Balancer."
2959 },
2960 "locationInModule": {
2961 "filename": "lib/base/base-service.ts",
2962 "line": 679
2963 },
2964 "name": "attachToNetworkTargetGroup",
2965 "overrides": "@aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget",
2966 "parameters": [
2967 {
2968 "name": "targetGroup",
2969 "type": {
2970 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.INetworkTargetGroup"
2971 }
2972 }
2973 ],
2974 "returns": {
2975 "type": {
2976 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps"
2977 }
2978 }
2979 },
2980 {
2981 "docs": {
2982 "stability": "stable",
2983 "summary": "An attribute representing the minimum and maximum task count for an AutoScalingGroup."
2984 },
2985 "locationInModule": {
2986 "filename": "lib/base/base-service.ts",
2987 "line": 686
2988 },
2989 "name": "autoScaleTaskCount",
2990 "parameters": [
2991 {
2992 "name": "props",
2993 "type": {
2994 "fqn": "@aws-cdk/aws-applicationautoscaling.EnableScalingProps"
2995 }
2996 }
2997 ],
2998 "returns": {
2999 "type": {
3000 "fqn": "@aws-cdk/aws-ecs.ScalableTaskCount"
3001 }
3002 }
3003 },
3004 {
3005 "docs": {
3006 "deprecated": "use configureAwsVpcNetworkingWithSecurityGroups instead.",
3007 "stability": "deprecated",
3008 "summary": "This method is called to create a networkConfiguration."
3009 },
3010 "locationInModule": {
3011 "filename": "lib/base/base-service.ts",
3012 "line": 821
3013 },
3014 "name": "configureAwsVpcNetworking",
3015 "parameters": [
3016 {
3017 "name": "vpc",
3018 "type": {
3019 "fqn": "@aws-cdk/aws-ec2.IVpc"
3020 }
3021 },
3022 {
3023 "name": "assignPublicIp",
3024 "optional": true,
3025 "type": {
3026 "primitive": "boolean"
3027 }
3028 },
3029 {
3030 "name": "vpcSubnets",
3031 "optional": true,
3032 "type": {
3033 "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
3034 }
3035 },
3036 {
3037 "name": "securityGroup",
3038 "optional": true,
3039 "type": {
3040 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
3041 }
3042 }
3043 ],
3044 "protected": true
3045 },
3046 {
3047 "docs": {
3048 "stability": "stable",
3049 "summary": "This method is called to create a networkConfiguration."
3050 },
3051 "locationInModule": {
3052 "filename": "lib/base/base-service.ts",
3053 "line": 843
3054 },
3055 "name": "configureAwsVpcNetworkingWithSecurityGroups",
3056 "parameters": [
3057 {
3058 "name": "vpc",
3059 "type": {
3060 "fqn": "@aws-cdk/aws-ec2.IVpc"
3061 }
3062 },
3063 {
3064 "name": "assignPublicIp",
3065 "optional": true,
3066 "type": {
3067 "primitive": "boolean"
3068 }
3069 },
3070 {
3071 "name": "vpcSubnets",
3072 "optional": true,
3073 "type": {
3074 "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
3075 }
3076 },
3077 {
3078 "name": "securityGroups",
3079 "optional": true,
3080 "type": {
3081 "collection": {
3082 "elementtype": {
3083 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
3084 },
3085 "kind": "array"
3086 }
3087 }
3088 }
3089 ],
3090 "protected": true
3091 },
3092 {
3093 "docs": {
3094 "returns": "The created CloudMap service",
3095 "stability": "stable",
3096 "summary": "Enable CloudMap service discovery for the service."
3097 },
3098 "locationInModule": {
3099 "filename": "lib/base/base-service.ts",
3100 "line": 705
3101 },
3102 "name": "enableCloudMap",
3103 "parameters": [
3104 {
3105 "name": "options",
3106 "type": {
3107 "fqn": "@aws-cdk/aws-ecs.CloudMapOptions"
3108 }
3109 }
3110 ],
3111 "returns": {
3112 "type": {
3113 "fqn": "@aws-cdk/aws-servicediscovery.Service"
3114 }
3115 }
3116 },
3117 {
3118 "docs": {
3119 "example": "declare const listener: elbv2.ApplicationListener;\ndeclare const service: ecs.BaseService;\nlistener.addTargets('ECS', {\n port: 80,\n targets: [service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 1234,\n })],\n});",
3120 "remarks": "Use this function to create a load balancer target if you want to load balance to\nanother container than the first essential container or the first mapped port on\nthe container.\n\nUse the return value of this function where you would normally use a load balancer\ntarget, instead of the `Service` object itself.",
3121 "stability": "stable",
3122 "summary": "Return a load balancing target for a specific container and port."
3123 },
3124 "locationInModule": {
3125 "filename": "lib/base/base-service.ts",
3126 "line": 623
3127 },
3128 "name": "loadBalancerTarget",
3129 "parameters": [
3130 {
3131 "name": "options",
3132 "type": {
3133 "fqn": "@aws-cdk/aws-ecs.LoadBalancerTargetOptions"
3134 }
3135 }
3136 ],
3137 "returns": {
3138 "type": {
3139 "fqn": "@aws-cdk/aws-ecs.IEcsLoadBalancerTarget"
3140 }
3141 }
3142 },
3143 {
3144 "docs": {
3145 "stability": "stable",
3146 "summary": "This method returns the specified CloudWatch metric name for this service."
3147 },
3148 "locationInModule": {
3149 "filename": "lib/base/base-service.ts",
3150 "line": 789
3151 },
3152 "name": "metric",
3153 "parameters": [
3154 {
3155 "name": "metricName",
3156 "type": {
3157 "primitive": "string"
3158 }
3159 },
3160 {
3161 "name": "props",
3162 "optional": true,
3163 "type": {
3164 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
3165 }
3166 }
3167 ],
3168 "returns": {
3169 "type": {
3170 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
3171 }
3172 }
3173 },
3174 {
3175 "docs": {
3176 "default": "average over 5 minutes",
3177 "stability": "stable",
3178 "summary": "This method returns the CloudWatch metric for this service's CPU utilization."
3179 },
3180 "locationInModule": {
3181 "filename": "lib/base/base-service.ts",
3182 "line": 812
3183 },
3184 "name": "metricCpuUtilization",
3185 "parameters": [
3186 {
3187 "name": "props",
3188 "optional": true,
3189 "type": {
3190 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
3191 }
3192 }
3193 ],
3194 "returns": {
3195 "type": {
3196 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
3197 }
3198 }
3199 },
3200 {
3201 "docs": {
3202 "default": "average over 5 minutes",
3203 "stability": "stable",
3204 "summary": "This method returns the CloudWatch metric for this service's memory utilization."
3205 },
3206 "locationInModule": {
3207 "filename": "lib/base/base-service.ts",
3208 "line": 803
3209 },
3210 "name": "metricMemoryUtilization",
3211 "parameters": [
3212 {
3213 "name": "props",
3214 "optional": true,
3215 "type": {
3216 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
3217 }
3218 }
3219 ],
3220 "returns": {
3221 "type": {
3222 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
3223 }
3224 }
3225 },
3226 {
3227 "docs": {
3228 "example": "declare const listener: elbv2.ApplicationListener;\ndeclare const service: ecs.BaseService;\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n)",
3229 "remarks": "Alternatively, you can use `listener.addTargets()` to create targets and add them to target groups.",
3230 "stability": "stable",
3231 "summary": "Use this function to create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly."
3232 },
3233 "locationInModule": {
3234 "filename": "lib/base/base-service.ts",
3235 "line": 663
3236 },
3237 "name": "registerLoadBalancerTargets",
3238 "parameters": [
3239 {
3240 "name": "targets",
3241 "type": {
3242 "fqn": "@aws-cdk/aws-ecs.EcsTarget"
3243 },
3244 "variadic": true
3245 }
3246 ],
3247 "variadic": true
3248 }
3249 ],
3250 "name": "BaseService",
3251 "properties": [
3252 {
3253 "docs": {
3254 "stability": "stable",
3255 "summary": "The cluster that hosts the service."
3256 },
3257 "immutable": true,
3258 "locationInModule": {
3259 "filename": "lib/base/base-service.ts",
3260 "line": 384
3261 },
3262 "name": "cluster",
3263 "overrides": "@aws-cdk/aws-ecs.IBaseService",
3264 "type": {
3265 "fqn": "@aws-cdk/aws-ecs.ICluster"
3266 }
3267 },
3268 {
3269 "docs": {
3270 "stability": "stable",
3271 "summary": "The security groups which manage the allowed network traffic for the service."
3272 },
3273 "immutable": true,
3274 "locationInModule": {
3275 "filename": "lib/base/base-service.ts",
3276 "line": 362
3277 },
3278 "name": "connections",
3279 "overrides": "@aws-cdk/aws-ec2.IConnectable",
3280 "type": {
3281 "fqn": "@aws-cdk/aws-ec2.Connections"
3282 }
3283 },
3284 {
3285 "docs": {
3286 "stability": "stable",
3287 "summary": "The Amazon Resource Name (ARN) of the service."
3288 },
3289 "immutable": true,
3290 "locationInModule": {
3291 "filename": "lib/base/base-service.ts",
3292 "line": 367
3293 },
3294 "name": "serviceArn",
3295 "overrides": "@aws-cdk/aws-ecs.IService",
3296 "type": {
3297 "primitive": "string"
3298 }
3299 },
3300 {
3301 "docs": {
3302 "custom": {
3303 "attribute": "true"
3304 },
3305 "stability": "stable",
3306 "summary": "The name of the service."
3307 },
3308 "immutable": true,
3309 "locationInModule": {
3310 "filename": "lib/base/base-service.ts",
3311 "line": 374
3312 },
3313 "name": "serviceName",
3314 "overrides": "@aws-cdk/aws-ecs.IService",
3315 "type": {
3316 "primitive": "string"
3317 }
3318 },
3319 {
3320 "docs": {
3321 "stability": "stable",
3322 "summary": "The task definition to use for tasks in the service."
3323 },
3324 "immutable": true,
3325 "locationInModule": {
3326 "filename": "lib/base/base-service.ts",
3327 "line": 379
3328 },
3329 "name": "taskDefinition",
3330 "type": {
3331 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
3332 }
3333 },
3334 {
3335 "docs": {
3336 "stability": "stable",
3337 "summary": "The CloudMap service created for this service, if any."
3338 },
3339 "immutable": true,
3340 "locationInModule": {
3341 "filename": "lib/base/base-service.ts",
3342 "line": 500
3343 },
3344 "name": "cloudMapService",
3345 "optional": true,
3346 "type": {
3347 "fqn": "@aws-cdk/aws-servicediscovery.IService"
3348 }
3349 },
3350 {
3351 "docs": {
3352 "stability": "stable",
3353 "summary": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer."
3354 },
3355 "locationInModule": {
3356 "filename": "lib/base/base-service.ts",
3357 "line": 395
3358 },
3359 "name": "loadBalancers",
3360 "protected": true,
3361 "type": {
3362 "collection": {
3363 "elementtype": {
3364 "fqn": "@aws-cdk/aws-ecs.CfnService.LoadBalancerProperty"
3365 },
3366 "kind": "array"
3367 }
3368 }
3369 },
3370 {
3371 "docs": {
3372 "remarks": "For more information, see Service Discovery.",
3373 "stability": "stable",
3374 "summary": "The details of the service discovery registries to assign to this service."
3375 },
3376 "locationInModule": {
3377 "filename": "lib/base/base-service.ts",
3378 "line": 407
3379 },
3380 "name": "serviceRegistries",
3381 "protected": true,
3382 "type": {
3383 "collection": {
3384 "elementtype": {
3385 "fqn": "@aws-cdk/aws-ecs.CfnService.ServiceRegistryProperty"
3386 },
3387 "kind": "array"
3388 }
3389 }
3390 },
3391 {
3392 "docs": {
3393 "stability": "stable",
3394 "summary": "The details of the AWS Cloud Map service."
3395 },
3396 "locationInModule": {
3397 "filename": "lib/base/base-service.ts",
3398 "line": 389
3399 },
3400 "name": "cloudmapService",
3401 "optional": true,
3402 "protected": true,
3403 "type": {
3404 "fqn": "@aws-cdk/aws-servicediscovery.Service"
3405 }
3406 },
3407 {
3408 "docs": {
3409 "stability": "stable",
3410 "summary": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer."
3411 },
3412 "locationInModule": {
3413 "filename": "lib/base/base-service.ts",
3414 "line": 401
3415 },
3416 "name": "networkConfiguration",
3417 "optional": true,
3418 "protected": true,
3419 "type": {
3420 "fqn": "@aws-cdk/aws-ecs.CfnService.NetworkConfigurationProperty"
3421 }
3422 }
3423 ],
3424 "symbolId": "lib/base/base-service:BaseService"
3425 },
3426 "@aws-cdk/aws-ecs.BaseServiceOptions": {
3427 "assembly": "@aws-cdk/aws-ecs",
3428 "datatype": true,
3429 "docs": {
3430 "stability": "stable",
3431 "summary": "The properties for the base Ec2Service or FargateService service.",
3432 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as servicediscovery from '@aws-cdk/aws-servicediscovery';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const cluster: ecs.Cluster;\ndeclare const containerDefinition: ecs.ContainerDefinition;\ndeclare const namespace: servicediscovery.INamespace;\nconst baseServiceOptions: ecs.BaseServiceOptions = {\n cluster: cluster,\n\n // the properties below are optional\n capacityProviderStrategies: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n circuitBreaker: {\n rollback: false,\n },\n cloudMapOptions: {\n cloudMapNamespace: namespace,\n container: containerDefinition,\n containerPort: 123,\n dnsRecordType: servicediscovery.DnsRecordType.A,\n dnsTtl: cdk.Duration.minutes(30),\n failureThreshold: 123,\n name: 'name',\n },\n deploymentController: {\n type: ecs.DeploymentControllerType.ECS,\n },\n desiredCount: 123,\n enableECSManagedTags: false,\n enableExecuteCommand: false,\n healthCheckGracePeriod: cdk.Duration.minutes(30),\n maxHealthyPercent: 123,\n minHealthyPercent: 123,\n propagateTags: ecs.PropagatedTagSource.SERVICE,\n propagateTaskTagsFrom: ecs.PropagatedTagSource.SERVICE,\n serviceName: 'serviceName',\n};",
3433 "custom": {
3434 "exampleMetadata": "fixture=_generated"
3435 }
3436 },
3437 "fqn": "@aws-cdk/aws-ecs.BaseServiceOptions",
3438 "kind": "interface",
3439 "locationInModule": {
3440 "filename": "lib/base/base-service.ts",
3441 "line": 99
3442 },
3443 "name": "BaseServiceOptions",
3444 "properties": [
3445 {
3446 "abstract": true,
3447 "docs": {
3448 "stability": "stable",
3449 "summary": "The name of the cluster that hosts the service."
3450 },
3451 "immutable": true,
3452 "locationInModule": {
3453 "filename": "lib/base/base-service.ts",
3454 "line": 103
3455 },
3456 "name": "cluster",
3457 "type": {
3458 "fqn": "@aws-cdk/aws-ecs.ICluster"
3459 }
3460 },
3461 {
3462 "abstract": true,
3463 "docs": {
3464 "default": "- undefined",
3465 "stability": "stable",
3466 "summary": "A list of Capacity Provider strategies used to place a service."
3467 },
3468 "immutable": true,
3469 "locationInModule": {
3470 "filename": "lib/base/base-service.ts",
3471 "line": 200
3472 },
3473 "name": "capacityProviderStrategies",
3474 "optional": true,
3475 "type": {
3476 "collection": {
3477 "elementtype": {
3478 "fqn": "@aws-cdk/aws-ecs.CapacityProviderStrategy"
3479 },
3480 "kind": "array"
3481 }
3482 }
3483 },
3484 {
3485 "abstract": true,
3486 "docs": {
3487 "default": "- disabled",
3488 "remarks": "If this property is defined, circuit breaker will be implicitly\nenabled.",
3489 "stability": "stable",
3490 "summary": "Whether to enable the deployment circuit breaker."
3491 },
3492 "immutable": true,
3493 "locationInModule": {
3494 "filename": "lib/base/base-service.ts",
3495 "line": 192
3496 },
3497 "name": "circuitBreaker",
3498 "optional": true,
3499 "type": {
3500 "fqn": "@aws-cdk/aws-ecs.DeploymentCircuitBreaker"
3501 }
3502 },
3503 {
3504 "abstract": true,
3505 "docs": {
3506 "default": "- AWS Cloud Map service discovery is not enabled.",
3507 "stability": "stable",
3508 "summary": "The options for configuring an Amazon ECS service to use service discovery."
3509 },
3510 "immutable": true,
3511 "locationInModule": {
3512 "filename": "lib/base/base-service.ts",
3513 "line": 151
3514 },
3515 "name": "cloudMapOptions",
3516 "optional": true,
3517 "type": {
3518 "fqn": "@aws-cdk/aws-ecs.CloudMapOptions"
3519 }
3520 },
3521 {
3522 "abstract": true,
3523 "docs": {
3524 "default": "- Rolling update (ECS)",
3525 "remarks": "For more information, see\n[Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)",
3526 "stability": "stable",
3527 "summary": "Specifies which deployment controller to use for the service."
3528 },
3529 "immutable": true,
3530 "locationInModule": {
3531 "filename": "lib/base/base-service.ts",
3532 "line": 185
3533 },
3534 "name": "deploymentController",
3535 "optional": true,
3536 "type": {
3537 "fqn": "@aws-cdk/aws-ecs.DeploymentController"
3538 }
3539 },
3540 {
3541 "abstract": true,
3542 "docs": {
3543 "default": "- When creating the service, default is 1; when updating the service, default uses\nthe current task number.",
3544 "stability": "stable",
3545 "summary": "The desired number of instantiations of the task definition to keep running on the service."
3546 },
3547 "immutable": true,
3548 "locationInModule": {
3549 "filename": "lib/base/base-service.ts",
3550 "line": 111
3551 },
3552 "name": "desiredCount",
3553 "optional": true,
3554 "type": {
3555 "primitive": "number"
3556 }
3557 },
3558 {
3559 "abstract": true,
3560 "docs": {
3561 "default": "false",
3562 "remarks": "For more information, see\n[Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)",
3563 "stability": "stable",
3564 "summary": "Specifies whether to enable Amazon ECS managed tags for the tasks within the service."
3565 },
3566 "immutable": true,
3567 "locationInModule": {
3568 "filename": "lib/base/base-service.ts",
3569 "line": 177
3570 },
3571 "name": "enableECSManagedTags",
3572 "optional": true,
3573 "type": {
3574 "primitive": "boolean"
3575 }
3576 },
3577 {
3578 "abstract": true,
3579 "docs": {
3580 "default": "- undefined",
3581 "stability": "stable",
3582 "summary": "Whether to enable the ability to execute into a container."
3583 },
3584 "immutable": true,
3585 "locationInModule": {
3586 "filename": "lib/base/base-service.ts",
3587 "line": 207
3588 },
3589 "name": "enableExecuteCommand",
3590 "optional": true,
3591 "type": {
3592 "primitive": "boolean"
3593 }
3594 },
3595 {
3596 "abstract": true,
3597 "docs": {
3598 "default": "- defaults to 60 seconds if at least one load balancer is in-use and it is not already set",
3599 "stability": "stable",
3600 "summary": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started."
3601 },
3602 "immutable": true,
3603 "locationInModule": {
3604 "filename": "lib/base/base-service.ts",
3605 "line": 144
3606 },
3607 "name": "healthCheckGracePeriod",
3608 "optional": true,
3609 "type": {
3610 "fqn": "@aws-cdk/core.Duration"
3611 }
3612 },
3613 {
3614 "abstract": true,
3615 "docs": {
3616 "default": "- 100 if daemon, otherwise 200",
3617 "stability": "stable",
3618 "summary": "The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment."
3619 },
3620 "immutable": true,
3621 "locationInModule": {
3622 "filename": "lib/base/base-service.ts",
3623 "line": 127
3624 },
3625 "name": "maxHealthyPercent",
3626 "optional": true,
3627 "type": {
3628 "primitive": "number"
3629 }
3630 },
3631 {
3632 "abstract": true,
3633 "docs": {
3634 "default": "- 0 if daemon, otherwise 50",
3635 "stability": "stable",
3636 "summary": "The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment."
3637 },
3638 "immutable": true,
3639 "locationInModule": {
3640 "filename": "lib/base/base-service.ts",
3641 "line": 136
3642 },
3643 "name": "minHealthyPercent",
3644 "optional": true,
3645 "type": {
3646 "primitive": "number"
3647 }
3648 },
3649 {
3650 "abstract": true,
3651 "docs": {
3652 "default": "PropagatedTagSource.NONE",
3653 "remarks": "Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE",
3654 "stability": "stable",
3655 "summary": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service."
3656 },
3657 "immutable": true,
3658 "locationInModule": {
3659 "filename": "lib/base/base-service.ts",
3660 "line": 160
3661 },
3662 "name": "propagateTags",
3663 "optional": true,
3664 "type": {
3665 "fqn": "@aws-cdk/aws-ecs.PropagatedTagSource"
3666 }
3667 },
3668 {
3669 "abstract": true,
3670 "docs": {
3671 "default": "PropagatedTagSource.NONE",
3672 "deprecated": "Use `propagateTags` instead.",
3673 "remarks": "Tags can only be propagated to the tasks within the service during service creation.",
3674 "stability": "deprecated",
3675 "summary": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service."
3676 },
3677 "immutable": true,
3678 "locationInModule": {
3679 "filename": "lib/base/base-service.ts",
3680 "line": 169
3681 },
3682 "name": "propagateTaskTagsFrom",
3683 "optional": true,
3684 "type": {
3685 "fqn": "@aws-cdk/aws-ecs.PropagatedTagSource"
3686 }
3687 },
3688 {
3689 "abstract": true,
3690 "docs": {
3691 "default": "- CloudFormation-generated name.",
3692 "stability": "stable",
3693 "summary": "The name of the service."
3694 },
3695 "immutable": true,
3696 "locationInModule": {
3697 "filename": "lib/base/base-service.ts",
3698 "line": 118
3699 },
3700 "name": "serviceName",
3701 "optional": true,
3702 "type": {
3703 "primitive": "string"
3704 }
3705 }
3706 ],
3707 "symbolId": "lib/base/base-service:BaseServiceOptions"
3708 },
3709 "@aws-cdk/aws-ecs.BaseServiceProps": {
3710 "assembly": "@aws-cdk/aws-ecs",
3711 "datatype": true,
3712 "docs": {
3713 "stability": "stable",
3714 "summary": "Complete base service properties that are required to be supplied by the implementation of the BaseService class.",
3715 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as servicediscovery from '@aws-cdk/aws-servicediscovery';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const cluster: ecs.Cluster;\ndeclare const containerDefinition: ecs.ContainerDefinition;\ndeclare const namespace: servicediscovery.INamespace;\nconst baseServiceProps: ecs.BaseServiceProps = {\n cluster: cluster,\n launchType: ecs.LaunchType.EC2,\n\n // the properties below are optional\n capacityProviderStrategies: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n circuitBreaker: {\n rollback: false,\n },\n cloudMapOptions: {\n cloudMapNamespace: namespace,\n container: containerDefinition,\n containerPort: 123,\n dnsRecordType: servicediscovery.DnsRecordType.A,\n dnsTtl: cdk.Duration.minutes(30),\n failureThreshold: 123,\n name: 'name',\n },\n deploymentController: {\n type: ecs.DeploymentControllerType.ECS,\n },\n desiredCount: 123,\n enableECSManagedTags: false,\n enableExecuteCommand: false,\n healthCheckGracePeriod: cdk.Duration.minutes(30),\n maxHealthyPercent: 123,\n minHealthyPercent: 123,\n propagateTags: ecs.PropagatedTagSource.SERVICE,\n propagateTaskTagsFrom: ecs.PropagatedTagSource.SERVICE,\n serviceName: 'serviceName',\n};",
3716 "custom": {
3717 "exampleMetadata": "fixture=_generated"
3718 }
3719 },
3720 "fqn": "@aws-cdk/aws-ecs.BaseServiceProps",
3721 "interfaces": [
3722 "@aws-cdk/aws-ecs.BaseServiceOptions"
3723 ],
3724 "kind": "interface",
3725 "locationInModule": {
3726 "filename": "lib/base/base-service.ts",
3727 "line": 214
3728 },
3729 "name": "BaseServiceProps",
3730 "properties": [
3731 {
3732 "abstract": true,
3733 "docs": {
3734 "remarks": "LaunchType will be omitted if capacity provider strategies are specified on the service.",
3735 "see": "- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy\n\nValid values are: LaunchType.ECS or LaunchType.FARGATE or LaunchType.EXTERNAL",
3736 "stability": "stable",
3737 "summary": "The launch type on which to run your service."
3738 },
3739 "immutable": true,
3740 "locationInModule": {
3741 "filename": "lib/base/base-service.ts",
3742 "line": 224
3743 },
3744 "name": "launchType",
3745 "type": {
3746 "fqn": "@aws-cdk/aws-ecs.LaunchType"
3747 }
3748 }
3749 ],
3750 "symbolId": "lib/base/base-service:BaseServiceProps"
3751 },
3752 "@aws-cdk/aws-ecs.BinPackResource": {
3753 "assembly": "@aws-cdk/aws-ecs",
3754 "docs": {
3755 "stability": "stable",
3756 "summary": "Instance resource used for bin packing."
3757 },
3758 "fqn": "@aws-cdk/aws-ecs.BinPackResource",
3759 "kind": "enum",
3760 "locationInModule": {
3761 "filename": "lib/placement.ts",
3762 "line": 7
3763 },
3764 "members": [
3765 {
3766 "docs": {
3767 "stability": "stable",
3768 "summary": "Fill up hosts' CPU allocations first."
3769 },
3770 "name": "CPU"
3771 },
3772 {
3773 "docs": {
3774 "stability": "stable",
3775 "summary": "Fill up hosts' memory allocations first."
3776 },
3777 "name": "MEMORY"
3778 }
3779 ],
3780 "name": "BinPackResource",
3781 "symbolId": "lib/placement:BinPackResource"
3782 },
3783 "@aws-cdk/aws-ecs.BottleRocketImage": {
3784 "assembly": "@aws-cdk/aws-ecs",
3785 "docs": {
3786 "custom": {
3787 "exampleMetadata": "infused"
3788 },
3789 "example": "declare const cluster: ecs.Cluster;\n\ncluster.addCapacity('bottlerocket-asg', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c5.large'),\n machineImage: new ecs.BottleRocketImage(),\n});",
3790 "stability": "stable",
3791 "summary": "Construct an Bottlerocket image from the latest AMI published in SSM."
3792 },
3793 "fqn": "@aws-cdk/aws-ecs.BottleRocketImage",
3794 "initializer": {
3795 "docs": {
3796 "stability": "stable",
3797 "summary": "Constructs a new instance of the BottleRocketImage class."
3798 },
3799 "locationInModule": {
3800 "filename": "lib/amis.ts",
3801 "line": 345
3802 },
3803 "parameters": [
3804 {
3805 "name": "props",
3806 "optional": true,
3807 "type": {
3808 "fqn": "@aws-cdk/aws-ecs.BottleRocketImageProps"
3809 }
3810 }
3811 ]
3812 },
3813 "interfaces": [
3814 "@aws-cdk/aws-ec2.IMachineImage"
3815 ],
3816 "kind": "class",
3817 "locationInModule": {
3818 "filename": "lib/amis.ts",
3819 "line": 328
3820 },
3821 "methods": [
3822 {
3823 "docs": {
3824 "stability": "stable",
3825 "summary": "Return the correct image."
3826 },
3827 "locationInModule": {
3828 "filename": "lib/amis.ts",
3829 "line": 358
3830 },
3831 "name": "getImage",
3832 "overrides": "@aws-cdk/aws-ec2.IMachineImage",
3833 "parameters": [
3834 {
3835 "name": "scope",
3836 "type": {
3837 "fqn": "@aws-cdk/core.Construct"
3838 }
3839 }
3840 ],
3841 "returns": {
3842 "type": {
3843 "fqn": "@aws-cdk/aws-ec2.MachineImageConfig"
3844 }
3845 }
3846 }
3847 ],
3848 "name": "BottleRocketImage",
3849 "symbolId": "lib/amis:BottleRocketImage"
3850 },
3851 "@aws-cdk/aws-ecs.BottleRocketImageProps": {
3852 "assembly": "@aws-cdk/aws-ecs",
3853 "datatype": true,
3854 "docs": {
3855 "stability": "stable",
3856 "summary": "Properties for BottleRocketImage.",
3857 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst bottleRocketImageProps: ecs.BottleRocketImageProps = {\n architecture: ec2.InstanceArchitecture.ARM_64,\n cachedInContext: false,\n variant: ecs.BottlerocketEcsVariant.AWS_ECS_1,\n};",
3858 "custom": {
3859 "exampleMetadata": "fixture=_generated"
3860 }
3861 },
3862 "fqn": "@aws-cdk/aws-ecs.BottleRocketImageProps",
3863 "kind": "interface",
3864 "locationInModule": {
3865 "filename": "lib/amis.ts",
3866 "line": 287
3867 },
3868 "name": "BottleRocketImageProps",
3869 "properties": [
3870 {
3871 "abstract": true,
3872 "docs": {
3873 "default": "- x86_64",
3874 "stability": "stable",
3875 "summary": "The CPU architecture."
3876 },
3877 "immutable": true,
3878 "locationInModule": {
3879 "filename": "lib/amis.ts",
3880 "line": 301
3881 },
3882 "name": "architecture",
3883 "optional": true,
3884 "type": {
3885 "fqn": "@aws-cdk/aws-ec2.InstanceArchitecture"
3886 }
3887 },
3888 {
3889 "abstract": true,
3890 "docs": {
3891 "default": "false",
3892 "remarks": "By default, the newest image is used on each deployment. This will cause\ninstances to be replaced whenever a new version is released, and may cause\ndowntime if there aren't enough running instances in the AutoScalingGroup\nto reschedule the tasks on.\n\nIf set to true, the AMI ID will be cached in `cdk.context.json` and the\nsame value will be used on future runs. Your instances will not be replaced\nbut your AMI version will grow old over time. To refresh the AMI lookup,\nyou will have to evict the value from the cache using the `cdk context`\ncommand. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for\nmore information.\n\nCan not be set to `true` in environment-agnostic stacks.",
3893 "stability": "stable",
3894 "summary": "Whether the AMI ID is cached to be stable between deployments."
3895 },
3896 "immutable": true,
3897 "locationInModule": {
3898 "filename": "lib/amis.ts",
3899 "line": 322
3900 },
3901 "name": "cachedInContext",
3902 "optional": true,
3903 "type": {
3904 "primitive": "boolean"
3905 }
3906 },
3907 {
3908 "abstract": true,
3909 "docs": {
3910 "default": "- BottlerocketEcsVariant.AWS_ECS_1",
3911 "remarks": "Only `aws-ecs-1` is currently available",
3912 "stability": "stable",
3913 "summary": "The Amazon ECS variant to use."
3914 },
3915 "immutable": true,
3916 "locationInModule": {
3917 "filename": "lib/amis.ts",
3918 "line": 294
3919 },
3920 "name": "variant",
3921 "optional": true,
3922 "type": {
3923 "fqn": "@aws-cdk/aws-ecs.BottlerocketEcsVariant"
3924 }
3925 }
3926 ],
3927 "symbolId": "lib/amis:BottleRocketImageProps"
3928 },
3929 "@aws-cdk/aws-ecs.BottlerocketEcsVariant": {
3930 "assembly": "@aws-cdk/aws-ecs",
3931 "docs": {
3932 "stability": "stable",
3933 "summary": "Amazon ECS variant."
3934 },
3935 "fqn": "@aws-cdk/aws-ecs.BottlerocketEcsVariant",
3936 "kind": "enum",
3937 "locationInModule": {
3938 "filename": "lib/amis.ts",
3939 "line": 276
3940 },
3941 "members": [
3942 {
3943 "docs": {
3944 "stability": "stable",
3945 "summary": "aws-ecs-1 variant."
3946 },
3947 "name": "AWS_ECS_1"
3948 }
3949 ],
3950 "name": "BottlerocketEcsVariant",
3951 "symbolId": "lib/amis:BottlerocketEcsVariant"
3952 },
3953 "@aws-cdk/aws-ecs.BuiltInAttributes": {
3954 "assembly": "@aws-cdk/aws-ecs",
3955 "docs": {
3956 "stability": "stable",
3957 "summary": "The built-in container instance attributes.",
3958 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst builtInAttributes = new ecs.BuiltInAttributes();",
3959 "custom": {
3960 "exampleMetadata": "fixture=_generated"
3961 }
3962 },
3963 "fqn": "@aws-cdk/aws-ecs.BuiltInAttributes",
3964 "initializer": {
3965 "docs": {
3966 "stability": "stable"
3967 }
3968 },
3969 "kind": "class",
3970 "locationInModule": {
3971 "filename": "lib/ec2/ec2-service.ts",
3972 "line": 294
3973 },
3974 "name": "BuiltInAttributes",
3975 "properties": [
3976 {
3977 "const": true,
3978 "docs": {
3979 "stability": "stable",
3980 "summary": "The AMI id the instance is using."
3981 },
3982 "immutable": true,
3983 "locationInModule": {
3984 "filename": "lib/ec2/ec2-service.ts",
3985 "line": 308
3986 },
3987 "name": "AMI_ID",
3988 "static": true,
3989 "type": {
3990 "primitive": "string"
3991 }
3992 },
3993 {
3994 "const": true,
3995 "docs": {
3996 "stability": "stable",
3997 "summary": "The AvailabilityZone where the instance is running in."
3998 },
3999 "immutable": true,
4000 "locationInModule": {
4001 "filename": "lib/ec2/ec2-service.ts",
4002 "line": 303
4003 },
4004 "name": "AVAILABILITY_ZONE",
4005 "static": true,
4006 "type": {
4007 "primitive": "string"
4008 }
4009 },
4010 {
4011 "const": true,
4012 "docs": {
4013 "stability": "stable",
4014 "summary": "The id of the instance."
4015 },
4016 "immutable": true,
4017 "locationInModule": {
4018 "filename": "lib/ec2/ec2-service.ts",
4019 "line": 298
4020 },
4021 "name": "INSTANCE_ID",
4022 "static": true,
4023 "type": {
4024 "primitive": "string"
4025 }
4026 },
4027 {
4028 "const": true,
4029 "docs": {
4030 "stability": "stable",
4031 "summary": "The EC2 instance type."
4032 },
4033 "immutable": true,
4034 "locationInModule": {
4035 "filename": "lib/ec2/ec2-service.ts",
4036 "line": 313
4037 },
4038 "name": "INSTANCE_TYPE",
4039 "static": true,
4040 "type": {
4041 "primitive": "string"
4042 }
4043 },
4044 {
4045 "const": true,
4046 "docs": {
4047 "remarks": "Either 'linux' or 'windows'.",
4048 "stability": "stable",
4049 "summary": "The operating system of the instance."
4050 },
4051 "immutable": true,
4052 "locationInModule": {
4053 "filename": "lib/ec2/ec2-service.ts",
4054 "line": 320
4055 },
4056 "name": "OS_TYPE",
4057 "static": true,
4058 "type": {
4059 "primitive": "string"
4060 }
4061 }
4062 ],
4063 "symbolId": "lib/ec2/ec2-service:BuiltInAttributes"
4064 },
4065 "@aws-cdk/aws-ecs.Capability": {
4066 "assembly": "@aws-cdk/aws-ecs",
4067 "docs": {
4068 "stability": "stable",
4069 "summary": "A Linux capability."
4070 },
4071 "fqn": "@aws-cdk/aws-ecs.Capability",
4072 "kind": "enum",
4073 "locationInModule": {
4074 "filename": "lib/linux-parameters.ts",
4075 "line": 188
4076 },
4077 "members": [
4078 {
4079 "docs": {
4080 "stability": "stable"
4081 },
4082 "name": "ALL"
4083 },
4084 {
4085 "docs": {
4086 "stability": "stable"
4087 },
4088 "name": "AUDIT_CONTROL"
4089 },
4090 {
4091 "docs": {
4092 "stability": "stable"
4093 },
4094 "name": "AUDIT_WRITE"
4095 },
4096 {
4097 "docs": {
4098 "stability": "stable"
4099 },
4100 "name": "BLOCK_SUSPEND"
4101 },
4102 {
4103 "docs": {
4104 "stability": "stable"
4105 },
4106 "name": "CHOWN"
4107 },
4108 {
4109 "docs": {
4110 "stability": "stable"
4111 },
4112 "name": "DAC_OVERRIDE"
4113 },
4114 {
4115 "docs": {
4116 "stability": "stable"
4117 },
4118 "name": "DAC_READ_SEARCH"
4119 },
4120 {
4121 "docs": {
4122 "stability": "stable"
4123 },
4124 "name": "FOWNER"
4125 },
4126 {
4127 "docs": {
4128 "stability": "stable"
4129 },
4130 "name": "FSETID"
4131 },
4132 {
4133 "docs": {
4134 "stability": "stable"
4135 },
4136 "name": "IPC_LOCK"
4137 },
4138 {
4139 "docs": {
4140 "stability": "stable"
4141 },
4142 "name": "IPC_OWNER"
4143 },
4144 {
4145 "docs": {
4146 "stability": "stable"
4147 },
4148 "name": "KILL"
4149 },
4150 {
4151 "docs": {
4152 "stability": "stable"
4153 },
4154 "name": "LEASE"
4155 },
4156 {
4157 "docs": {
4158 "stability": "stable"
4159 },
4160 "name": "LINUX_IMMUTABLE"
4161 },
4162 {
4163 "docs": {
4164 "stability": "stable"
4165 },
4166 "name": "MAC_ADMIN"
4167 },
4168 {
4169 "docs": {
4170 "stability": "stable"
4171 },
4172 "name": "MAC_OVERRIDE"
4173 },
4174 {
4175 "docs": {
4176 "stability": "stable"
4177 },
4178 "name": "MKNOD"
4179 },
4180 {
4181 "docs": {
4182 "stability": "stable"
4183 },
4184 "name": "NET_ADMIN"
4185 },
4186 {
4187 "docs": {
4188 "stability": "stable"
4189 },
4190 "name": "NET_BIND_SERVICE"
4191 },
4192 {
4193 "docs": {
4194 "stability": "stable"
4195 },
4196 "name": "NET_BROADCAST"
4197 },
4198 {
4199 "docs": {
4200 "stability": "stable"
4201 },
4202 "name": "NET_RAW"
4203 },
4204 {
4205 "docs": {
4206 "stability": "stable"
4207 },
4208 "name": "SETFCAP"
4209 },
4210 {
4211 "docs": {
4212 "stability": "stable"
4213 },
4214 "name": "SETGID"
4215 },
4216 {
4217 "docs": {
4218 "stability": "stable"
4219 },
4220 "name": "SETPCAP"
4221 },
4222 {
4223 "docs": {
4224 "stability": "stable"
4225 },
4226 "name": "SETUID"
4227 },
4228 {
4229 "docs": {
4230 "stability": "stable"
4231 },
4232 "name": "SYS_ADMIN"
4233 },
4234 {
4235 "docs": {
4236 "stability": "stable"
4237 },
4238 "name": "SYS_BOOT"
4239 },
4240 {
4241 "docs": {
4242 "stability": "stable"
4243 },
4244 "name": "SYS_CHROOT"
4245 },
4246 {
4247 "docs": {
4248 "stability": "stable"
4249 },
4250 "name": "SYS_MODULE"
4251 },
4252 {
4253 "docs": {
4254 "stability": "stable"
4255 },
4256 "name": "SYS_NICE"
4257 },
4258 {
4259 "docs": {
4260 "stability": "stable"
4261 },
4262 "name": "SYS_PACCT"
4263 },
4264 {
4265 "docs": {
4266 "stability": "stable"
4267 },
4268 "name": "SYS_PTRACE"
4269 },
4270 {
4271 "docs": {
4272 "stability": "stable"
4273 },
4274 "name": "SYS_RAWIO"
4275 },
4276 {
4277 "docs": {
4278 "stability": "stable"
4279 },
4280 "name": "SYS_RESOURCE"
4281 },
4282 {
4283 "docs": {
4284 "stability": "stable"
4285 },
4286 "name": "SYS_TIME"
4287 },
4288 {
4289 "docs": {
4290 "stability": "stable"
4291 },
4292 "name": "SYS_TTY_CONFIG"
4293 },
4294 {
4295 "docs": {
4296 "stability": "stable"
4297 },
4298 "name": "SYSLOG"
4299 },
4300 {
4301 "docs": {
4302 "stability": "stable"
4303 },
4304 "name": "WAKE_ALARM"
4305 }
4306 ],
4307 "name": "Capability",
4308 "symbolId": "lib/linux-parameters:Capability"
4309 },
4310 "@aws-cdk/aws-ecs.CapacityProviderStrategy": {
4311 "assembly": "@aws-cdk/aws-ecs",
4312 "datatype": true,
4313 "docs": {
4314 "remarks": "NOTE: defaultCapacityProviderStrategy on cluster not currently supported.",
4315 "stability": "stable",
4316 "summary": "A Capacity Provider strategy to use for the service.",
4317 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst capacityProviderStrategy: ecs.CapacityProviderStrategy = {\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n};",
4318 "custom": {
4319 "exampleMetadata": "fixture=_generated"
4320 }
4321 },
4322 "fqn": "@aws-cdk/aws-ecs.CapacityProviderStrategy",
4323 "kind": "interface",
4324 "locationInModule": {
4325 "filename": "lib/cluster.ts",
4326 "line": 916
4327 },
4328 "name": "CapacityProviderStrategy",
4329 "properties": [
4330 {
4331 "abstract": true,
4332 "docs": {
4333 "stability": "stable",
4334 "summary": "The name of the capacity provider."
4335 },
4336 "immutable": true,
4337 "locationInModule": {
4338 "filename": "lib/cluster.ts",
4339 "line": 920
4340 },
4341 "name": "capacityProvider",
4342 "type": {
4343 "primitive": "string"
4344 }
4345 },
4346 {
4347 "abstract": true,
4348 "docs": {
4349 "default": "- none",
4350 "remarks": "Only one\ncapacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default\nvalue of 0 is used.",
4351 "stability": "stable",
4352 "summary": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider."
4353 },
4354 "immutable": true,
4355 "locationInModule": {
4356 "filename": "lib/cluster.ts",
4357 "line": 929
4358 },
4359 "name": "base",
4360 "optional": true,
4361 "type": {
4362 "primitive": "number"
4363 }
4364 },
4365 {
4366 "abstract": true,
4367 "docs": {
4368 "default": "- 0",
4369 "remarks": "The weight value is taken into consideration after the base value, if defined, is satisfied.",
4370 "stability": "stable",
4371 "summary": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider."
4372 },
4373 "immutable": true,
4374 "locationInModule": {
4375 "filename": "lib/cluster.ts",
4376 "line": 938
4377 },
4378 "name": "weight",
4379 "optional": true,
4380 "type": {
4381 "primitive": "number"
4382 }
4383 }
4384 ],
4385 "symbolId": "lib/cluster:CapacityProviderStrategy"
4386 },
4387 "@aws-cdk/aws-ecs.CfnCapacityProvider": {
4388 "assembly": "@aws-cdk/aws-ecs",
4389 "base": "@aws-cdk/core.CfnResource",
4390 "docs": {
4391 "custom": {
4392 "cloudformationResource": "AWS::ECS::CapacityProvider",
4393 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html",
4394 "exampleMetadata": "fixture=_generated"
4395 },
4396 "remarks": "The `AWS::ECS::CapacityProvider` resource creates an Amazon Elastic Container Service (Amazon ECS) capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.\n\nOnly capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the `FARGATE` and `FARGATE_SPOT` capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate .",
4397 "stability": "external",
4398 "summary": "A CloudFormation `AWS::ECS::CapacityProvider`.",
4399 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnCapacityProvider = new ecs.CfnCapacityProvider(this, 'MyCfnCapacityProvider', {\n autoScalingGroupProvider: {\n autoScalingGroupArn: 'autoScalingGroupArn',\n\n // the properties below are optional\n managedScaling: {\n instanceWarmupPeriod: 123,\n maximumScalingStepSize: 123,\n minimumScalingStepSize: 123,\n status: 'status',\n targetCapacity: 123,\n },\n managedTerminationProtection: 'managedTerminationProtection',\n },\n\n // the properties below are optional\n name: 'name',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
4400 },
4401 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider",
4402 "initializer": {
4403 "docs": {
4404 "stability": "external",
4405 "summary": "Create a new `AWS::ECS::CapacityProvider`."
4406 },
4407 "locationInModule": {
4408 "filename": "lib/ecs.generated.ts",
4409 "line": 180
4410 },
4411 "parameters": [
4412 {
4413 "docs": {
4414 "summary": "- scope in which this resource is defined."
4415 },
4416 "name": "scope",
4417 "type": {
4418 "fqn": "@aws-cdk/core.Construct"
4419 }
4420 },
4421 {
4422 "docs": {
4423 "summary": "- scoped id of the resource."
4424 },
4425 "name": "id",
4426 "type": {
4427 "primitive": "string"
4428 }
4429 },
4430 {
4431 "docs": {
4432 "summary": "- resource properties."
4433 },
4434 "name": "props",
4435 "type": {
4436 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProviderProps"
4437 }
4438 }
4439 ]
4440 },
4441 "interfaces": [
4442 "@aws-cdk/core.IInspectable"
4443 ],
4444 "kind": "class",
4445 "locationInModule": {
4446 "filename": "lib/ecs.generated.ts",
4447 "line": 117
4448 },
4449 "methods": [
4450 {
4451 "docs": {
4452 "stability": "external",
4453 "summary": "Examines the CloudFormation resource and discloses attributes."
4454 },
4455 "locationInModule": {
4456 "filename": "lib/ecs.generated.ts",
4457 "line": 195
4458 },
4459 "name": "inspect",
4460 "overrides": "@aws-cdk/core.IInspectable",
4461 "parameters": [
4462 {
4463 "docs": {
4464 "summary": "- tree inspector to collect and process attributes."
4465 },
4466 "name": "inspector",
4467 "type": {
4468 "fqn": "@aws-cdk/core.TreeInspector"
4469 }
4470 }
4471 ]
4472 },
4473 {
4474 "docs": {
4475 "stability": "external"
4476 },
4477 "locationInModule": {
4478 "filename": "lib/ecs.generated.ts",
4479 "line": 208
4480 },
4481 "name": "renderProperties",
4482 "overrides": "@aws-cdk/core.CfnResource",
4483 "parameters": [
4484 {
4485 "name": "props",
4486 "type": {
4487 "collection": {
4488 "elementtype": {
4489 "primitive": "any"
4490 },
4491 "kind": "map"
4492 }
4493 }
4494 }
4495 ],
4496 "protected": true,
4497 "returns": {
4498 "type": {
4499 "collection": {
4500 "elementtype": {
4501 "primitive": "any"
4502 },
4503 "kind": "map"
4504 }
4505 }
4506 }
4507 }
4508 ],
4509 "name": "CfnCapacityProvider",
4510 "properties": [
4511 {
4512 "const": true,
4513 "docs": {
4514 "stability": "external",
4515 "summary": "The CloudFormation resource type name for this resource class."
4516 },
4517 "immutable": true,
4518 "locationInModule": {
4519 "filename": "lib/ecs.generated.ts",
4520 "line": 121
4521 },
4522 "name": "CFN_RESOURCE_TYPE_NAME",
4523 "static": true,
4524 "type": {
4525 "primitive": "string"
4526 }
4527 },
4528 {
4529 "docs": {
4530 "stability": "external"
4531 },
4532 "immutable": true,
4533 "locationInModule": {
4534 "filename": "lib/ecs.generated.ts",
4535 "line": 200
4536 },
4537 "name": "cfnProperties",
4538 "overrides": "@aws-cdk/core.CfnResource",
4539 "protected": true,
4540 "type": {
4541 "collection": {
4542 "elementtype": {
4543 "primitive": "any"
4544 },
4545 "kind": "map"
4546 }
4547 }
4548 },
4549 {
4550 "docs": {
4551 "custom": {
4552 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags"
4553 },
4554 "remarks": "Each tag consists of a key and an optional value. You define both.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
4555 "stability": "external",
4556 "summary": "The metadata that you apply to the capacity provider to help you categorize and organize it."
4557 },
4558 "immutable": true,
4559 "locationInModule": {
4560 "filename": "lib/ecs.generated.ts",
4561 "line": 171
4562 },
4563 "name": "tags",
4564 "type": {
4565 "fqn": "@aws-cdk/core.TagManager"
4566 }
4567 },
4568 {
4569 "docs": {
4570 "custom": {
4571 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider"
4572 },
4573 "stability": "external",
4574 "summary": "The Auto Scaling group settings for the capacity provider."
4575 },
4576 "locationInModule": {
4577 "filename": "lib/ecs.generated.ts",
4578 "line": 147
4579 },
4580 "name": "autoScalingGroupProvider",
4581 "type": {
4582 "union": {
4583 "types": [
4584 {
4585 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty"
4586 },
4587 {
4588 "fqn": "@aws-cdk/core.IResolvable"
4589 }
4590 ]
4591 }
4592 }
4593 },
4594 {
4595 "docs": {
4596 "custom": {
4597 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name"
4598 },
4599 "remarks": "If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.",
4600 "stability": "external",
4601 "summary": "The name of the capacity provider."
4602 },
4603 "locationInModule": {
4604 "filename": "lib/ecs.generated.ts",
4605 "line": 154
4606 },
4607 "name": "name",
4608 "optional": true,
4609 "type": {
4610 "primitive": "string"
4611 }
4612 }
4613 ],
4614 "symbolId": "lib/ecs.generated:CfnCapacityProvider"
4615 },
4616 "@aws-cdk/aws-ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty": {
4617 "assembly": "@aws-cdk/aws-ecs",
4618 "datatype": true,
4619 "docs": {
4620 "custom": {
4621 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html",
4622 "exampleMetadata": "fixture=_generated"
4623 },
4624 "stability": "external",
4625 "summary": "The `AutoScalingGroupProvider` property specifies the details of the Auto Scaling group for the capacity provider.",
4626 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst autoScalingGroupProviderProperty: ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty = {\n autoScalingGroupArn: 'autoScalingGroupArn',\n\n // the properties below are optional\n managedScaling: {\n instanceWarmupPeriod: 123,\n maximumScalingStepSize: 123,\n minimumScalingStepSize: 123,\n status: 'status',\n targetCapacity: 123,\n },\n managedTerminationProtection: 'managedTerminationProtection',\n};"
4627 },
4628 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty",
4629 "kind": "interface",
4630 "locationInModule": {
4631 "filename": "lib/ecs.generated.ts",
4632 "line": 222
4633 },
4634 "name": "AutoScalingGroupProviderProperty",
4635 "namespace": "CfnCapacityProvider",
4636 "properties": [
4637 {
4638 "abstract": true,
4639 "docs": {
4640 "custom": {
4641 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-autoscalinggrouparn"
4642 },
4643 "stability": "external",
4644 "summary": "The Amazon Resource Name (ARN) or short name that identifies the Auto Scaling group."
4645 },
4646 "immutable": true,
4647 "locationInModule": {
4648 "filename": "lib/ecs.generated.ts",
4649 "line": 228
4650 },
4651 "name": "autoScalingGroupArn",
4652 "type": {
4653 "primitive": "string"
4654 }
4655 },
4656 {
4657 "abstract": true,
4658 "docs": {
4659 "custom": {
4660 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedscaling"
4661 },
4662 "stability": "external",
4663 "summary": "The managed scaling settings for the Auto Scaling group capacity provider."
4664 },
4665 "immutable": true,
4666 "locationInModule": {
4667 "filename": "lib/ecs.generated.ts",
4668 "line": 234
4669 },
4670 "name": "managedScaling",
4671 "optional": true,
4672 "type": {
4673 "union": {
4674 "types": [
4675 {
4676 "fqn": "@aws-cdk/core.IResolvable"
4677 },
4678 {
4679 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider.ManagedScalingProperty"
4680 }
4681 ]
4682 }
4683 }
4684 },
4685 {
4686 "abstract": true,
4687 "docs": {
4688 "custom": {
4689 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedterminationprotection"
4690 },
4691 "remarks": "This determines whether the Auto Scaling group has managed termination protection. The default is disabled.\n\n> When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.\n\nWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the *AWS Auto Scaling User Guide* .\n\nWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.",
4692 "stability": "external",
4693 "summary": "The managed termination protection setting to use for the Auto Scaling group capacity provider."
4694 },
4695 "immutable": true,
4696 "locationInModule": {
4697 "filename": "lib/ecs.generated.ts",
4698 "line": 246
4699 },
4700 "name": "managedTerminationProtection",
4701 "optional": true,
4702 "type": {
4703 "primitive": "string"
4704 }
4705 }
4706 ],
4707 "symbolId": "lib/ecs.generated:CfnCapacityProvider.AutoScalingGroupProviderProperty"
4708 },
4709 "@aws-cdk/aws-ecs.CfnCapacityProvider.ManagedScalingProperty": {
4710 "assembly": "@aws-cdk/aws-ecs",
4711 "datatype": true,
4712 "docs": {
4713 "custom": {
4714 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html",
4715 "exampleMetadata": "fixture=_generated"
4716 },
4717 "remarks": "When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified `targetCapacity` value as the target value for the metric. For more information, see [Using Managed Scaling](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) in the *Amazon Elastic Container Service Developer Guide* .\n\nIf managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.",
4718 "stability": "external",
4719 "summary": "The `ManagedScaling` property specifies the settings for the Auto Scaling group capacity provider.",
4720 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst managedScalingProperty: ecs.CfnCapacityProvider.ManagedScalingProperty = {\n instanceWarmupPeriod: 123,\n maximumScalingStepSize: 123,\n minimumScalingStepSize: 123,\n status: 'status',\n targetCapacity: 123,\n};"
4721 },
4722 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider.ManagedScalingProperty",
4723 "kind": "interface",
4724 "locationInModule": {
4725 "filename": "lib/ecs.generated.ts",
4726 "line": 318
4727 },
4728 "name": "ManagedScalingProperty",
4729 "namespace": "CfnCapacityProvider",
4730 "properties": [
4731 {
4732 "abstract": true,
4733 "docs": {
4734 "custom": {
4735 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-instancewarmupperiod"
4736 },
4737 "remarks": "If this parameter is omitted, the default value of `300` seconds is used.",
4738 "stability": "external",
4739 "summary": "The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group."
4740 },
4741 "immutable": true,
4742 "locationInModule": {
4743 "filename": "lib/ecs.generated.ts",
4744 "line": 324
4745 },
4746 "name": "instanceWarmupPeriod",
4747 "optional": true,
4748 "type": {
4749 "primitive": "number"
4750 }
4751 },
4752 {
4753 "abstract": true,
4754 "docs": {
4755 "custom": {
4756 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-maximumscalingstepsize"
4757 },
4758 "remarks": "If this parameter is omitted, the default value of `10000` is used.",
4759 "stability": "external",
4760 "summary": "The maximum number of container instances that Amazon ECS scales in or scales out at one time."
4761 },
4762 "immutable": true,
4763 "locationInModule": {
4764 "filename": "lib/ecs.generated.ts",
4765 "line": 330
4766 },
4767 "name": "maximumScalingStepSize",
4768 "optional": true,
4769 "type": {
4770 "primitive": "number"
4771 }
4772 },
4773 {
4774 "abstract": true,
4775 "docs": {
4776 "custom": {
4777 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-minimumscalingstepsize"
4778 },
4779 "remarks": "If this parameter is omitted, the default value of `1` is used.",
4780 "stability": "external",
4781 "summary": "The minimum number of container instances that Amazon ECS scales in or scales out at one time."
4782 },
4783 "immutable": true,
4784 "locationInModule": {
4785 "filename": "lib/ecs.generated.ts",
4786 "line": 336
4787 },
4788 "name": "minimumScalingStepSize",
4789 "optional": true,
4790 "type": {
4791 "primitive": "number"
4792 }
4793 },
4794 {
4795 "abstract": true,
4796 "docs": {
4797 "custom": {
4798 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-status"
4799 },
4800 "stability": "external",
4801 "summary": "Determines whether to use managed scaling for the capacity provider."
4802 },
4803 "immutable": true,
4804 "locationInModule": {
4805 "filename": "lib/ecs.generated.ts",
4806 "line": 342
4807 },
4808 "name": "status",
4809 "optional": true,
4810 "type": {
4811 "primitive": "string"
4812 }
4813 },
4814 {
4815 "abstract": true,
4816 "docs": {
4817 "custom": {
4818 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-targetcapacity"
4819 },
4820 "remarks": "The specified value must be greater than `0` and less than or equal to `100` . A value of `100` results in the Amazon EC2 instances in your Auto Scaling group being completely used.",
4821 "stability": "external",
4822 "summary": "The target capacity value for the capacity provider."
4823 },
4824 "immutable": true,
4825 "locationInModule": {
4826 "filename": "lib/ecs.generated.ts",
4827 "line": 348
4828 },
4829 "name": "targetCapacity",
4830 "optional": true,
4831 "type": {
4832 "primitive": "number"
4833 }
4834 }
4835 ],
4836 "symbolId": "lib/ecs.generated:CfnCapacityProvider.ManagedScalingProperty"
4837 },
4838 "@aws-cdk/aws-ecs.CfnCapacityProviderProps": {
4839 "assembly": "@aws-cdk/aws-ecs",
4840 "datatype": true,
4841 "docs": {
4842 "custom": {
4843 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html",
4844 "exampleMetadata": "fixture=_generated"
4845 },
4846 "stability": "external",
4847 "summary": "Properties for defining a `CfnCapacityProvider`.",
4848 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnCapacityProviderProps: ecs.CfnCapacityProviderProps = {\n autoScalingGroupProvider: {\n autoScalingGroupArn: 'autoScalingGroupArn',\n\n // the properties below are optional\n managedScaling: {\n instanceWarmupPeriod: 123,\n maximumScalingStepSize: 123,\n minimumScalingStepSize: 123,\n status: 'status',\n targetCapacity: 123,\n },\n managedTerminationProtection: 'managedTerminationProtection',\n },\n\n // the properties below are optional\n name: 'name',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
4849 },
4850 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProviderProps",
4851 "kind": "interface",
4852 "locationInModule": {
4853 "filename": "lib/ecs.generated.ts",
4854 "line": 19
4855 },
4856 "name": "CfnCapacityProviderProps",
4857 "properties": [
4858 {
4859 "abstract": true,
4860 "docs": {
4861 "custom": {
4862 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider"
4863 },
4864 "stability": "external",
4865 "summary": "The Auto Scaling group settings for the capacity provider."
4866 },
4867 "immutable": true,
4868 "locationInModule": {
4869 "filename": "lib/ecs.generated.ts",
4870 "line": 26
4871 },
4872 "name": "autoScalingGroupProvider",
4873 "type": {
4874 "union": {
4875 "types": [
4876 {
4877 "fqn": "@aws-cdk/aws-ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty"
4878 },
4879 {
4880 "fqn": "@aws-cdk/core.IResolvable"
4881 }
4882 ]
4883 }
4884 }
4885 },
4886 {
4887 "abstract": true,
4888 "docs": {
4889 "custom": {
4890 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name"
4891 },
4892 "remarks": "If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.",
4893 "stability": "external",
4894 "summary": "The name of the capacity provider."
4895 },
4896 "immutable": true,
4897 "locationInModule": {
4898 "filename": "lib/ecs.generated.ts",
4899 "line": 33
4900 },
4901 "name": "name",
4902 "optional": true,
4903 "type": {
4904 "primitive": "string"
4905 }
4906 },
4907 {
4908 "abstract": true,
4909 "docs": {
4910 "custom": {
4911 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags"
4912 },
4913 "remarks": "Each tag consists of a key and an optional value. You define both.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
4914 "stability": "external",
4915 "summary": "The metadata that you apply to the capacity provider to help you categorize and organize it."
4916 },
4917 "immutable": true,
4918 "locationInModule": {
4919 "filename": "lib/ecs.generated.ts",
4920 "line": 50
4921 },
4922 "name": "tags",
4923 "optional": true,
4924 "type": {
4925 "collection": {
4926 "elementtype": {
4927 "fqn": "@aws-cdk/core.CfnTag"
4928 },
4929 "kind": "array"
4930 }
4931 }
4932 }
4933 ],
4934 "symbolId": "lib/ecs.generated:CfnCapacityProviderProps"
4935 },
4936 "@aws-cdk/aws-ecs.CfnCluster": {
4937 "assembly": "@aws-cdk/aws-ecs",
4938 "base": "@aws-cdk/core.CfnResource",
4939 "docs": {
4940 "custom": {
4941 "cloudformationResource": "AWS::ECS::Cluster",
4942 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html",
4943 "exampleMetadata": "fixture=_generated"
4944 },
4945 "remarks": "The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.",
4946 "stability": "external",
4947 "summary": "A CloudFormation `AWS::ECS::Cluster`.",
4948 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnCluster = new ecs.CfnCluster(this, 'MyCfnCluster', /* all optional props */ {\n capacityProviders: ['capacityProviders'],\n clusterName: 'clusterName',\n clusterSettings: [{\n name: 'name',\n value: 'value',\n }],\n configuration: {\n executeCommandConfiguration: {\n kmsKeyId: 'kmsKeyId',\n logConfiguration: {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n s3BucketName: 's3BucketName',\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n },\n logging: 'logging',\n },\n },\n defaultCapacityProviderStrategy: [{\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
4949 },
4950 "fqn": "@aws-cdk/aws-ecs.CfnCluster",
4951 "initializer": {
4952 "docs": {
4953 "stability": "external",
4954 "summary": "Create a new `AWS::ECS::Cluster`."
4955 },
4956 "locationInModule": {
4957 "filename": "lib/ecs.generated.ts",
4958 "line": 643
4959 },
4960 "parameters": [
4961 {
4962 "docs": {
4963 "summary": "- scope in which this resource is defined."
4964 },
4965 "name": "scope",
4966 "type": {
4967 "fqn": "@aws-cdk/core.Construct"
4968 }
4969 },
4970 {
4971 "docs": {
4972 "summary": "- scoped id of the resource."
4973 },
4974 "name": "id",
4975 "type": {
4976 "primitive": "string"
4977 }
4978 },
4979 {
4980 "docs": {
4981 "summary": "- resource properties."
4982 },
4983 "name": "props",
4984 "optional": true,
4985 "type": {
4986 "fqn": "@aws-cdk/aws-ecs.CfnClusterProps"
4987 }
4988 }
4989 ]
4990 },
4991 "interfaces": [
4992 "@aws-cdk/core.IInspectable"
4993 ],
4994 "kind": "class",
4995 "locationInModule": {
4996 "filename": "lib/ecs.generated.ts",
4997 "line": 549
4998 },
4999 "methods": [
5000 {
5001 "docs": {
5002 "stability": "external",
5003 "summary": "Examines the CloudFormation resource and discloses attributes."
5004 },
5005 "locationInModule": {
5006 "filename": "lib/ecs.generated.ts",
5007 "line": 661
5008 },
5009 "name": "inspect",
5010 "overrides": "@aws-cdk/core.IInspectable",
5011 "parameters": [
5012 {
5013 "docs": {
5014 "summary": "- tree inspector to collect and process attributes."
5015 },
5016 "name": "inspector",
5017 "type": {
5018 "fqn": "@aws-cdk/core.TreeInspector"
5019 }
5020 }
5021 ]
5022 },
5023 {
5024 "docs": {
5025 "stability": "external"
5026 },
5027 "locationInModule": {
5028 "filename": "lib/ecs.generated.ts",
5029 "line": 677
5030 },
5031 "name": "renderProperties",
5032 "overrides": "@aws-cdk/core.CfnResource",
5033 "parameters": [
5034 {
5035 "name": "props",
5036 "type": {
5037 "collection": {
5038 "elementtype": {
5039 "primitive": "any"
5040 },
5041 "kind": "map"
5042 }
5043 }
5044 }
5045 ],
5046 "protected": true,
5047 "returns": {
5048 "type": {
5049 "collection": {
5050 "elementtype": {
5051 "primitive": "any"
5052 },
5053 "kind": "map"
5054 }
5055 }
5056 }
5057 }
5058 ],
5059 "name": "CfnCluster",
5060 "properties": [
5061 {
5062 "const": true,
5063 "docs": {
5064 "stability": "external",
5065 "summary": "The CloudFormation resource type name for this resource class."
5066 },
5067 "immutable": true,
5068 "locationInModule": {
5069 "filename": "lib/ecs.generated.ts",
5070 "line": 553
5071 },
5072 "name": "CFN_RESOURCE_TYPE_NAME",
5073 "static": true,
5074 "type": {
5075 "primitive": "string"
5076 }
5077 },
5078 {
5079 "docs": {
5080 "custom": {
5081 "cloudformationAttribute": "Arn"
5082 },
5083 "stability": "external",
5084 "summary": "The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as `arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster` ."
5085 },
5086 "immutable": true,
5087 "locationInModule": {
5088 "filename": "lib/ecs.generated.ts",
5089 "line": 578
5090 },
5091 "name": "attrArn",
5092 "type": {
5093 "primitive": "string"
5094 }
5095 },
5096 {
5097 "docs": {
5098 "stability": "external"
5099 },
5100 "immutable": true,
5101 "locationInModule": {
5102 "filename": "lib/ecs.generated.ts",
5103 "line": 666
5104 },
5105 "name": "cfnProperties",
5106 "overrides": "@aws-cdk/core.CfnResource",
5107 "protected": true,
5108 "type": {
5109 "collection": {
5110 "elementtype": {
5111 "primitive": "any"
5112 },
5113 "kind": "map"
5114 }
5115 }
5116 },
5117 {
5118 "docs": {
5119 "custom": {
5120 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-tags"
5121 },
5122 "remarks": "Each tag consists of a key and an optional value. You define both.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
5123 "stability": "external",
5124 "summary": "The metadata that you apply to the cluster to help you categorize and organize them."
5125 },
5126 "immutable": true,
5127 "locationInModule": {
5128 "filename": "lib/ecs.generated.ts",
5129 "line": 634
5130 },
5131 "name": "tags",
5132 "type": {
5133 "fqn": "@aws-cdk/core.TagManager"
5134 }
5135 },
5136 {
5137 "docs": {
5138 "custom": {
5139 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-capacityproviders"
5140 },
5141 "remarks": "A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy.\n\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster.\n\nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.",
5142 "stability": "external",
5143 "summary": "The short name of one or more capacity providers to associate with the cluster."
5144 },
5145 "locationInModule": {
5146 "filename": "lib/ecs.generated.ts",
5147 "line": 589
5148 },
5149 "name": "capacityProviders",
5150 "optional": true,
5151 "type": {
5152 "collection": {
5153 "elementtype": {
5154 "primitive": "string"
5155 },
5156 "kind": "array"
5157 }
5158 }
5159 },
5160 {
5161 "docs": {
5162 "custom": {
5163 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername"
5164 },
5165 "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.",
5166 "stability": "external",
5167 "summary": "A user-generated string that you use to identify your cluster."
5168 },
5169 "locationInModule": {
5170 "filename": "lib/ecs.generated.ts",
5171 "line": 596
5172 },
5173 "name": "clusterName",
5174 "optional": true,
5175 "type": {
5176 "primitive": "string"
5177 }
5178 },
5179 {
5180 "docs": {
5181 "custom": {
5182 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings"
5183 },
5184 "remarks": "This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html) .",
5185 "stability": "external",
5186 "summary": "The setting to use when creating a cluster."
5187 },
5188 "locationInModule": {
5189 "filename": "lib/ecs.generated.ts",
5190 "line": 603
5191 },
5192 "name": "clusterSettings",
5193 "optional": true,
5194 "type": {
5195 "union": {
5196 "types": [
5197 {
5198 "fqn": "@aws-cdk/core.IResolvable"
5199 },
5200 {
5201 "collection": {
5202 "elementtype": {
5203 "union": {
5204 "types": [
5205 {
5206 "fqn": "@aws-cdk/core.IResolvable"
5207 },
5208 {
5209 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterSettingsProperty"
5210 }
5211 ]
5212 }
5213 },
5214 "kind": "array"
5215 }
5216 }
5217 ]
5218 }
5219 }
5220 },
5221 {
5222 "docs": {
5223 "custom": {
5224 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-configuration"
5225 },
5226 "stability": "external",
5227 "summary": "The execute command configuration for the cluster."
5228 },
5229 "locationInModule": {
5230 "filename": "lib/ecs.generated.ts",
5231 "line": 610
5232 },
5233 "name": "configuration",
5234 "optional": true,
5235 "type": {
5236 "union": {
5237 "types": [
5238 {
5239 "fqn": "@aws-cdk/core.IResolvable"
5240 },
5241 {
5242 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterConfigurationProperty"
5243 }
5244 ]
5245 }
5246 }
5247 },
5248 {
5249 "docs": {
5250 "custom": {
5251 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-defaultcapacityproviderstrategy"
5252 },
5253 "remarks": "When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.",
5254 "stability": "external",
5255 "summary": "The default capacity provider strategy for the cluster."
5256 },
5257 "locationInModule": {
5258 "filename": "lib/ecs.generated.ts",
5259 "line": 617
5260 },
5261 "name": "defaultCapacityProviderStrategy",
5262 "optional": true,
5263 "type": {
5264 "union": {
5265 "types": [
5266 {
5267 "fqn": "@aws-cdk/core.IResolvable"
5268 },
5269 {
5270 "collection": {
5271 "elementtype": {
5272 "union": {
5273 "types": [
5274 {
5275 "fqn": "@aws-cdk/core.IResolvable"
5276 },
5277 {
5278 "fqn": "@aws-cdk/aws-ecs.CfnCluster.CapacityProviderStrategyItemProperty"
5279 }
5280 ]
5281 }
5282 },
5283 "kind": "array"
5284 }
5285 }
5286 ]
5287 }
5288 }
5289 }
5290 ],
5291 "symbolId": "lib/ecs.generated:CfnCluster"
5292 },
5293 "@aws-cdk/aws-ecs.CfnCluster.CapacityProviderStrategyItemProperty": {
5294 "assembly": "@aws-cdk/aws-ecs",
5295 "datatype": true,
5296 "docs": {
5297 "custom": {
5298 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html",
5299 "exampleMetadata": "fixture=_generated"
5300 },
5301 "remarks": "When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.",
5302 "stability": "external",
5303 "summary": "The `CapacityProviderStrategyItem` property specifies the details of the default capacity provider strategy for the cluster.",
5304 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst capacityProviderStrategyItemProperty: ecs.CfnCluster.CapacityProviderStrategyItemProperty = {\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n};"
5305 },
5306 "fqn": "@aws-cdk/aws-ecs.CfnCluster.CapacityProviderStrategyItemProperty",
5307 "kind": "interface",
5308 "locationInModule": {
5309 "filename": "lib/ecs.generated.ts",
5310 "line": 691
5311 },
5312 "name": "CapacityProviderStrategyItemProperty",
5313 "namespace": "CfnCluster",
5314 "properties": [
5315 {
5316 "abstract": true,
5317 "docs": {
5318 "custom": {
5319 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base"
5320 },
5321 "remarks": "Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used.",
5322 "stability": "external",
5323 "summary": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider."
5324 },
5325 "immutable": true,
5326 "locationInModule": {
5327 "filename": "lib/ecs.generated.ts",
5328 "line": 697
5329 },
5330 "name": "base",
5331 "optional": true,
5332 "type": {
5333 "primitive": "number"
5334 }
5335 },
5336 {
5337 "abstract": true,
5338 "docs": {
5339 "custom": {
5340 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider"
5341 },
5342 "stability": "external",
5343 "summary": "The short name of the capacity provider."
5344 },
5345 "immutable": true,
5346 "locationInModule": {
5347 "filename": "lib/ecs.generated.ts",
5348 "line": 703
5349 },
5350 "name": "capacityProvider",
5351 "optional": true,
5352 "type": {
5353 "primitive": "string"
5354 }
5355 },
5356 {
5357 "abstract": true,
5358 "docs": {
5359 "custom": {
5360 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-weight"
5361 },
5362 "remarks": "The `weight` value is taken into consideration after the `base` value, if defined, is satisfied.\n\nIf no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail.\n\nAn example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of `1` , then when the `base` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of `1` for *capacityProviderA* and a weight of `4` for *capacityProviderB* , then for every one task that's run using *capacityProviderA* , four tasks would use *capacityProviderB* .",
5363 "stability": "external",
5364 "summary": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider."
5365 },
5366 "immutable": true,
5367 "locationInModule": {
5368 "filename": "lib/ecs.generated.ts",
5369 "line": 713
5370 },
5371 "name": "weight",
5372 "optional": true,
5373 "type": {
5374 "primitive": "number"
5375 }
5376 }
5377 ],
5378 "symbolId": "lib/ecs.generated:CfnCluster.CapacityProviderStrategyItemProperty"
5379 },
5380 "@aws-cdk/aws-ecs.CfnCluster.ClusterConfigurationProperty": {
5381 "assembly": "@aws-cdk/aws-ecs",
5382 "datatype": true,
5383 "docs": {
5384 "custom": {
5385 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html",
5386 "exampleMetadata": "fixture=_generated"
5387 },
5388 "stability": "external",
5389 "summary": "The execute command configuration for the cluster.",
5390 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst clusterConfigurationProperty: ecs.CfnCluster.ClusterConfigurationProperty = {\n executeCommandConfiguration: {\n kmsKeyId: 'kmsKeyId',\n logConfiguration: {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n s3BucketName: 's3BucketName',\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n },\n logging: 'logging',\n },\n};"
5391 },
5392 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterConfigurationProperty",
5393 "kind": "interface",
5394 "locationInModule": {
5395 "filename": "lib/ecs.generated.ts",
5396 "line": 780
5397 },
5398 "name": "ClusterConfigurationProperty",
5399 "namespace": "CfnCluster",
5400 "properties": [
5401 {
5402 "abstract": true,
5403 "docs": {
5404 "custom": {
5405 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-executecommandconfiguration"
5406 },
5407 "stability": "external",
5408 "summary": "The details of the execute command configuration."
5409 },
5410 "immutable": true,
5411 "locationInModule": {
5412 "filename": "lib/ecs.generated.ts",
5413 "line": 786
5414 },
5415 "name": "executeCommandConfiguration",
5416 "optional": true,
5417 "type": {
5418 "union": {
5419 "types": [
5420 {
5421 "fqn": "@aws-cdk/core.IResolvable"
5422 },
5423 {
5424 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandConfigurationProperty"
5425 }
5426 ]
5427 }
5428 }
5429 }
5430 ],
5431 "symbolId": "lib/ecs.generated:CfnCluster.ClusterConfigurationProperty"
5432 },
5433 "@aws-cdk/aws-ecs.CfnCluster.ClusterSettingsProperty": {
5434 "assembly": "@aws-cdk/aws-ecs",
5435 "datatype": true,
5436 "docs": {
5437 "custom": {
5438 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html",
5439 "exampleMetadata": "fixture=_generated"
5440 },
5441 "remarks": "This parameter is used to turn on CloudWatch Container Insights for a cluster.",
5442 "stability": "external",
5443 "summary": "The settings to use when creating a cluster.",
5444 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst clusterSettingsProperty: ecs.CfnCluster.ClusterSettingsProperty = {\n name: 'name',\n value: 'value',\n};"
5445 },
5446 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterSettingsProperty",
5447 "kind": "interface",
5448 "locationInModule": {
5449 "filename": "lib/ecs.generated.ts",
5450 "line": 847
5451 },
5452 "name": "ClusterSettingsProperty",
5453 "namespace": "CfnCluster",
5454 "properties": [
5455 {
5456 "abstract": true,
5457 "docs": {
5458 "custom": {
5459 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-name"
5460 },
5461 "remarks": "The only supported value is `containerInsights` .",
5462 "stability": "external",
5463 "summary": "The name of the cluster setting."
5464 },
5465 "immutable": true,
5466 "locationInModule": {
5467 "filename": "lib/ecs.generated.ts",
5468 "line": 853
5469 },
5470 "name": "name",
5471 "optional": true,
5472 "type": {
5473 "primitive": "string"
5474 }
5475 },
5476 {
5477 "abstract": true,
5478 "docs": {
5479 "custom": {
5480 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-value"
5481 },
5482 "remarks": "The supported values are `enabled` and `disabled` . If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the `containerInsights` account setting is enabled. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html) .",
5483 "stability": "external",
5484 "summary": "The value to set for the cluster setting."
5485 },
5486 "immutable": true,
5487 "locationInModule": {
5488 "filename": "lib/ecs.generated.ts",
5489 "line": 859
5490 },
5491 "name": "value",
5492 "optional": true,
5493 "type": {
5494 "primitive": "string"
5495 }
5496 }
5497 ],
5498 "symbolId": "lib/ecs.generated:CfnCluster.ClusterSettingsProperty"
5499 },
5500 "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandConfigurationProperty": {
5501 "assembly": "@aws-cdk/aws-ecs",
5502 "datatype": true,
5503 "docs": {
5504 "custom": {
5505 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html",
5506 "exampleMetadata": "fixture=_generated"
5507 },
5508 "stability": "external",
5509 "summary": "The details of the execute command configuration.",
5510 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst executeCommandConfigurationProperty: ecs.CfnCluster.ExecuteCommandConfigurationProperty = {\n kmsKeyId: 'kmsKeyId',\n logConfiguration: {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n s3BucketName: 's3BucketName',\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n },\n logging: 'logging',\n};"
5511 },
5512 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandConfigurationProperty",
5513 "kind": "interface",
5514 "locationInModule": {
5515 "filename": "lib/ecs.generated.ts",
5516 "line": 923
5517 },
5518 "name": "ExecuteCommandConfigurationProperty",
5519 "namespace": "CfnCluster",
5520 "properties": [
5521 {
5522 "abstract": true,
5523 "docs": {
5524 "custom": {
5525 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-kmskeyid"
5526 },
5527 "stability": "external",
5528 "summary": "Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container."
5529 },
5530 "immutable": true,
5531 "locationInModule": {
5532 "filename": "lib/ecs.generated.ts",
5533 "line": 929
5534 },
5535 "name": "kmsKeyId",
5536 "optional": true,
5537 "type": {
5538 "primitive": "string"
5539 }
5540 },
5541 {
5542 "abstract": true,
5543 "docs": {
5544 "custom": {
5545 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logconfiguration"
5546 },
5547 "remarks": "The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When `logging=OVERRIDE` is specified, a `logConfiguration` must be provided.",
5548 "stability": "external",
5549 "summary": "The log configuration for the results of the execute command actions."
5550 },
5551 "immutable": true,
5552 "locationInModule": {
5553 "filename": "lib/ecs.generated.ts",
5554 "line": 935
5555 },
5556 "name": "logConfiguration",
5557 "optional": true,
5558 "type": {
5559 "union": {
5560 "types": [
5561 {
5562 "fqn": "@aws-cdk/core.IResolvable"
5563 },
5564 {
5565 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandLogConfigurationProperty"
5566 }
5567 ]
5568 }
5569 }
5570 },
5571 {
5572 "abstract": true,
5573 "docs": {
5574 "custom": {
5575 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging"
5576 },
5577 "remarks": "- `NONE` : The execute command session is not logged.\n- `DEFAULT` : The `awslogs` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no `awslogs` log driver is configured in the task definition, the output won't be logged.\n- `OVERRIDE` : Specify the logging details as a part of `logConfiguration` . If the `OVERRIDE` logging option is specified, the `logConfiguration` is required.",
5578 "stability": "external",
5579 "summary": "The log setting to use for redirecting logs for your execute command results. The following log settings are available."
5580 },
5581 "immutable": true,
5582 "locationInModule": {
5583 "filename": "lib/ecs.generated.ts",
5584 "line": 945
5585 },
5586 "name": "logging",
5587 "optional": true,
5588 "type": {
5589 "primitive": "string"
5590 }
5591 }
5592 ],
5593 "symbolId": "lib/ecs.generated:CfnCluster.ExecuteCommandConfigurationProperty"
5594 },
5595 "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandLogConfigurationProperty": {
5596 "assembly": "@aws-cdk/aws-ecs",
5597 "datatype": true,
5598 "docs": {
5599 "custom": {
5600 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html",
5601 "exampleMetadata": "fixture=_generated"
5602 },
5603 "remarks": "The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.",
5604 "stability": "external",
5605 "summary": "The log configuration for the results of the execute command actions.",
5606 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst executeCommandLogConfigurationProperty: ecs.CfnCluster.ExecuteCommandLogConfigurationProperty = {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n s3BucketName: 's3BucketName',\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n};"
5607 },
5608 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ExecuteCommandLogConfigurationProperty",
5609 "kind": "interface",
5610 "locationInModule": {
5611 "filename": "lib/ecs.generated.ts",
5612 "line": 1012
5613 },
5614 "name": "ExecuteCommandLogConfigurationProperty",
5615 "namespace": "CfnCluster",
5616 "properties": [
5617 {
5618 "abstract": true,
5619 "docs": {
5620 "custom": {
5621 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchencryptionenabled"
5622 },
5623 "remarks": "If not specified, encryption will be disabled.",
5624 "stability": "external",
5625 "summary": "Determines whether to use encryption on the CloudWatch logs."
5626 },
5627 "immutable": true,
5628 "locationInModule": {
5629 "filename": "lib/ecs.generated.ts",
5630 "line": 1018
5631 },
5632 "name": "cloudWatchEncryptionEnabled",
5633 "optional": true,
5634 "type": {
5635 "union": {
5636 "types": [
5637 {
5638 "primitive": "boolean"
5639 },
5640 {
5641 "fqn": "@aws-cdk/core.IResolvable"
5642 }
5643 ]
5644 }
5645 }
5646 },
5647 {
5648 "abstract": true,
5649 "docs": {
5650 "custom": {
5651 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchloggroupname"
5652 },
5653 "remarks": "> The CloudWatch log group must already be created.",
5654 "stability": "external",
5655 "summary": "The name of the CloudWatch log group to send logs to."
5656 },
5657 "immutable": true,
5658 "locationInModule": {
5659 "filename": "lib/ecs.generated.ts",
5660 "line": 1026
5661 },
5662 "name": "cloudWatchLogGroupName",
5663 "optional": true,
5664 "type": {
5665 "primitive": "string"
5666 }
5667 },
5668 {
5669 "abstract": true,
5670 "docs": {
5671 "custom": {
5672 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3bucketname"
5673 },
5674 "remarks": "> The S3 bucket must already be created.",
5675 "stability": "external",
5676 "summary": "The name of the S3 bucket to send logs to."
5677 },
5678 "immutable": true,
5679 "locationInModule": {
5680 "filename": "lib/ecs.generated.ts",
5681 "line": 1034
5682 },
5683 "name": "s3BucketName",
5684 "optional": true,
5685 "type": {
5686 "primitive": "string"
5687 }
5688 },
5689 {
5690 "abstract": true,
5691 "docs": {
5692 "custom": {
5693 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3encryptionenabled"
5694 },
5695 "remarks": "If not specified, encryption is not used.",
5696 "stability": "external",
5697 "summary": "Determines whether to use encryption on the S3 logs."
5698 },
5699 "immutable": true,
5700 "locationInModule": {
5701 "filename": "lib/ecs.generated.ts",
5702 "line": 1040
5703 },
5704 "name": "s3EncryptionEnabled",
5705 "optional": true,
5706 "type": {
5707 "union": {
5708 "types": [
5709 {
5710 "primitive": "boolean"
5711 },
5712 {
5713 "fqn": "@aws-cdk/core.IResolvable"
5714 }
5715 ]
5716 }
5717 }
5718 },
5719 {
5720 "abstract": true,
5721 "docs": {
5722 "custom": {
5723 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3keyprefix"
5724 },
5725 "stability": "external",
5726 "summary": "An optional folder in the S3 bucket to place logs in."
5727 },
5728 "immutable": true,
5729 "locationInModule": {
5730 "filename": "lib/ecs.generated.ts",
5731 "line": 1046
5732 },
5733 "name": "s3KeyPrefix",
5734 "optional": true,
5735 "type": {
5736 "primitive": "string"
5737 }
5738 }
5739 ],
5740 "symbolId": "lib/ecs.generated:CfnCluster.ExecuteCommandLogConfigurationProperty"
5741 },
5742 "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations": {
5743 "assembly": "@aws-cdk/aws-ecs",
5744 "base": "@aws-cdk/core.CfnResource",
5745 "docs": {
5746 "custom": {
5747 "cloudformationResource": "AWS::ECS::ClusterCapacityProviderAssociations",
5748 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html",
5749 "exampleMetadata": "fixture=_generated"
5750 },
5751 "remarks": "The `AWS::ECS::ClusterCapacityProviderAssociations` resource associates one or more capacity providers and a default capacity provider strategy with a cluster.",
5752 "stability": "external",
5753 "summary": "A CloudFormation `AWS::ECS::ClusterCapacityProviderAssociations`.",
5754 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnClusterCapacityProviderAssociations = new ecs.CfnClusterCapacityProviderAssociations(this, 'MyCfnClusterCapacityProviderAssociations', {\n capacityProviders: ['capacityProviders'],\n cluster: 'cluster',\n defaultCapacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n});"
5755 },
5756 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations",
5757 "initializer": {
5758 "docs": {
5759 "stability": "external",
5760 "summary": "Create a new `AWS::ECS::ClusterCapacityProviderAssociations`."
5761 },
5762 "locationInModule": {
5763 "filename": "lib/ecs.generated.ts",
5764 "line": 1259
5765 },
5766 "parameters": [
5767 {
5768 "docs": {
5769 "summary": "- scope in which this resource is defined."
5770 },
5771 "name": "scope",
5772 "type": {
5773 "fqn": "@aws-cdk/core.Construct"
5774 }
5775 },
5776 {
5777 "docs": {
5778 "summary": "- scoped id of the resource."
5779 },
5780 "name": "id",
5781 "type": {
5782 "primitive": "string"
5783 }
5784 },
5785 {
5786 "docs": {
5787 "summary": "- resource properties."
5788 },
5789 "name": "props",
5790 "type": {
5791 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociationsProps"
5792 }
5793 }
5794 ]
5795 },
5796 "interfaces": [
5797 "@aws-cdk/core.IInspectable"
5798 ],
5799 "kind": "class",
5800 "locationInModule": {
5801 "filename": "lib/ecs.generated.ts",
5802 "line": 1206
5803 },
5804 "methods": [
5805 {
5806 "docs": {
5807 "stability": "external",
5808 "summary": "Examines the CloudFormation resource and discloses attributes."
5809 },
5810 "locationInModule": {
5811 "filename": "lib/ecs.generated.ts",
5812 "line": 1276
5813 },
5814 "name": "inspect",
5815 "overrides": "@aws-cdk/core.IInspectable",
5816 "parameters": [
5817 {
5818 "docs": {
5819 "summary": "- tree inspector to collect and process attributes."
5820 },
5821 "name": "inspector",
5822 "type": {
5823 "fqn": "@aws-cdk/core.TreeInspector"
5824 }
5825 }
5826 ]
5827 },
5828 {
5829 "docs": {
5830 "stability": "external"
5831 },
5832 "locationInModule": {
5833 "filename": "lib/ecs.generated.ts",
5834 "line": 1289
5835 },
5836 "name": "renderProperties",
5837 "overrides": "@aws-cdk/core.CfnResource",
5838 "parameters": [
5839 {
5840 "name": "props",
5841 "type": {
5842 "collection": {
5843 "elementtype": {
5844 "primitive": "any"
5845 },
5846 "kind": "map"
5847 }
5848 }
5849 }
5850 ],
5851 "protected": true,
5852 "returns": {
5853 "type": {
5854 "collection": {
5855 "elementtype": {
5856 "primitive": "any"
5857 },
5858 "kind": "map"
5859 }
5860 }
5861 }
5862 }
5863 ],
5864 "name": "CfnClusterCapacityProviderAssociations",
5865 "properties": [
5866 {
5867 "const": true,
5868 "docs": {
5869 "stability": "external",
5870 "summary": "The CloudFormation resource type name for this resource class."
5871 },
5872 "immutable": true,
5873 "locationInModule": {
5874 "filename": "lib/ecs.generated.ts",
5875 "line": 1210
5876 },
5877 "name": "CFN_RESOURCE_TYPE_NAME",
5878 "static": true,
5879 "type": {
5880 "primitive": "string"
5881 }
5882 },
5883 {
5884 "docs": {
5885 "stability": "external"
5886 },
5887 "immutable": true,
5888 "locationInModule": {
5889 "filename": "lib/ecs.generated.ts",
5890 "line": 1281
5891 },
5892 "name": "cfnProperties",
5893 "overrides": "@aws-cdk/core.CfnResource",
5894 "protected": true,
5895 "type": {
5896 "collection": {
5897 "elementtype": {
5898 "primitive": "any"
5899 },
5900 "kind": "map"
5901 }
5902 }
5903 },
5904 {
5905 "docs": {
5906 "custom": {
5907 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-capacityproviders"
5908 },
5909 "stability": "external",
5910 "summary": "The capacity providers to associate with the cluster."
5911 },
5912 "locationInModule": {
5913 "filename": "lib/ecs.generated.ts",
5914 "line": 1236
5915 },
5916 "name": "capacityProviders",
5917 "type": {
5918 "collection": {
5919 "elementtype": {
5920 "primitive": "string"
5921 },
5922 "kind": "array"
5923 }
5924 }
5925 },
5926 {
5927 "docs": {
5928 "custom": {
5929 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-cluster"
5930 },
5931 "stability": "external",
5932 "summary": "The cluster the capacity provider association is the target of."
5933 },
5934 "locationInModule": {
5935 "filename": "lib/ecs.generated.ts",
5936 "line": 1243
5937 },
5938 "name": "cluster",
5939 "type": {
5940 "primitive": "string"
5941 }
5942 },
5943 {
5944 "docs": {
5945 "custom": {
5946 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-defaultcapacityproviderstrategy"
5947 },
5948 "stability": "external",
5949 "summary": "The default capacity provider strategy to associate with the cluster."
5950 },
5951 "locationInModule": {
5952 "filename": "lib/ecs.generated.ts",
5953 "line": 1250
5954 },
5955 "name": "defaultCapacityProviderStrategy",
5956 "type": {
5957 "union": {
5958 "types": [
5959 {
5960 "fqn": "@aws-cdk/core.IResolvable"
5961 },
5962 {
5963 "collection": {
5964 "elementtype": {
5965 "union": {
5966 "types": [
5967 {
5968 "fqn": "@aws-cdk/core.IResolvable"
5969 },
5970 {
5971 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty"
5972 }
5973 ]
5974 }
5975 },
5976 "kind": "array"
5977 }
5978 }
5979 ]
5980 }
5981 }
5982 }
5983 ],
5984 "symbolId": "lib/ecs.generated:CfnClusterCapacityProviderAssociations"
5985 },
5986 "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty": {
5987 "assembly": "@aws-cdk/aws-ecs",
5988 "datatype": true,
5989 "docs": {
5990 "custom": {
5991 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html",
5992 "exampleMetadata": "fixture=_generated"
5993 },
5994 "remarks": "When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.",
5995 "stability": "external",
5996 "summary": "The `CapacityProviderStrategy` property specifies the details of the default capacity provider strategy for the cluster.",
5997 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst capacityProviderStrategyProperty: ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty = {\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n};"
5998 },
5999 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty",
6000 "kind": "interface",
6001 "locationInModule": {
6002 "filename": "lib/ecs.generated.ts",
6003 "line": 1303
6004 },
6005 "name": "CapacityProviderStrategyProperty",
6006 "namespace": "CfnClusterCapacityProviderAssociations",
6007 "properties": [
6008 {
6009 "abstract": true,
6010 "docs": {
6011 "custom": {
6012 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider"
6013 },
6014 "stability": "external",
6015 "summary": "The short name of the capacity provider."
6016 },
6017 "immutable": true,
6018 "locationInModule": {
6019 "filename": "lib/ecs.generated.ts",
6020 "line": 1315
6021 },
6022 "name": "capacityProvider",
6023 "type": {
6024 "primitive": "string"
6025 }
6026 },
6027 {
6028 "abstract": true,
6029 "docs": {
6030 "custom": {
6031 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base"
6032 },
6033 "remarks": "Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used.",
6034 "stability": "external",
6035 "summary": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider."
6036 },
6037 "immutable": true,
6038 "locationInModule": {
6039 "filename": "lib/ecs.generated.ts",
6040 "line": 1309
6041 },
6042 "name": "base",
6043 "optional": true,
6044 "type": {
6045 "primitive": "number"
6046 }
6047 },
6048 {
6049 "abstract": true,
6050 "docs": {
6051 "custom": {
6052 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-weight"
6053 },
6054 "remarks": "The `weight` value is taken into consideration after the `base` value, if defined, is satisfied.\n\nIf no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` will not be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail.\n\nAn example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of `1` , then when the `base` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of `1` for *capacityProviderA* and a weight of `4` for *capacityProviderB* , then for every one task that is run using *capacityProviderA* , four tasks would use *capacityProviderB* .",
6055 "stability": "external",
6056 "summary": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider."
6057 },
6058 "immutable": true,
6059 "locationInModule": {
6060 "filename": "lib/ecs.generated.ts",
6061 "line": 1325
6062 },
6063 "name": "weight",
6064 "optional": true,
6065 "type": {
6066 "primitive": "number"
6067 }
6068 }
6069 ],
6070 "symbolId": "lib/ecs.generated:CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty"
6071 },
6072 "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociationsProps": {
6073 "assembly": "@aws-cdk/aws-ecs",
6074 "datatype": true,
6075 "docs": {
6076 "custom": {
6077 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html",
6078 "exampleMetadata": "fixture=_generated"
6079 },
6080 "stability": "external",
6081 "summary": "Properties for defining a `CfnClusterCapacityProviderAssociations`.",
6082 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnClusterCapacityProviderAssociationsProps: ecs.CfnClusterCapacityProviderAssociationsProps = {\n capacityProviders: ['capacityProviders'],\n cluster: 'cluster',\n defaultCapacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n};"
6083 },
6084 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociationsProps",
6085 "kind": "interface",
6086 "locationInModule": {
6087 "filename": "lib/ecs.generated.ts",
6088 "line": 1118
6089 },
6090 "name": "CfnClusterCapacityProviderAssociationsProps",
6091 "properties": [
6092 {
6093 "abstract": true,
6094 "docs": {
6095 "custom": {
6096 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-capacityproviders"
6097 },
6098 "stability": "external",
6099 "summary": "The capacity providers to associate with the cluster."
6100 },
6101 "immutable": true,
6102 "locationInModule": {
6103 "filename": "lib/ecs.generated.ts",
6104 "line": 1125
6105 },
6106 "name": "capacityProviders",
6107 "type": {
6108 "collection": {
6109 "elementtype": {
6110 "primitive": "string"
6111 },
6112 "kind": "array"
6113 }
6114 }
6115 },
6116 {
6117 "abstract": true,
6118 "docs": {
6119 "custom": {
6120 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-cluster"
6121 },
6122 "stability": "external",
6123 "summary": "The cluster the capacity provider association is the target of."
6124 },
6125 "immutable": true,
6126 "locationInModule": {
6127 "filename": "lib/ecs.generated.ts",
6128 "line": 1132
6129 },
6130 "name": "cluster",
6131 "type": {
6132 "primitive": "string"
6133 }
6134 },
6135 {
6136 "abstract": true,
6137 "docs": {
6138 "custom": {
6139 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-defaultcapacityproviderstrategy"
6140 },
6141 "stability": "external",
6142 "summary": "The default capacity provider strategy to associate with the cluster."
6143 },
6144 "immutable": true,
6145 "locationInModule": {
6146 "filename": "lib/ecs.generated.ts",
6147 "line": 1139
6148 },
6149 "name": "defaultCapacityProviderStrategy",
6150 "type": {
6151 "union": {
6152 "types": [
6153 {
6154 "fqn": "@aws-cdk/core.IResolvable"
6155 },
6156 {
6157 "collection": {
6158 "elementtype": {
6159 "union": {
6160 "types": [
6161 {
6162 "fqn": "@aws-cdk/core.IResolvable"
6163 },
6164 {
6165 "fqn": "@aws-cdk/aws-ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty"
6166 }
6167 ]
6168 }
6169 },
6170 "kind": "array"
6171 }
6172 }
6173 ]
6174 }
6175 }
6176 }
6177 ],
6178 "symbolId": "lib/ecs.generated:CfnClusterCapacityProviderAssociationsProps"
6179 },
6180 "@aws-cdk/aws-ecs.CfnClusterProps": {
6181 "assembly": "@aws-cdk/aws-ecs",
6182 "datatype": true,
6183 "docs": {
6184 "custom": {
6185 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html",
6186 "exampleMetadata": "fixture=_generated"
6187 },
6188 "stability": "external",
6189 "summary": "Properties for defining a `CfnCluster`.",
6190 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnClusterProps: ecs.CfnClusterProps = {\n capacityProviders: ['capacityProviders'],\n clusterName: 'clusterName',\n clusterSettings: [{\n name: 'name',\n value: 'value',\n }],\n configuration: {\n executeCommandConfiguration: {\n kmsKeyId: 'kmsKeyId',\n logConfiguration: {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n s3BucketName: 's3BucketName',\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n },\n logging: 'logging',\n },\n },\n defaultCapacityProviderStrategy: [{\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
6191 },
6192 "fqn": "@aws-cdk/aws-ecs.CfnClusterProps",
6193 "kind": "interface",
6194 "locationInModule": {
6195 "filename": "lib/ecs.generated.ts",
6196 "line": 420
6197 },
6198 "name": "CfnClusterProps",
6199 "properties": [
6200 {
6201 "abstract": true,
6202 "docs": {
6203 "custom": {
6204 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-capacityproviders"
6205 },
6206 "remarks": "A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy.\n\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster.\n\nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.",
6207 "stability": "external",
6208 "summary": "The short name of one or more capacity providers to associate with the cluster."
6209 },
6210 "immutable": true,
6211 "locationInModule": {
6212 "filename": "lib/ecs.generated.ts",
6213 "line": 431
6214 },
6215 "name": "capacityProviders",
6216 "optional": true,
6217 "type": {
6218 "collection": {
6219 "elementtype": {
6220 "primitive": "string"
6221 },
6222 "kind": "array"
6223 }
6224 }
6225 },
6226 {
6227 "abstract": true,
6228 "docs": {
6229 "custom": {
6230 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername"
6231 },
6232 "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.",
6233 "stability": "external",
6234 "summary": "A user-generated string that you use to identify your cluster."
6235 },
6236 "immutable": true,
6237 "locationInModule": {
6238 "filename": "lib/ecs.generated.ts",
6239 "line": 438
6240 },
6241 "name": "clusterName",
6242 "optional": true,
6243 "type": {
6244 "primitive": "string"
6245 }
6246 },
6247 {
6248 "abstract": true,
6249 "docs": {
6250 "custom": {
6251 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings"
6252 },
6253 "remarks": "This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html) .",
6254 "stability": "external",
6255 "summary": "The setting to use when creating a cluster."
6256 },
6257 "immutable": true,
6258 "locationInModule": {
6259 "filename": "lib/ecs.generated.ts",
6260 "line": 445
6261 },
6262 "name": "clusterSettings",
6263 "optional": true,
6264 "type": {
6265 "union": {
6266 "types": [
6267 {
6268 "fqn": "@aws-cdk/core.IResolvable"
6269 },
6270 {
6271 "collection": {
6272 "elementtype": {
6273 "union": {
6274 "types": [
6275 {
6276 "fqn": "@aws-cdk/core.IResolvable"
6277 },
6278 {
6279 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterSettingsProperty"
6280 }
6281 ]
6282 }
6283 },
6284 "kind": "array"
6285 }
6286 }
6287 ]
6288 }
6289 }
6290 },
6291 {
6292 "abstract": true,
6293 "docs": {
6294 "custom": {
6295 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-configuration"
6296 },
6297 "stability": "external",
6298 "summary": "The execute command configuration for the cluster."
6299 },
6300 "immutable": true,
6301 "locationInModule": {
6302 "filename": "lib/ecs.generated.ts",
6303 "line": 452
6304 },
6305 "name": "configuration",
6306 "optional": true,
6307 "type": {
6308 "union": {
6309 "types": [
6310 {
6311 "fqn": "@aws-cdk/core.IResolvable"
6312 },
6313 {
6314 "fqn": "@aws-cdk/aws-ecs.CfnCluster.ClusterConfigurationProperty"
6315 }
6316 ]
6317 }
6318 }
6319 },
6320 {
6321 "abstract": true,
6322 "docs": {
6323 "custom": {
6324 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-defaultcapacityproviderstrategy"
6325 },
6326 "remarks": "When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.",
6327 "stability": "external",
6328 "summary": "The default capacity provider strategy for the cluster."
6329 },
6330 "immutable": true,
6331 "locationInModule": {
6332 "filename": "lib/ecs.generated.ts",
6333 "line": 459
6334 },
6335 "name": "defaultCapacityProviderStrategy",
6336 "optional": true,
6337 "type": {
6338 "union": {
6339 "types": [
6340 {
6341 "fqn": "@aws-cdk/core.IResolvable"
6342 },
6343 {
6344 "collection": {
6345 "elementtype": {
6346 "union": {
6347 "types": [
6348 {
6349 "fqn": "@aws-cdk/core.IResolvable"
6350 },
6351 {
6352 "fqn": "@aws-cdk/aws-ecs.CfnCluster.CapacityProviderStrategyItemProperty"
6353 }
6354 ]
6355 }
6356 },
6357 "kind": "array"
6358 }
6359 }
6360 ]
6361 }
6362 }
6363 },
6364 {
6365 "abstract": true,
6366 "docs": {
6367 "custom": {
6368 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-tags"
6369 },
6370 "remarks": "Each tag consists of a key and an optional value. You define both.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
6371 "stability": "external",
6372 "summary": "The metadata that you apply to the cluster to help you categorize and organize them."
6373 },
6374 "immutable": true,
6375 "locationInModule": {
6376 "filename": "lib/ecs.generated.ts",
6377 "line": 476
6378 },
6379 "name": "tags",
6380 "optional": true,
6381 "type": {
6382 "collection": {
6383 "elementtype": {
6384 "fqn": "@aws-cdk/core.CfnTag"
6385 },
6386 "kind": "array"
6387 }
6388 }
6389 }
6390 ],
6391 "symbolId": "lib/ecs.generated:CfnClusterProps"
6392 },
6393 "@aws-cdk/aws-ecs.CfnPrimaryTaskSet": {
6394 "assembly": "@aws-cdk/aws-ecs",
6395 "base": "@aws-cdk/core.CfnResource",
6396 "docs": {
6397 "custom": {
6398 "cloudformationResource": "AWS::ECS::PrimaryTaskSet",
6399 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html",
6400 "exampleMetadata": "fixture=_generated"
6401 },
6402 "remarks": "Specifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide* .",
6403 "stability": "external",
6404 "summary": "A CloudFormation `AWS::ECS::PrimaryTaskSet`.",
6405 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnPrimaryTaskSet = new ecs.CfnPrimaryTaskSet(this, 'MyCfnPrimaryTaskSet', {\n cluster: 'cluster',\n service: 'service',\n taskSetId: 'taskSetId',\n});"
6406 },
6407 "fqn": "@aws-cdk/aws-ecs.CfnPrimaryTaskSet",
6408 "initializer": {
6409 "docs": {
6410 "stability": "external",
6411 "summary": "Create a new `AWS::ECS::PrimaryTaskSet`."
6412 },
6413 "locationInModule": {
6414 "filename": "lib/ecs.generated.ts",
6415 "line": 1533
6416 },
6417 "parameters": [
6418 {
6419 "docs": {
6420 "summary": "- scope in which this resource is defined."
6421 },
6422 "name": "scope",
6423 "type": {
6424 "fqn": "@aws-cdk/core.Construct"
6425 }
6426 },
6427 {
6428 "docs": {
6429 "summary": "- scoped id of the resource."
6430 },
6431 "name": "id",
6432 "type": {
6433 "primitive": "string"
6434 }
6435 },
6436 {
6437 "docs": {
6438 "summary": "- resource properties."
6439 },
6440 "name": "props",
6441 "type": {
6442 "fqn": "@aws-cdk/aws-ecs.CfnPrimaryTaskSetProps"
6443 }
6444 }
6445 ]
6446 },
6447 "interfaces": [
6448 "@aws-cdk/core.IInspectable"
6449 ],
6450 "kind": "class",
6451 "locationInModule": {
6452 "filename": "lib/ecs.generated.ts",
6453 "line": 1480
6454 },
6455 "methods": [
6456 {
6457 "docs": {
6458 "stability": "external",
6459 "summary": "Examines the CloudFormation resource and discloses attributes."
6460 },
6461 "locationInModule": {
6462 "filename": "lib/ecs.generated.ts",
6463 "line": 1550
6464 },
6465 "name": "inspect",
6466 "overrides": "@aws-cdk/core.IInspectable",
6467 "parameters": [
6468 {
6469 "docs": {
6470 "summary": "- tree inspector to collect and process attributes."
6471 },
6472 "name": "inspector",
6473 "type": {
6474 "fqn": "@aws-cdk/core.TreeInspector"
6475 }
6476 }
6477 ]
6478 },
6479 {
6480 "docs": {
6481 "stability": "external"
6482 },
6483 "locationInModule": {
6484 "filename": "lib/ecs.generated.ts",
6485 "line": 1563
6486 },
6487 "name": "renderProperties",
6488 "overrides": "@aws-cdk/core.CfnResource",
6489 "parameters": [
6490 {
6491 "name": "props",
6492 "type": {
6493 "collection": {
6494 "elementtype": {
6495 "primitive": "any"
6496 },
6497 "kind": "map"
6498 }
6499 }
6500 }
6501 ],
6502 "protected": true,
6503 "returns": {
6504 "type": {
6505 "collection": {
6506 "elementtype": {
6507 "primitive": "any"
6508 },
6509 "kind": "map"
6510 }
6511 }
6512 }
6513 }
6514 ],
6515 "name": "CfnPrimaryTaskSet",
6516 "properties": [
6517 {
6518 "const": true,
6519 "docs": {
6520 "stability": "external",
6521 "summary": "The CloudFormation resource type name for this resource class."
6522 },
6523 "immutable": true,
6524 "locationInModule": {
6525 "filename": "lib/ecs.generated.ts",
6526 "line": 1484
6527 },
6528 "name": "CFN_RESOURCE_TYPE_NAME",
6529 "static": true,
6530 "type": {
6531 "primitive": "string"
6532 }
6533 },
6534 {
6535 "docs": {
6536 "stability": "external"
6537 },
6538 "immutable": true,
6539 "locationInModule": {
6540 "filename": "lib/ecs.generated.ts",
6541 "line": 1555
6542 },
6543 "name": "cfnProperties",
6544 "overrides": "@aws-cdk/core.CfnResource",
6545 "protected": true,
6546 "type": {
6547 "collection": {
6548 "elementtype": {
6549 "primitive": "any"
6550 },
6551 "kind": "map"
6552 }
6553 }
6554 },
6555 {
6556 "docs": {
6557 "custom": {
6558 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-cluster"
6559 },
6560 "stability": "external",
6561 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in."
6562 },
6563 "locationInModule": {
6564 "filename": "lib/ecs.generated.ts",
6565 "line": 1510
6566 },
6567 "name": "cluster",
6568 "type": {
6569 "primitive": "string"
6570 }
6571 },
6572 {
6573 "docs": {
6574 "custom": {
6575 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-service"
6576 },
6577 "stability": "external",
6578 "summary": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in."
6579 },
6580 "locationInModule": {
6581 "filename": "lib/ecs.generated.ts",
6582 "line": 1517
6583 },
6584 "name": "service",
6585 "type": {
6586 "primitive": "string"
6587 }
6588 },
6589 {
6590 "docs": {
6591 "custom": {
6592 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-tasksetid"
6593 },
6594 "stability": "external",
6595 "summary": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment."
6596 },
6597 "locationInModule": {
6598 "filename": "lib/ecs.generated.ts",
6599 "line": 1524
6600 },
6601 "name": "taskSetId",
6602 "type": {
6603 "primitive": "string"
6604 }
6605 }
6606 ],
6607 "symbolId": "lib/ecs.generated:CfnPrimaryTaskSet"
6608 },
6609 "@aws-cdk/aws-ecs.CfnPrimaryTaskSetProps": {
6610 "assembly": "@aws-cdk/aws-ecs",
6611 "datatype": true,
6612 "docs": {
6613 "custom": {
6614 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html",
6615 "exampleMetadata": "fixture=_generated"
6616 },
6617 "stability": "external",
6618 "summary": "Properties for defining a `CfnPrimaryTaskSet`.",
6619 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnPrimaryTaskSetProps: ecs.CfnPrimaryTaskSetProps = {\n cluster: 'cluster',\n service: 'service',\n taskSetId: 'taskSetId',\n};"
6620 },
6621 "fqn": "@aws-cdk/aws-ecs.CfnPrimaryTaskSetProps",
6622 "kind": "interface",
6623 "locationInModule": {
6624 "filename": "lib/ecs.generated.ts",
6625 "line": 1392
6626 },
6627 "name": "CfnPrimaryTaskSetProps",
6628 "properties": [
6629 {
6630 "abstract": true,
6631 "docs": {
6632 "custom": {
6633 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-cluster"
6634 },
6635 "stability": "external",
6636 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in."
6637 },
6638 "immutable": true,
6639 "locationInModule": {
6640 "filename": "lib/ecs.generated.ts",
6641 "line": 1399
6642 },
6643 "name": "cluster",
6644 "type": {
6645 "primitive": "string"
6646 }
6647 },
6648 {
6649 "abstract": true,
6650 "docs": {
6651 "custom": {
6652 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-service"
6653 },
6654 "stability": "external",
6655 "summary": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in."
6656 },
6657 "immutable": true,
6658 "locationInModule": {
6659 "filename": "lib/ecs.generated.ts",
6660 "line": 1406
6661 },
6662 "name": "service",
6663 "type": {
6664 "primitive": "string"
6665 }
6666 },
6667 {
6668 "abstract": true,
6669 "docs": {
6670 "custom": {
6671 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-tasksetid"
6672 },
6673 "stability": "external",
6674 "summary": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment."
6675 },
6676 "immutable": true,
6677 "locationInModule": {
6678 "filename": "lib/ecs.generated.ts",
6679 "line": 1413
6680 },
6681 "name": "taskSetId",
6682 "type": {
6683 "primitive": "string"
6684 }
6685 }
6686 ],
6687 "symbolId": "lib/ecs.generated:CfnPrimaryTaskSetProps"
6688 },
6689 "@aws-cdk/aws-ecs.CfnService": {
6690 "assembly": "@aws-cdk/aws-ecs",
6691 "base": "@aws-cdk/core.CfnResource",
6692 "docs": {
6693 "custom": {
6694 "cloudformationResource": "AWS::ECS::Service",
6695 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html",
6696 "exampleMetadata": "fixture=_generated"
6697 },
6698 "remarks": "The `AWS::ECS::Service` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.",
6699 "stability": "external",
6700 "summary": "A CloudFormation `AWS::ECS::Service`.",
6701 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnService = new ecs.CfnService(this, 'MyCfnService', /* all optional props */ {\n capacityProviderStrategy: [{\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n }],\n cluster: 'cluster',\n deploymentConfiguration: {\n deploymentCircuitBreaker: {\n enable: false,\n rollback: false,\n },\n maximumPercent: 123,\n minimumHealthyPercent: 123,\n },\n deploymentController: {\n type: 'type',\n },\n desiredCount: 123,\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n healthCheckGracePeriodSeconds: 123,\n launchType: 'launchType',\n loadBalancers: [{\n containerPort: 123,\n\n // the properties below are optional\n containerName: 'containerName',\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n }],\n networkConfiguration: {\n awsvpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n }],\n placementStrategies: [{\n type: 'type',\n\n // the properties below are optional\n field: 'field',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n role: 'role',\n schedulingStrategy: 'schedulingStrategy',\n serviceName: 'serviceName',\n serviceRegistries: [{\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n taskDefinition: 'taskDefinition',\n});"
6702 },
6703 "fqn": "@aws-cdk/aws-ecs.CfnService",
6704 "initializer": {
6705 "docs": {
6706 "stability": "external",
6707 "summary": "Create a new `AWS::ECS::Service`."
6708 },
6709 "locationInModule": {
6710 "filename": "lib/ecs.generated.ts",
6711 "line": 2122
6712 },
6713 "parameters": [
6714 {
6715 "docs": {
6716 "summary": "- scope in which this resource is defined."
6717 },
6718 "name": "scope",
6719 "type": {
6720 "fqn": "@aws-cdk/core.Construct"
6721 }
6722 },
6723 {
6724 "docs": {
6725 "summary": "- scoped id of the resource."
6726 },
6727 "name": "id",
6728 "type": {
6729 "primitive": "string"
6730 }
6731 },
6732 {
6733 "docs": {
6734 "summary": "- resource properties."
6735 },
6736 "name": "props",
6737 "optional": true,
6738 "type": {
6739 "fqn": "@aws-cdk/aws-ecs.CfnServiceProps"
6740 }
6741 }
6742 ]
6743 },
6744 "interfaces": [
6745 "@aws-cdk/core.IInspectable"
6746 ],
6747 "kind": "class",
6748 "locationInModule": {
6749 "filename": "lib/ecs.generated.ts",
6750 "line": 1886
6751 },
6752 "methods": [
6753 {
6754 "docs": {
6755 "stability": "external",
6756 "summary": "Examines the CloudFormation resource and discloses attributes."
6757 },
6758 "locationInModule": {
6759 "filename": "lib/ecs.generated.ts",
6760 "line": 2156
6761 },
6762 "name": "inspect",
6763 "overrides": "@aws-cdk/core.IInspectable",
6764 "parameters": [
6765 {
6766 "docs": {
6767 "summary": "- tree inspector to collect and process attributes."
6768 },
6769 "name": "inspector",
6770 "type": {
6771 "fqn": "@aws-cdk/core.TreeInspector"
6772 }
6773 }
6774 ]
6775 },
6776 {
6777 "docs": {
6778 "stability": "external"
6779 },
6780 "locationInModule": {
6781 "filename": "lib/ecs.generated.ts",
6782 "line": 2187
6783 },
6784 "name": "renderProperties",
6785 "overrides": "@aws-cdk/core.CfnResource",
6786 "parameters": [
6787 {
6788 "name": "props",
6789 "type": {
6790 "collection": {
6791 "elementtype": {
6792 "primitive": "any"
6793 },
6794 "kind": "map"
6795 }
6796 }
6797 }
6798 ],
6799 "protected": true,
6800 "returns": {
6801 "type": {
6802 "collection": {
6803 "elementtype": {
6804 "primitive": "any"
6805 },
6806 "kind": "map"
6807 }
6808 }
6809 }
6810 }
6811 ],
6812 "name": "CfnService",
6813 "properties": [
6814 {
6815 "const": true,
6816 "docs": {
6817 "stability": "external",
6818 "summary": "The CloudFormation resource type name for this resource class."
6819 },
6820 "immutable": true,
6821 "locationInModule": {
6822 "filename": "lib/ecs.generated.ts",
6823 "line": 1890
6824 },
6825 "name": "CFN_RESOURCE_TYPE_NAME",
6826 "static": true,
6827 "type": {
6828 "primitive": "string"
6829 }
6830 },
6831 {
6832 "docs": {
6833 "custom": {
6834 "cloudformationAttribute": "Name"
6835 },
6836 "stability": "external",
6837 "summary": "The name of the Amazon ECS service, such as `sample-webapp` ."
6838 },
6839 "immutable": true,
6840 "locationInModule": {
6841 "filename": "lib/ecs.generated.ts",
6842 "line": 1915
6843 },
6844 "name": "attrName",
6845 "type": {
6846 "primitive": "string"
6847 }
6848 },
6849 {
6850 "docs": {
6851 "custom": {
6852 "cloudformationAttribute": "ServiceArn"
6853 },
6854 "stability": "external",
6855 "summary": "Not currently supported in AWS CloudFormation ."
6856 },
6857 "immutable": true,
6858 "locationInModule": {
6859 "filename": "lib/ecs.generated.ts",
6860 "line": 1921
6861 },
6862 "name": "attrServiceArn",
6863 "type": {
6864 "primitive": "string"
6865 }
6866 },
6867 {
6868 "docs": {
6869 "stability": "external"
6870 },
6871 "immutable": true,
6872 "locationInModule": {
6873 "filename": "lib/ecs.generated.ts",
6874 "line": 2161
6875 },
6876 "name": "cfnProperties",
6877 "overrides": "@aws-cdk/core.CfnResource",
6878 "protected": true,
6879 "type": {
6880 "collection": {
6881 "elementtype": {
6882 "primitive": "any"
6883 },
6884 "kind": "map"
6885 }
6886 }
6887 },
6888 {
6889 "docs": {
6890 "custom": {
6891 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags"
6892 },
6893 "remarks": "Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
6894 "stability": "external",
6895 "summary": "The metadata that you apply to the service to help you categorize and organize them."
6896 },
6897 "immutable": true,
6898 "locationInModule": {
6899 "filename": "lib/ecs.generated.ts",
6900 "line": 2104
6901 },
6902 "name": "tags",
6903 "type": {
6904 "fqn": "@aws-cdk/core.TagManager"
6905 }
6906 },
6907 {
6908 "docs": {
6909 "custom": {
6910 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy"
6911 },
6912 "remarks": "A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.\n\nReview the [Capacity provider considerations](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html#capacity-providers-considerations) in the *Amazon Elastic Container Service Developer Guide.*\n\nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used.\n\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.\n\nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n\nThe PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.",
6913 "stability": "external",
6914 "summary": "The capacity provider strategy to use for the service."
6915 },
6916 "locationInModule": {
6917 "filename": "lib/ecs.generated.ts",
6918 "line": 1940
6919 },
6920 "name": "capacityProviderStrategy",
6921 "optional": true,
6922 "type": {
6923 "union": {
6924 "types": [
6925 {
6926 "fqn": "@aws-cdk/core.IResolvable"
6927 },
6928 {
6929 "collection": {
6930 "elementtype": {
6931 "union": {
6932 "types": [
6933 {
6934 "fqn": "@aws-cdk/core.IResolvable"
6935 },
6936 {
6937 "fqn": "@aws-cdk/aws-ecs.CfnService.CapacityProviderStrategyItemProperty"
6938 }
6939 ]
6940 }
6941 },
6942 "kind": "array"
6943 }
6944 }
6945 ]
6946 }
6947 }
6948 },
6949 {
6950 "docs": {
6951 "custom": {
6952 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster"
6953 },
6954 "remarks": "If you do not specify a cluster, the default cluster is assumed.",
6955 "stability": "external",
6956 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on."
6957 },
6958 "locationInModule": {
6959 "filename": "lib/ecs.generated.ts",
6960 "line": 1947
6961 },
6962 "name": "cluster",
6963 "optional": true,
6964 "type": {
6965 "primitive": "string"
6966 }
6967 },
6968 {
6969 "docs": {
6970 "custom": {
6971 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration"
6972 },
6973 "stability": "external",
6974 "summary": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks."
6975 },
6976 "locationInModule": {
6977 "filename": "lib/ecs.generated.ts",
6978 "line": 1954
6979 },
6980 "name": "deploymentConfiguration",
6981 "optional": true,
6982 "type": {
6983 "union": {
6984 "types": [
6985 {
6986 "fqn": "@aws-cdk/core.IResolvable"
6987 },
6988 {
6989 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentConfigurationProperty"
6990 }
6991 ]
6992 }
6993 }
6994 },
6995 {
6996 "docs": {
6997 "custom": {
6998 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller"
6999 },
7000 "remarks": "If no deployment controller is specified, the default value of `ECS` is used.",
7001 "stability": "external",
7002 "summary": "The deployment controller to use for the service."
7003 },
7004 "locationInModule": {
7005 "filename": "lib/ecs.generated.ts",
7006 "line": 1961
7007 },
7008 "name": "deploymentController",
7009 "optional": true,
7010 "type": {
7011 "union": {
7012 "types": [
7013 {
7014 "fqn": "@aws-cdk/core.IResolvable"
7015 },
7016 {
7017 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentControllerProperty"
7018 }
7019 ]
7020 }
7021 }
7022 },
7023 {
7024 "docs": {
7025 "custom": {
7026 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount"
7027 },
7028 "remarks": "For new services, if a desired count is not specified, a default value of `1` is used. When using the `DAEMON` scheduling strategy, the desired count is not required.\n\nFor existing services, if a desired count is not specified, it is omitted from the operation.",
7029 "stability": "external",
7030 "summary": "The number of instantiations of the specified task definition to place and keep running on your cluster."
7031 },
7032 "locationInModule": {
7033 "filename": "lib/ecs.generated.ts",
7034 "line": 1972
7035 },
7036 "name": "desiredCount",
7037 "optional": true,
7038 "type": {
7039 "primitive": "number"
7040 }
7041 },
7042 {
7043 "docs": {
7044 "custom": {
7045 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags"
7046 },
7047 "remarks": "For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide* .",
7048 "stability": "external",
7049 "summary": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service."
7050 },
7051 "locationInModule": {
7052 "filename": "lib/ecs.generated.ts",
7053 "line": 1979
7054 },
7055 "name": "enableEcsManagedTags",
7056 "optional": true,
7057 "type": {
7058 "union": {
7059 "types": [
7060 {
7061 "primitive": "boolean"
7062 },
7063 {
7064 "fqn": "@aws-cdk/core.IResolvable"
7065 }
7066 ]
7067 }
7068 }
7069 },
7070 {
7071 "docs": {
7072 "custom": {
7073 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableexecutecommand"
7074 },
7075 "remarks": "If `true` , the execute command functionality is enabled for all containers in tasks as part of the service.",
7076 "stability": "external",
7077 "summary": "Determines whether the execute command functionality is enabled for the service."
7078 },
7079 "locationInModule": {
7080 "filename": "lib/ecs.generated.ts",
7081 "line": 1986
7082 },
7083 "name": "enableExecuteCommand",
7084 "optional": true,
7085 "type": {
7086 "union": {
7087 "types": [
7088 {
7089 "primitive": "boolean"
7090 },
7091 {
7092 "fqn": "@aws-cdk/core.IResolvable"
7093 }
7094 ]
7095 }
7096 }
7097 },
7098 {
7099 "docs": {
7100 "custom": {
7101 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds"
7102 },
7103 "remarks": "This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used.\n\nIf you do not use an Elastic Load Balancing, we recomend that you use the `startPeriod` in the task definition healtch check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html) .\n\nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.",
7104 "stability": "external",
7105 "summary": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started."
7106 },
7107 "locationInModule": {
7108 "filename": "lib/ecs.generated.ts",
7109 "line": 1997
7110 },
7111 "name": "healthCheckGracePeriodSeconds",
7112 "optional": true,
7113 "type": {
7114 "primitive": "number"
7115 }
7116 },
7117 {
7118 "docs": {
7119 "custom": {
7120 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype"
7121 },
7122 "remarks": "For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* .",
7123 "stability": "external",
7124 "summary": "The launch type on which to run your service."
7125 },
7126 "locationInModule": {
7127 "filename": "lib/ecs.generated.ts",
7128 "line": 2004
7129 },
7130 "name": "launchType",
7131 "optional": true,
7132 "type": {
7133 "primitive": "string"
7134 }
7135 },
7136 {
7137 "docs": {
7138 "custom": {
7139 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers"
7140 },
7141 "remarks": "If you specify the `Role` property, `LoadBalancers` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide* .",
7142 "stability": "external",
7143 "summary": "A list of load balancer objects to associate with the service."
7144 },
7145 "locationInModule": {
7146 "filename": "lib/ecs.generated.ts",
7147 "line": 2011
7148 },
7149 "name": "loadBalancers",
7150 "optional": true,
7151 "type": {
7152 "union": {
7153 "types": [
7154 {
7155 "fqn": "@aws-cdk/core.IResolvable"
7156 },
7157 {
7158 "collection": {
7159 "elementtype": {
7160 "union": {
7161 "types": [
7162 {
7163 "fqn": "@aws-cdk/aws-ecs.CfnService.LoadBalancerProperty"
7164 },
7165 {
7166 "fqn": "@aws-cdk/core.IResolvable"
7167 }
7168 ]
7169 }
7170 },
7171 "kind": "array"
7172 }
7173 }
7174 ]
7175 }
7176 }
7177 },
7178 {
7179 "docs": {
7180 "custom": {
7181 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration"
7182 },
7183 "remarks": "This parameter is required for task definitions that use the `awsvpc` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide* .",
7184 "stability": "external",
7185 "summary": "The network configuration for the service."
7186 },
7187 "locationInModule": {
7188 "filename": "lib/ecs.generated.ts",
7189 "line": 2018
7190 },
7191 "name": "networkConfiguration",
7192 "optional": true,
7193 "type": {
7194 "union": {
7195 "types": [
7196 {
7197 "fqn": "@aws-cdk/aws-ecs.CfnService.NetworkConfigurationProperty"
7198 },
7199 {
7200 "fqn": "@aws-cdk/core.IResolvable"
7201 }
7202 ]
7203 }
7204 }
7205 },
7206 {
7207 "docs": {
7208 "custom": {
7209 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints"
7210 },
7211 "remarks": "You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.",
7212 "stability": "external",
7213 "summary": "An array of placement constraint objects to use for tasks in your service."
7214 },
7215 "locationInModule": {
7216 "filename": "lib/ecs.generated.ts",
7217 "line": 2025
7218 },
7219 "name": "placementConstraints",
7220 "optional": true,
7221 "type": {
7222 "union": {
7223 "types": [
7224 {
7225 "fqn": "@aws-cdk/core.IResolvable"
7226 },
7227 {
7228 "collection": {
7229 "elementtype": {
7230 "union": {
7231 "types": [
7232 {
7233 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementConstraintProperty"
7234 },
7235 {
7236 "fqn": "@aws-cdk/core.IResolvable"
7237 }
7238 ]
7239 }
7240 },
7241 "kind": "array"
7242 }
7243 }
7244 ]
7245 }
7246 }
7247 },
7248 {
7249 "docs": {
7250 "custom": {
7251 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies"
7252 },
7253 "remarks": "You can specify a maximum of five strategy rules per service. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide* .",
7254 "stability": "external",
7255 "summary": "The placement strategy objects to use for tasks in your service."
7256 },
7257 "locationInModule": {
7258 "filename": "lib/ecs.generated.ts",
7259 "line": 2032
7260 },
7261 "name": "placementStrategies",
7262 "optional": true,
7263 "type": {
7264 "union": {
7265 "types": [
7266 {
7267 "fqn": "@aws-cdk/core.IResolvable"
7268 },
7269 {
7270 "collection": {
7271 "elementtype": {
7272 "union": {
7273 "types": [
7274 {
7275 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementStrategyProperty"
7276 },
7277 {
7278 "fqn": "@aws-cdk/core.IResolvable"
7279 }
7280 ]
7281 }
7282 },
7283 "kind": "array"
7284 }
7285 }
7286 ]
7287 }
7288 }
7289 },
7290 {
7291 "docs": {
7292 "custom": {
7293 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion"
7294 },
7295 "remarks": "A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used. For more information, see [AWS Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .",
7296 "stability": "external",
7297 "summary": "The platform version that your tasks in the service are running on."
7298 },
7299 "locationInModule": {
7300 "filename": "lib/ecs.generated.ts",
7301 "line": 2039
7302 },
7303 "name": "platformVersion",
7304 "optional": true,
7305 "type": {
7306 "primitive": "string"
7307 }
7308 },
7309 {
7310 "docs": {
7311 "custom": {
7312 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags"
7313 },
7314 "remarks": "If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.",
7315 "stability": "external",
7316 "summary": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service."
7317 },
7318 "locationInModule": {
7319 "filename": "lib/ecs.generated.ts",
7320 "line": 2046
7321 },
7322 "name": "propagateTags",
7323 "optional": true,
7324 "type": {
7325 "primitive": "string"
7326 }
7327 },
7328 {
7329 "docs": {
7330 "custom": {
7331 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role"
7332 },
7333 "remarks": "This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the `awsvpc` network mode. If you specify the `role` parameter, you must also specify a load balancer object with the `loadBalancers` parameter.\n\n> If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the `awsvpc` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIf your specified role has a path other than `/` , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name `bar` has a path of `/foo/` then you would specify `/foo/bar` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide* .",
7334 "stability": "external",
7335 "summary": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf."
7336 },
7337 "locationInModule": {
7338 "filename": "lib/ecs.generated.ts",
7339 "line": 2057
7340 },
7341 "name": "role",
7342 "optional": true,
7343 "type": {
7344 "primitive": "string"
7345 }
7346 },
7347 {
7348 "docs": {
7349 "custom": {
7350 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy"
7351 },
7352 "remarks": "There are two service scheduler strategies available:\n\n- `REPLICA` -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.\n- `DAEMON` -The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n\n> Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy.",
7353 "stability": "external",
7354 "summary": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) ."
7355 },
7356 "locationInModule": {
7357 "filename": "lib/ecs.generated.ts",
7358 "line": 2071
7359 },
7360 "name": "schedulingStrategy",
7361 "optional": true,
7362 "type": {
7363 "primitive": "string"
7364 }
7365 },
7366 {
7367 "docs": {
7368 "custom": {
7369 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename"
7370 },
7371 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.",
7372 "stability": "external",
7373 "summary": "The name of your service."
7374 },
7375 "locationInModule": {
7376 "filename": "lib/ecs.generated.ts",
7377 "line": 2078
7378 },
7379 "name": "serviceName",
7380 "optional": true,
7381 "type": {
7382 "primitive": "string"
7383 }
7384 },
7385 {
7386 "docs": {
7387 "custom": {
7388 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries"
7389 },
7390 "remarks": "> Each service may be associated with one service registry. Multiple service registries for each service isn't supported.",
7391 "stability": "external",
7392 "summary": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) ."
7393 },
7394 "locationInModule": {
7395 "filename": "lib/ecs.generated.ts",
7396 "line": 2087
7397 },
7398 "name": "serviceRegistries",
7399 "optional": true,
7400 "type": {
7401 "union": {
7402 "types": [
7403 {
7404 "fqn": "@aws-cdk/core.IResolvable"
7405 },
7406 {
7407 "collection": {
7408 "elementtype": {
7409 "union": {
7410 "types": [
7411 {
7412 "fqn": "@aws-cdk/aws-ecs.CfnService.ServiceRegistryProperty"
7413 },
7414 {
7415 "fqn": "@aws-cdk/core.IResolvable"
7416 }
7417 ]
7418 }
7419 },
7420 "kind": "array"
7421 }
7422 }
7423 ]
7424 }
7425 }
7426 },
7427 {
7428 "docs": {
7429 "custom": {
7430 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition"
7431 },
7432 "remarks": "The `revision` is required in order for the resource to stabilize.\n\nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers.",
7433 "stability": "external",
7434 "summary": "The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service."
7435 },
7436 "locationInModule": {
7437 "filename": "lib/ecs.generated.ts",
7438 "line": 2113
7439 },
7440 "name": "taskDefinition",
7441 "optional": true,
7442 "type": {
7443 "primitive": "string"
7444 }
7445 }
7446 ],
7447 "symbolId": "lib/ecs.generated:CfnService"
7448 },
7449 "@aws-cdk/aws-ecs.CfnService.AwsVpcConfigurationProperty": {
7450 "assembly": "@aws-cdk/aws-ecs",
7451 "datatype": true,
7452 "docs": {
7453 "custom": {
7454 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html",
7455 "exampleMetadata": "fixture=_generated"
7456 },
7457 "stability": "external",
7458 "summary": "An object representing the networking details for a task or service.",
7459 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst awsVpcConfigurationProperty: ecs.CfnService.AwsVpcConfigurationProperty = {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n};"
7460 },
7461 "fqn": "@aws-cdk/aws-ecs.CfnService.AwsVpcConfigurationProperty",
7462 "kind": "interface",
7463 "locationInModule": {
7464 "filename": "lib/ecs.generated.ts",
7465 "line": 2201
7466 },
7467 "name": "AwsVpcConfigurationProperty",
7468 "namespace": "CfnService",
7469 "properties": [
7470 {
7471 "abstract": true,
7472 "docs": {
7473 "custom": {
7474 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-subnets"
7475 },
7476 "remarks": "There's a limit of 16 subnets that can be specified per `AwsVpcConfiguration` .\n\n> All specified subnets must be from the same VPC.",
7477 "stability": "external",
7478 "summary": "The IDs of the subnets associated with the task or service."
7479 },
7480 "immutable": true,
7481 "locationInModule": {
7482 "filename": "lib/ecs.generated.ts",
7483 "line": 2223
7484 },
7485 "name": "subnets",
7486 "type": {
7487 "collection": {
7488 "elementtype": {
7489 "primitive": "string"
7490 },
7491 "kind": "array"
7492 }
7493 }
7494 },
7495 {
7496 "abstract": true,
7497 "docs": {
7498 "custom": {
7499 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-assignpublicip"
7500 },
7501 "remarks": "The default value is `DISABLED` .",
7502 "stability": "external",
7503 "summary": "Whether the task's elastic network interface receives a public IP address."
7504 },
7505 "immutable": true,
7506 "locationInModule": {
7507 "filename": "lib/ecs.generated.ts",
7508 "line": 2207
7509 },
7510 "name": "assignPublicIp",
7511 "optional": true,
7512 "type": {
7513 "primitive": "string"
7514 }
7515 },
7516 {
7517 "abstract": true,
7518 "docs": {
7519 "custom": {
7520 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-securitygroups"
7521 },
7522 "remarks": "If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per `AwsVpcConfiguration` .\n\n> All specified security groups must be from the same VPC.",
7523 "stability": "external",
7524 "summary": "The IDs of the security groups associated with the task or service."
7525 },
7526 "immutable": true,
7527 "locationInModule": {
7528 "filename": "lib/ecs.generated.ts",
7529 "line": 2215
7530 },
7531 "name": "securityGroups",
7532 "optional": true,
7533 "type": {
7534 "collection": {
7535 "elementtype": {
7536 "primitive": "string"
7537 },
7538 "kind": "array"
7539 }
7540 }
7541 }
7542 ],
7543 "symbolId": "lib/ecs.generated:CfnService.AwsVpcConfigurationProperty"
7544 },
7545 "@aws-cdk/aws-ecs.CfnService.CapacityProviderStrategyItemProperty": {
7546 "assembly": "@aws-cdk/aws-ecs",
7547 "datatype": true,
7548 "docs": {
7549 "custom": {
7550 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html",
7551 "exampleMetadata": "fixture=_generated"
7552 },
7553 "remarks": "A capacity provider strategy can be set when using the `RunTask` or `CreateService` APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API.\n\nOnly capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The `PutClusterCapacityProviders` API is used to associate a capacity provider with a cluster.\n\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the `CreateCapacityProvider` API operation.\n\nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.",
7554 "stability": "external",
7555 "summary": "The details of a capacity provider strategy.",
7556 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst capacityProviderStrategyItemProperty: ecs.CfnService.CapacityProviderStrategyItemProperty = {\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n};"
7557 },
7558 "fqn": "@aws-cdk/aws-ecs.CfnService.CapacityProviderStrategyItemProperty",
7559 "kind": "interface",
7560 "locationInModule": {
7561 "filename": "lib/ecs.generated.ts",
7562 "line": 2297
7563 },
7564 "name": "CapacityProviderStrategyItemProperty",
7565 "namespace": "CfnService",
7566 "properties": [
7567 {
7568 "abstract": true,
7569 "docs": {
7570 "custom": {
7571 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-base"
7572 },
7573 "remarks": "Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used.",
7574 "stability": "external",
7575 "summary": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider."
7576 },
7577 "immutable": true,
7578 "locationInModule": {
7579 "filename": "lib/ecs.generated.ts",
7580 "line": 2303
7581 },
7582 "name": "base",
7583 "optional": true,
7584 "type": {
7585 "primitive": "number"
7586 }
7587 },
7588 {
7589 "abstract": true,
7590 "docs": {
7591 "custom": {
7592 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-capacityprovider"
7593 },
7594 "stability": "external",
7595 "summary": "The short name of the capacity provider."
7596 },
7597 "immutable": true,
7598 "locationInModule": {
7599 "filename": "lib/ecs.generated.ts",
7600 "line": 2309
7601 },
7602 "name": "capacityProvider",
7603 "optional": true,
7604 "type": {
7605 "primitive": "string"
7606 }
7607 },
7608 {
7609 "abstract": true,
7610 "docs": {
7611 "custom": {
7612 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-weight"
7613 },
7614 "remarks": "The `weight` value is taken into consideration after the `base` value, if defined, is satisfied.\n\nIf no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail.\n\nAn example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of `1` , then when the `base` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of `1` for *capacityProviderA* and a weight of `4` for *capacityProviderB* , then for every one task that's run using *capacityProviderA* , four tasks would use *capacityProviderB* .",
7615 "stability": "external",
7616 "summary": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider."
7617 },
7618 "immutable": true,
7619 "locationInModule": {
7620 "filename": "lib/ecs.generated.ts",
7621 "line": 2319
7622 },
7623 "name": "weight",
7624 "optional": true,
7625 "type": {
7626 "primitive": "number"
7627 }
7628 }
7629 ],
7630 "symbolId": "lib/ecs.generated:CfnService.CapacityProviderStrategyItemProperty"
7631 },
7632 "@aws-cdk/aws-ecs.CfnService.DeploymentCircuitBreakerProperty": {
7633 "assembly": "@aws-cdk/aws-ecs",
7634 "datatype": true,
7635 "docs": {
7636 "custom": {
7637 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html",
7638 "exampleMetadata": "fixture=_generated"
7639 },
7640 "remarks": "The `DeploymentCircuitBreaker` property determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.",
7641 "stability": "external",
7642 "summary": "> The deployment circuit breaker can only be used for services using the rolling update ( `ECS` ) deployment type.",
7643 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst deploymentCircuitBreakerProperty: ecs.CfnService.DeploymentCircuitBreakerProperty = {\n enable: false,\n rollback: false,\n};"
7644 },
7645 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentCircuitBreakerProperty",
7646 "kind": "interface",
7647 "locationInModule": {
7648 "filename": "lib/ecs.generated.ts",
7649 "line": 2388
7650 },
7651 "name": "DeploymentCircuitBreakerProperty",
7652 "namespace": "CfnService",
7653 "properties": [
7654 {
7655 "abstract": true,
7656 "docs": {
7657 "custom": {
7658 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-enable"
7659 },
7660 "stability": "external",
7661 "summary": "Determines whether to use the deployment circuit breaker logic for the service."
7662 },
7663 "immutable": true,
7664 "locationInModule": {
7665 "filename": "lib/ecs.generated.ts",
7666 "line": 2394
7667 },
7668 "name": "enable",
7669 "type": {
7670 "union": {
7671 "types": [
7672 {
7673 "primitive": "boolean"
7674 },
7675 {
7676 "fqn": "@aws-cdk/core.IResolvable"
7677 }
7678 ]
7679 }
7680 }
7681 },
7682 {
7683 "abstract": true,
7684 "docs": {
7685 "custom": {
7686 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-rollback"
7687 },
7688 "remarks": "If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.",
7689 "stability": "external",
7690 "summary": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails."
7691 },
7692 "immutable": true,
7693 "locationInModule": {
7694 "filename": "lib/ecs.generated.ts",
7695 "line": 2400
7696 },
7697 "name": "rollback",
7698 "type": {
7699 "union": {
7700 "types": [
7701 {
7702 "primitive": "boolean"
7703 },
7704 {
7705 "fqn": "@aws-cdk/core.IResolvable"
7706 }
7707 ]
7708 }
7709 }
7710 }
7711 ],
7712 "symbolId": "lib/ecs.generated:CfnService.DeploymentCircuitBreakerProperty"
7713 },
7714 "@aws-cdk/aws-ecs.CfnService.DeploymentConfigurationProperty": {
7715 "assembly": "@aws-cdk/aws-ecs",
7716 "datatype": true,
7717 "docs": {
7718 "custom": {
7719 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html",
7720 "exampleMetadata": "fixture=_generated"
7721 },
7722 "stability": "external",
7723 "summary": "The `DeploymentConfiguration` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.",
7724 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst deploymentConfigurationProperty: ecs.CfnService.DeploymentConfigurationProperty = {\n deploymentCircuitBreaker: {\n enable: false,\n rollback: false,\n },\n maximumPercent: 123,\n minimumHealthyPercent: 123,\n};"
7725 },
7726 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentConfigurationProperty",
7727 "kind": "interface",
7728 "locationInModule": {
7729 "filename": "lib/ecs.generated.ts",
7730 "line": 2466
7731 },
7732 "name": "DeploymentConfigurationProperty",
7733 "namespace": "CfnService",
7734 "properties": [
7735 {
7736 "abstract": true,
7737 "docs": {
7738 "custom": {
7739 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-deploymentcircuitbreaker"
7740 },
7741 "remarks": "The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* .",
7742 "stability": "external",
7743 "summary": "> The deployment circuit breaker can only be used for services using the rolling update ( `ECS` ) deployment type that are not behind a Classic Load Balancer."
7744 },
7745 "immutable": true,
7746 "locationInModule": {
7747 "filename": "lib/ecs.generated.ts",
7748 "line": 2474
7749 },
7750 "name": "deploymentCircuitBreaker",
7751 "optional": true,
7752 "type": {
7753 "union": {
7754 "types": [
7755 {
7756 "fqn": "@aws-cdk/core.IResolvable"
7757 },
7758 {
7759 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentCircuitBreakerProperty"
7760 }
7761 ]
7762 }
7763 }
7764 },
7765 {
7766 "abstract": true,
7767 "docs": {
7768 "custom": {
7769 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-maximumpercent"
7770 },
7771 "remarks": "This parameter enables you to define the deployment batch size. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%.\n\nIf a service is using either the blue/green ( `CODE_DEPLOY` ) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.",
7772 "stability": "external",
7773 "summary": "If a service is using the rolling update ( `ECS` ) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service's tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` (rounded down to the nearest integer)."
7774 },
7775 "immutable": true,
7776 "locationInModule": {
7777 "filename": "lib/ecs.generated.ts",
7778 "line": 2482
7779 },
7780 "name": "maximumPercent",
7781 "optional": true,
7782 "type": {
7783 "primitive": "number"
7784 }
7785 },
7786 {
7787 "abstract": true,
7788 "docs": {
7789 "custom": {
7790 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-minimumhealthypercent"
7791 },
7792 "remarks": "This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.\n\nFor services that *do not* use a load balancer, the following should be noted:\n\n- A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n- If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total.\n- If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.\n\nFor services are that *do* use a load balancer, the following should be noted:\n\n- If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n- If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n\nIf a service is using either the blue/green ( `CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. If a service is using either the blue/green ( `CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.",
7793 "stability": "external",
7794 "summary": "If a service is using the rolling update ( `ECS` ) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service's tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` (rounded up to the nearest integer)."
7795 },
7796 "immutable": true,
7797 "locationInModule": {
7798 "filename": "lib/ecs.generated.ts",
7799 "line": 2501
7800 },
7801 "name": "minimumHealthyPercent",
7802 "optional": true,
7803 "type": {
7804 "primitive": "number"
7805 }
7806 }
7807 ],
7808 "symbolId": "lib/ecs.generated:CfnService.DeploymentConfigurationProperty"
7809 },
7810 "@aws-cdk/aws-ecs.CfnService.DeploymentControllerProperty": {
7811 "assembly": "@aws-cdk/aws-ecs",
7812 "datatype": true,
7813 "docs": {
7814 "custom": {
7815 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html",
7816 "exampleMetadata": "fixture=_generated"
7817 },
7818 "remarks": "For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide* .",
7819 "stability": "external",
7820 "summary": "The deployment controller to use for the service.",
7821 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst deploymentControllerProperty: ecs.CfnService.DeploymentControllerProperty = {\n type: 'type',\n};"
7822 },
7823 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentControllerProperty",
7824 "kind": "interface",
7825 "locationInModule": {
7826 "filename": "lib/ecs.generated.ts",
7827 "line": 2568
7828 },
7829 "name": "DeploymentControllerProperty",
7830 "namespace": "CfnService",
7831 "properties": [
7832 {
7833 "abstract": true,
7834 "docs": {
7835 "custom": {
7836 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html#cfn-ecs-service-deploymentcontroller-type"
7837 },
7838 "remarks": "- **ECS** - The rolling update ( `ECS` ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the [DeploymentConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html) .\n- **CODE_DEPLOY** - The blue/green ( `CODE_DEPLOY` ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy , which allows you to verify a new deployment of a service before sending production traffic to it.\n- **EXTERNAL** - The external ( `EXTERNAL` ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.",
7839 "stability": "external",
7840 "summary": "The deployment controller type to use. There are three deployment controller types available:."
7841 },
7842 "immutable": true,
7843 "locationInModule": {
7844 "filename": "lib/ecs.generated.ts",
7845 "line": 2578
7846 },
7847 "name": "type",
7848 "optional": true,
7849 "type": {
7850 "primitive": "string"
7851 }
7852 }
7853 ],
7854 "symbolId": "lib/ecs.generated:CfnService.DeploymentControllerProperty"
7855 },
7856 "@aws-cdk/aws-ecs.CfnService.LoadBalancerProperty": {
7857 "assembly": "@aws-cdk/aws-ecs",
7858 "datatype": true,
7859 "docs": {
7860 "custom": {
7861 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html",
7862 "exampleMetadata": "fixture=_generated"
7863 },
7864 "remarks": "If the service is using the `CODE_DEPLOY` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a `targetGroupPair` ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.\n\nServices with tasks that use the `awsvpc` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose `ip` as the target type, not `instance` . Tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.",
7865 "stability": "external",
7866 "summary": "The `LoadBalancer` property specifies details on a load balancer that is used with a service.",
7867 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst loadBalancerProperty: ecs.CfnService.LoadBalancerProperty = {\n containerPort: 123,\n\n // the properties below are optional\n containerName: 'containerName',\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n};"
7868 },
7869 "fqn": "@aws-cdk/aws-ecs.CfnService.LoadBalancerProperty",
7870 "kind": "interface",
7871 "locationInModule": {
7872 "filename": "lib/ecs.generated.ts",
7873 "line": 2643
7874 },
7875 "name": "LoadBalancerProperty",
7876 "namespace": "CfnService",
7877 "properties": [
7878 {
7879 "abstract": true,
7880 "docs": {
7881 "custom": {
7882 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containerport"
7883 },
7884 "remarks": "This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the `hostPort` of the port mapping.",
7885 "stability": "external",
7886 "summary": "The port on the container to associate with the load balancer."
7887 },
7888 "immutable": true,
7889 "locationInModule": {
7890 "filename": "lib/ecs.generated.ts",
7891 "line": 2655
7892 },
7893 "name": "containerPort",
7894 "type": {
7895 "primitive": "number"
7896 }
7897 },
7898 {
7899 "abstract": true,
7900 "docs": {
7901 "custom": {
7902 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containername"
7903 },
7904 "stability": "external",
7905 "summary": "The name of the container (as it appears in a container definition) to associate with the load balancer."
7906 },
7907 "immutable": true,
7908 "locationInModule": {
7909 "filename": "lib/ecs.generated.ts",
7910 "line": 2649
7911 },
7912 "name": "containerName",
7913 "optional": true,
7914 "type": {
7915 "primitive": "string"
7916 }
7917 },
7918 {
7919 "abstract": true,
7920 "docs": {
7921 "custom": {
7922 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-loadbalancername"
7923 },
7924 "remarks": "A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.",
7925 "stability": "external",
7926 "summary": "The name of the load balancer to associate with the Amazon ECS service or task set."
7927 },
7928 "immutable": true,
7929 "locationInModule": {
7930 "filename": "lib/ecs.generated.ts",
7931 "line": 2663
7932 },
7933 "name": "loadBalancerName",
7934 "optional": true,
7935 "type": {
7936 "primitive": "string"
7937 }
7938 },
7939 {
7940 "abstract": true,
7941 "docs": {
7942 "custom": {
7943 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-targetgrouparn"
7944 },
7945 "remarks": "A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.\n\nFor services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> If your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance` . Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.",
7946 "stability": "external",
7947 "summary": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set."
7948 },
7949 "immutable": true,
7950 "locationInModule": {
7951 "filename": "lib/ecs.generated.ts",
7952 "line": 2677
7953 },
7954 "name": "targetGroupArn",
7955 "optional": true,
7956 "type": {
7957 "primitive": "string"
7958 }
7959 }
7960 ],
7961 "symbolId": "lib/ecs.generated:CfnService.LoadBalancerProperty"
7962 },
7963 "@aws-cdk/aws-ecs.CfnService.NetworkConfigurationProperty": {
7964 "assembly": "@aws-cdk/aws-ecs",
7965 "datatype": true,
7966 "docs": {
7967 "custom": {
7968 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html",
7969 "exampleMetadata": "fixture=_generated"
7970 },
7971 "stability": "external",
7972 "summary": "The `NetworkConfiguration` property specifies an object representing the network configuration for a task or service.",
7973 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst networkConfigurationProperty: ecs.CfnService.NetworkConfigurationProperty = {\n awsvpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n};"
7974 },
7975 "fqn": "@aws-cdk/aws-ecs.CfnService.NetworkConfigurationProperty",
7976 "kind": "interface",
7977 "locationInModule": {
7978 "filename": "lib/ecs.generated.ts",
7979 "line": 2748
7980 },
7981 "name": "NetworkConfigurationProperty",
7982 "namespace": "CfnService",
7983 "properties": [
7984 {
7985 "abstract": true,
7986 "docs": {
7987 "custom": {
7988 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html#cfn-ecs-service-networkconfiguration-awsvpcconfiguration"
7989 },
7990 "remarks": "> All specified subnets and security groups must be from the same VPC.",
7991 "stability": "external",
7992 "summary": "The VPC subnets and security groups that are associated with a task."
7993 },
7994 "immutable": true,
7995 "locationInModule": {
7996 "filename": "lib/ecs.generated.ts",
7997 "line": 2756
7998 },
7999 "name": "awsvpcConfiguration",
8000 "optional": true,
8001 "type": {
8002 "union": {
8003 "types": [
8004 {
8005 "fqn": "@aws-cdk/core.IResolvable"
8006 },
8007 {
8008 "fqn": "@aws-cdk/aws-ecs.CfnService.AwsVpcConfigurationProperty"
8009 }
8010 ]
8011 }
8012 }
8013 }
8014 ],
8015 "symbolId": "lib/ecs.generated:CfnService.NetworkConfigurationProperty"
8016 },
8017 "@aws-cdk/aws-ecs.CfnService.PlacementConstraintProperty": {
8018 "assembly": "@aws-cdk/aws-ecs",
8019 "datatype": true,
8020 "docs": {
8021 "custom": {
8022 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html",
8023 "exampleMetadata": "fixture=_generated"
8024 },
8025 "remarks": "For more information, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide* .",
8026 "stability": "external",
8027 "summary": "The `PlacementConstraint` property specifies an object representing a constraint on task placement in the task definition.",
8028 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst placementConstraintProperty: ecs.CfnService.PlacementConstraintProperty = {\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n};"
8029 },
8030 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementConstraintProperty",
8031 "kind": "interface",
8032 "locationInModule": {
8033 "filename": "lib/ecs.generated.ts",
8034 "line": 2817
8035 },
8036 "name": "PlacementConstraintProperty",
8037 "namespace": "CfnService",
8038 "properties": [
8039 {
8040 "abstract": true,
8041 "docs": {
8042 "custom": {
8043 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type"
8044 },
8045 "remarks": "Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates.",
8046 "stability": "external",
8047 "summary": "The type of constraint."
8048 },
8049 "immutable": true,
8050 "locationInModule": {
8051 "filename": "lib/ecs.generated.ts",
8052 "line": 2829
8053 },
8054 "name": "type",
8055 "type": {
8056 "primitive": "string"
8057 }
8058 },
8059 {
8060 "abstract": true,
8061 "docs": {
8062 "custom": {
8063 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-expression"
8064 },
8065 "remarks": "The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is `distinctInstance` . For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide* .",
8066 "stability": "external",
8067 "summary": "A cluster query language expression to apply to the constraint."
8068 },
8069 "immutable": true,
8070 "locationInModule": {
8071 "filename": "lib/ecs.generated.ts",
8072 "line": 2823
8073 },
8074 "name": "expression",
8075 "optional": true,
8076 "type": {
8077 "primitive": "string"
8078 }
8079 }
8080 ],
8081 "symbolId": "lib/ecs.generated:CfnService.PlacementConstraintProperty"
8082 },
8083 "@aws-cdk/aws-ecs.CfnService.PlacementStrategyProperty": {
8084 "assembly": "@aws-cdk/aws-ecs",
8085 "datatype": true,
8086 "docs": {
8087 "custom": {
8088 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html",
8089 "exampleMetadata": "fixture=_generated"
8090 },
8091 "remarks": "For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide* .",
8092 "stability": "external",
8093 "summary": "The `PlacementStrategy` property specifies the task placement strategy for a task or service.",
8094 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst placementStrategyProperty: ecs.CfnService.PlacementStrategyProperty = {\n type: 'type',\n\n // the properties below are optional\n field: 'field',\n};"
8095 },
8096 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementStrategyProperty",
8097 "kind": "interface",
8098 "locationInModule": {
8099 "filename": "lib/ecs.generated.ts",
8100 "line": 2894
8101 },
8102 "name": "PlacementStrategyProperty",
8103 "namespace": "CfnService",
8104 "properties": [
8105 {
8106 "abstract": true,
8107 "docs": {
8108 "custom": {
8109 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-type"
8110 },
8111 "remarks": "The `random` placement strategy randomly places tasks on available candidates. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.",
8112 "stability": "external",
8113 "summary": "The type of placement strategy."
8114 },
8115 "immutable": true,
8116 "locationInModule": {
8117 "filename": "lib/ecs.generated.ts",
8118 "line": 2906
8119 },
8120 "name": "type",
8121 "type": {
8122 "primitive": "string"
8123 }
8124 },
8125 {
8126 "abstract": true,
8127 "docs": {
8128 "custom": {
8129 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-field"
8130 },
8131 "remarks": "For the `spread` placement strategy, valid values are `instanceId` (or `host` , which has the same effect), or any platform or custom attribute that's applied to a container instance, such as `attribute:ecs.availability-zone` . For the `binpack` placement strategy, valid values are `cpu` and `memory` . For the `random` placement strategy, this field is not used.",
8132 "stability": "external",
8133 "summary": "The field to apply the placement strategy against."
8134 },
8135 "immutable": true,
8136 "locationInModule": {
8137 "filename": "lib/ecs.generated.ts",
8138 "line": 2900
8139 },
8140 "name": "field",
8141 "optional": true,
8142 "type": {
8143 "primitive": "string"
8144 }
8145 }
8146 ],
8147 "symbolId": "lib/ecs.generated:CfnService.PlacementStrategyProperty"
8148 },
8149 "@aws-cdk/aws-ecs.CfnService.ServiceRegistryProperty": {
8150 "assembly": "@aws-cdk/aws-ecs",
8151 "datatype": true,
8152 "docs": {
8153 "custom": {
8154 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html",
8155 "exampleMetadata": "fixture=_generated"
8156 },
8157 "remarks": "For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) in the *Amazon Elastic Container Service Developer Guide* .",
8158 "stability": "external",
8159 "summary": "The `ServiceRegistry` property specifies details of the service registry.",
8160 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst serviceRegistryProperty: ecs.CfnService.ServiceRegistryProperty = {\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n};"
8161 },
8162 "fqn": "@aws-cdk/aws-ecs.CfnService.ServiceRegistryProperty",
8163 "kind": "interface",
8164 "locationInModule": {
8165 "filename": "lib/ecs.generated.ts",
8166 "line": 2971
8167 },
8168 "name": "ServiceRegistryProperty",
8169 "namespace": "CfnService",
8170 "properties": [
8171 {
8172 "abstract": true,
8173 "docs": {
8174 "custom": {
8175 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containername"
8176 },
8177 "remarks": "It's already specified in the task definition. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can't specify both.",
8178 "stability": "external",
8179 "summary": "The container name value to be used for your service discovery service."
8180 },
8181 "immutable": true,
8182 "locationInModule": {
8183 "filename": "lib/ecs.generated.ts",
8184 "line": 2977
8185 },
8186 "name": "containerName",
8187 "optional": true,
8188 "type": {
8189 "primitive": "string"
8190 }
8191 },
8192 {
8193 "abstract": true,
8194 "docs": {
8195 "custom": {
8196 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containerport"
8197 },
8198 "remarks": "It's already specified in the task definition. If the task definition your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can't specify both.",
8199 "stability": "external",
8200 "summary": "The port value to be used for your service discovery service."
8201 },
8202 "immutable": true,
8203 "locationInModule": {
8204 "filename": "lib/ecs.generated.ts",
8205 "line": 2983
8206 },
8207 "name": "containerPort",
8208 "optional": true,
8209 "type": {
8210 "primitive": "number"
8211 }
8212 },
8213 {
8214 "abstract": true,
8215 "docs": {
8216 "custom": {
8217 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port"
8218 },
8219 "remarks": "This field might be used if both the `awsvpc` network mode and SRV records are used.",
8220 "stability": "external",
8221 "summary": "The port value used if your service discovery service specified an SRV record."
8222 },
8223 "immutable": true,
8224 "locationInModule": {
8225 "filename": "lib/ecs.generated.ts",
8226 "line": 2989
8227 },
8228 "name": "port",
8229 "optional": true,
8230 "type": {
8231 "primitive": "number"
8232 }
8233 },
8234 {
8235 "abstract": true,
8236 "docs": {
8237 "custom": {
8238 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn"
8239 },
8240 "remarks": "The currently supported service registry is AWS Cloud Map . For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) .",
8241 "stability": "external",
8242 "summary": "The Amazon Resource Name (ARN) of the service registry."
8243 },
8244 "immutable": true,
8245 "locationInModule": {
8246 "filename": "lib/ecs.generated.ts",
8247 "line": 2995
8248 },
8249 "name": "registryArn",
8250 "optional": true,
8251 "type": {
8252 "primitive": "string"
8253 }
8254 }
8255 ],
8256 "symbolId": "lib/ecs.generated:CfnService.ServiceRegistryProperty"
8257 },
8258 "@aws-cdk/aws-ecs.CfnServiceProps": {
8259 "assembly": "@aws-cdk/aws-ecs",
8260 "datatype": true,
8261 "docs": {
8262 "custom": {
8263 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html",
8264 "exampleMetadata": "fixture=_generated"
8265 },
8266 "stability": "external",
8267 "summary": "Properties for defining a `CfnService`.",
8268 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnServiceProps: ecs.CfnServiceProps = {\n capacityProviderStrategy: [{\n base: 123,\n capacityProvider: 'capacityProvider',\n weight: 123,\n }],\n cluster: 'cluster',\n deploymentConfiguration: {\n deploymentCircuitBreaker: {\n enable: false,\n rollback: false,\n },\n maximumPercent: 123,\n minimumHealthyPercent: 123,\n },\n deploymentController: {\n type: 'type',\n },\n desiredCount: 123,\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n healthCheckGracePeriodSeconds: 123,\n launchType: 'launchType',\n loadBalancers: [{\n containerPort: 123,\n\n // the properties below are optional\n containerName: 'containerName',\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n }],\n networkConfiguration: {\n awsvpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n }],\n placementStrategies: [{\n type: 'type',\n\n // the properties below are optional\n field: 'field',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n role: 'role',\n schedulingStrategy: 'schedulingStrategy',\n serviceName: 'serviceName',\n serviceRegistries: [{\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n taskDefinition: 'taskDefinition',\n};"
8269 },
8270 "fqn": "@aws-cdk/aws-ecs.CfnServiceProps",
8271 "kind": "interface",
8272 "locationInModule": {
8273 "filename": "lib/ecs.generated.ts",
8274 "line": 1576
8275 },
8276 "name": "CfnServiceProps",
8277 "properties": [
8278 {
8279 "abstract": true,
8280 "docs": {
8281 "custom": {
8282 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy"
8283 },
8284 "remarks": "A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.\n\nReview the [Capacity provider considerations](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html#capacity-providers-considerations) in the *Amazon Elastic Container Service Developer Guide.*\n\nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used.\n\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.\n\nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n\nThe PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.",
8285 "stability": "external",
8286 "summary": "The capacity provider strategy to use for the service."
8287 },
8288 "immutable": true,
8289 "locationInModule": {
8290 "filename": "lib/ecs.generated.ts",
8291 "line": 1595
8292 },
8293 "name": "capacityProviderStrategy",
8294 "optional": true,
8295 "type": {
8296 "union": {
8297 "types": [
8298 {
8299 "fqn": "@aws-cdk/core.IResolvable"
8300 },
8301 {
8302 "collection": {
8303 "elementtype": {
8304 "union": {
8305 "types": [
8306 {
8307 "fqn": "@aws-cdk/core.IResolvable"
8308 },
8309 {
8310 "fqn": "@aws-cdk/aws-ecs.CfnService.CapacityProviderStrategyItemProperty"
8311 }
8312 ]
8313 }
8314 },
8315 "kind": "array"
8316 }
8317 }
8318 ]
8319 }
8320 }
8321 },
8322 {
8323 "abstract": true,
8324 "docs": {
8325 "custom": {
8326 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster"
8327 },
8328 "remarks": "If you do not specify a cluster, the default cluster is assumed.",
8329 "stability": "external",
8330 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on."
8331 },
8332 "immutable": true,
8333 "locationInModule": {
8334 "filename": "lib/ecs.generated.ts",
8335 "line": 1602
8336 },
8337 "name": "cluster",
8338 "optional": true,
8339 "type": {
8340 "primitive": "string"
8341 }
8342 },
8343 {
8344 "abstract": true,
8345 "docs": {
8346 "custom": {
8347 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration"
8348 },
8349 "stability": "external",
8350 "summary": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks."
8351 },
8352 "immutable": true,
8353 "locationInModule": {
8354 "filename": "lib/ecs.generated.ts",
8355 "line": 1609
8356 },
8357 "name": "deploymentConfiguration",
8358 "optional": true,
8359 "type": {
8360 "union": {
8361 "types": [
8362 {
8363 "fqn": "@aws-cdk/core.IResolvable"
8364 },
8365 {
8366 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentConfigurationProperty"
8367 }
8368 ]
8369 }
8370 }
8371 },
8372 {
8373 "abstract": true,
8374 "docs": {
8375 "custom": {
8376 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller"
8377 },
8378 "remarks": "If no deployment controller is specified, the default value of `ECS` is used.",
8379 "stability": "external",
8380 "summary": "The deployment controller to use for the service."
8381 },
8382 "immutable": true,
8383 "locationInModule": {
8384 "filename": "lib/ecs.generated.ts",
8385 "line": 1616
8386 },
8387 "name": "deploymentController",
8388 "optional": true,
8389 "type": {
8390 "union": {
8391 "types": [
8392 {
8393 "fqn": "@aws-cdk/core.IResolvable"
8394 },
8395 {
8396 "fqn": "@aws-cdk/aws-ecs.CfnService.DeploymentControllerProperty"
8397 }
8398 ]
8399 }
8400 }
8401 },
8402 {
8403 "abstract": true,
8404 "docs": {
8405 "custom": {
8406 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount"
8407 },
8408 "remarks": "For new services, if a desired count is not specified, a default value of `1` is used. When using the `DAEMON` scheduling strategy, the desired count is not required.\n\nFor existing services, if a desired count is not specified, it is omitted from the operation.",
8409 "stability": "external",
8410 "summary": "The number of instantiations of the specified task definition to place and keep running on your cluster."
8411 },
8412 "immutable": true,
8413 "locationInModule": {
8414 "filename": "lib/ecs.generated.ts",
8415 "line": 1627
8416 },
8417 "name": "desiredCount",
8418 "optional": true,
8419 "type": {
8420 "primitive": "number"
8421 }
8422 },
8423 {
8424 "abstract": true,
8425 "docs": {
8426 "custom": {
8427 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags"
8428 },
8429 "remarks": "For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide* .",
8430 "stability": "external",
8431 "summary": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service."
8432 },
8433 "immutable": true,
8434 "locationInModule": {
8435 "filename": "lib/ecs.generated.ts",
8436 "line": 1634
8437 },
8438 "name": "enableEcsManagedTags",
8439 "optional": true,
8440 "type": {
8441 "union": {
8442 "types": [
8443 {
8444 "primitive": "boolean"
8445 },
8446 {
8447 "fqn": "@aws-cdk/core.IResolvable"
8448 }
8449 ]
8450 }
8451 }
8452 },
8453 {
8454 "abstract": true,
8455 "docs": {
8456 "custom": {
8457 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableexecutecommand"
8458 },
8459 "remarks": "If `true` , the execute command functionality is enabled for all containers in tasks as part of the service.",
8460 "stability": "external",
8461 "summary": "Determines whether the execute command functionality is enabled for the service."
8462 },
8463 "immutable": true,
8464 "locationInModule": {
8465 "filename": "lib/ecs.generated.ts",
8466 "line": 1641
8467 },
8468 "name": "enableExecuteCommand",
8469 "optional": true,
8470 "type": {
8471 "union": {
8472 "types": [
8473 {
8474 "primitive": "boolean"
8475 },
8476 {
8477 "fqn": "@aws-cdk/core.IResolvable"
8478 }
8479 ]
8480 }
8481 }
8482 },
8483 {
8484 "abstract": true,
8485 "docs": {
8486 "custom": {
8487 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds"
8488 },
8489 "remarks": "This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used.\n\nIf you do not use an Elastic Load Balancing, we recomend that you use the `startPeriod` in the task definition healtch check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html) .\n\nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.",
8490 "stability": "external",
8491 "summary": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started."
8492 },
8493 "immutable": true,
8494 "locationInModule": {
8495 "filename": "lib/ecs.generated.ts",
8496 "line": 1652
8497 },
8498 "name": "healthCheckGracePeriodSeconds",
8499 "optional": true,
8500 "type": {
8501 "primitive": "number"
8502 }
8503 },
8504 {
8505 "abstract": true,
8506 "docs": {
8507 "custom": {
8508 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype"
8509 },
8510 "remarks": "For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* .",
8511 "stability": "external",
8512 "summary": "The launch type on which to run your service."
8513 },
8514 "immutable": true,
8515 "locationInModule": {
8516 "filename": "lib/ecs.generated.ts",
8517 "line": 1659
8518 },
8519 "name": "launchType",
8520 "optional": true,
8521 "type": {
8522 "primitive": "string"
8523 }
8524 },
8525 {
8526 "abstract": true,
8527 "docs": {
8528 "custom": {
8529 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers"
8530 },
8531 "remarks": "If you specify the `Role` property, `LoadBalancers` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide* .",
8532 "stability": "external",
8533 "summary": "A list of load balancer objects to associate with the service."
8534 },
8535 "immutable": true,
8536 "locationInModule": {
8537 "filename": "lib/ecs.generated.ts",
8538 "line": 1666
8539 },
8540 "name": "loadBalancers",
8541 "optional": true,
8542 "type": {
8543 "union": {
8544 "types": [
8545 {
8546 "fqn": "@aws-cdk/core.IResolvable"
8547 },
8548 {
8549 "collection": {
8550 "elementtype": {
8551 "union": {
8552 "types": [
8553 {
8554 "fqn": "@aws-cdk/aws-ecs.CfnService.LoadBalancerProperty"
8555 },
8556 {
8557 "fqn": "@aws-cdk/core.IResolvable"
8558 }
8559 ]
8560 }
8561 },
8562 "kind": "array"
8563 }
8564 }
8565 ]
8566 }
8567 }
8568 },
8569 {
8570 "abstract": true,
8571 "docs": {
8572 "custom": {
8573 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration"
8574 },
8575 "remarks": "This parameter is required for task definitions that use the `awsvpc` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide* .",
8576 "stability": "external",
8577 "summary": "The network configuration for the service."
8578 },
8579 "immutable": true,
8580 "locationInModule": {
8581 "filename": "lib/ecs.generated.ts",
8582 "line": 1673
8583 },
8584 "name": "networkConfiguration",
8585 "optional": true,
8586 "type": {
8587 "union": {
8588 "types": [
8589 {
8590 "fqn": "@aws-cdk/aws-ecs.CfnService.NetworkConfigurationProperty"
8591 },
8592 {
8593 "fqn": "@aws-cdk/core.IResolvable"
8594 }
8595 ]
8596 }
8597 }
8598 },
8599 {
8600 "abstract": true,
8601 "docs": {
8602 "custom": {
8603 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints"
8604 },
8605 "remarks": "You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.",
8606 "stability": "external",
8607 "summary": "An array of placement constraint objects to use for tasks in your service."
8608 },
8609 "immutable": true,
8610 "locationInModule": {
8611 "filename": "lib/ecs.generated.ts",
8612 "line": 1680
8613 },
8614 "name": "placementConstraints",
8615 "optional": true,
8616 "type": {
8617 "union": {
8618 "types": [
8619 {
8620 "fqn": "@aws-cdk/core.IResolvable"
8621 },
8622 {
8623 "collection": {
8624 "elementtype": {
8625 "union": {
8626 "types": [
8627 {
8628 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementConstraintProperty"
8629 },
8630 {
8631 "fqn": "@aws-cdk/core.IResolvable"
8632 }
8633 ]
8634 }
8635 },
8636 "kind": "array"
8637 }
8638 }
8639 ]
8640 }
8641 }
8642 },
8643 {
8644 "abstract": true,
8645 "docs": {
8646 "custom": {
8647 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies"
8648 },
8649 "remarks": "You can specify a maximum of five strategy rules per service. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide* .",
8650 "stability": "external",
8651 "summary": "The placement strategy objects to use for tasks in your service."
8652 },
8653 "immutable": true,
8654 "locationInModule": {
8655 "filename": "lib/ecs.generated.ts",
8656 "line": 1687
8657 },
8658 "name": "placementStrategies",
8659 "optional": true,
8660 "type": {
8661 "union": {
8662 "types": [
8663 {
8664 "fqn": "@aws-cdk/core.IResolvable"
8665 },
8666 {
8667 "collection": {
8668 "elementtype": {
8669 "union": {
8670 "types": [
8671 {
8672 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementStrategyProperty"
8673 },
8674 {
8675 "fqn": "@aws-cdk/core.IResolvable"
8676 }
8677 ]
8678 }
8679 },
8680 "kind": "array"
8681 }
8682 }
8683 ]
8684 }
8685 }
8686 },
8687 {
8688 "abstract": true,
8689 "docs": {
8690 "custom": {
8691 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion"
8692 },
8693 "remarks": "A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used. For more information, see [AWS Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .",
8694 "stability": "external",
8695 "summary": "The platform version that your tasks in the service are running on."
8696 },
8697 "immutable": true,
8698 "locationInModule": {
8699 "filename": "lib/ecs.generated.ts",
8700 "line": 1694
8701 },
8702 "name": "platformVersion",
8703 "optional": true,
8704 "type": {
8705 "primitive": "string"
8706 }
8707 },
8708 {
8709 "abstract": true,
8710 "docs": {
8711 "custom": {
8712 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags"
8713 },
8714 "remarks": "If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.",
8715 "stability": "external",
8716 "summary": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service."
8717 },
8718 "immutable": true,
8719 "locationInModule": {
8720 "filename": "lib/ecs.generated.ts",
8721 "line": 1701
8722 },
8723 "name": "propagateTags",
8724 "optional": true,
8725 "type": {
8726 "primitive": "string"
8727 }
8728 },
8729 {
8730 "abstract": true,
8731 "docs": {
8732 "custom": {
8733 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role"
8734 },
8735 "remarks": "This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the `awsvpc` network mode. If you specify the `role` parameter, you must also specify a load balancer object with the `loadBalancers` parameter.\n\n> If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the `awsvpc` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIf your specified role has a path other than `/` , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name `bar` has a path of `/foo/` then you would specify `/foo/bar` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide* .",
8736 "stability": "external",
8737 "summary": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf."
8738 },
8739 "immutable": true,
8740 "locationInModule": {
8741 "filename": "lib/ecs.generated.ts",
8742 "line": 1712
8743 },
8744 "name": "role",
8745 "optional": true,
8746 "type": {
8747 "primitive": "string"
8748 }
8749 },
8750 {
8751 "abstract": true,
8752 "docs": {
8753 "custom": {
8754 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy"
8755 },
8756 "remarks": "There are two service scheduler strategies available:\n\n- `REPLICA` -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.\n- `DAEMON` -The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n\n> Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy.",
8757 "stability": "external",
8758 "summary": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) ."
8759 },
8760 "immutable": true,
8761 "locationInModule": {
8762 "filename": "lib/ecs.generated.ts",
8763 "line": 1726
8764 },
8765 "name": "schedulingStrategy",
8766 "optional": true,
8767 "type": {
8768 "primitive": "string"
8769 }
8770 },
8771 {
8772 "abstract": true,
8773 "docs": {
8774 "custom": {
8775 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename"
8776 },
8777 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.",
8778 "stability": "external",
8779 "summary": "The name of your service."
8780 },
8781 "immutable": true,
8782 "locationInModule": {
8783 "filename": "lib/ecs.generated.ts",
8784 "line": 1733
8785 },
8786 "name": "serviceName",
8787 "optional": true,
8788 "type": {
8789 "primitive": "string"
8790 }
8791 },
8792 {
8793 "abstract": true,
8794 "docs": {
8795 "custom": {
8796 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries"
8797 },
8798 "remarks": "> Each service may be associated with one service registry. Multiple service registries for each service isn't supported.",
8799 "stability": "external",
8800 "summary": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) ."
8801 },
8802 "immutable": true,
8803 "locationInModule": {
8804 "filename": "lib/ecs.generated.ts",
8805 "line": 1742
8806 },
8807 "name": "serviceRegistries",
8808 "optional": true,
8809 "type": {
8810 "union": {
8811 "types": [
8812 {
8813 "fqn": "@aws-cdk/core.IResolvable"
8814 },
8815 {
8816 "collection": {
8817 "elementtype": {
8818 "union": {
8819 "types": [
8820 {
8821 "fqn": "@aws-cdk/aws-ecs.CfnService.ServiceRegistryProperty"
8822 },
8823 {
8824 "fqn": "@aws-cdk/core.IResolvable"
8825 }
8826 ]
8827 }
8828 },
8829 "kind": "array"
8830 }
8831 }
8832 ]
8833 }
8834 }
8835 },
8836 {
8837 "abstract": true,
8838 "docs": {
8839 "custom": {
8840 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags"
8841 },
8842 "remarks": "Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
8843 "stability": "external",
8844 "summary": "The metadata that you apply to the service to help you categorize and organize them."
8845 },
8846 "immutable": true,
8847 "locationInModule": {
8848 "filename": "lib/ecs.generated.ts",
8849 "line": 1759
8850 },
8851 "name": "tags",
8852 "optional": true,
8853 "type": {
8854 "collection": {
8855 "elementtype": {
8856 "fqn": "@aws-cdk/core.CfnTag"
8857 },
8858 "kind": "array"
8859 }
8860 }
8861 },
8862 {
8863 "abstract": true,
8864 "docs": {
8865 "custom": {
8866 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition"
8867 },
8868 "remarks": "The `revision` is required in order for the resource to stabilize.\n\nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers.",
8869 "stability": "external",
8870 "summary": "The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service."
8871 },
8872 "immutable": true,
8873 "locationInModule": {
8874 "filename": "lib/ecs.generated.ts",
8875 "line": 1768
8876 },
8877 "name": "taskDefinition",
8878 "optional": true,
8879 "type": {
8880 "primitive": "string"
8881 }
8882 }
8883 ],
8884 "symbolId": "lib/ecs.generated:CfnServiceProps"
8885 },
8886 "@aws-cdk/aws-ecs.CfnTaskDefinition": {
8887 "assembly": "@aws-cdk/aws-ecs",
8888 "base": "@aws-cdk/core.CfnResource",
8889 "docs": {
8890 "custom": {
8891 "cloudformationResource": "AWS::ECS::TaskDefinition",
8892 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html",
8893 "exampleMetadata": "fixture=_generated"
8894 },
8895 "remarks": "The `AWS::ECS::TaskDefinition` resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS) task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.",
8896 "stability": "external",
8897 "summary": "A CloudFormation `AWS::ECS::TaskDefinition`.",
8898 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnTaskDefinition = new ecs.CfnTaskDefinition(this, 'MyCfnTaskDefinition', /* all optional props */ {\n containerDefinitions: [{\n command: ['command'],\n cpu: 123,\n dependsOn: [{\n condition: 'condition',\n containerName: 'containerName',\n }],\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: [{\n name: 'name',\n value: 'value',\n }],\n environmentFiles: [{\n type: 'type',\n value: 'value',\n }],\n essential: false,\n extraHosts: [{\n hostname: 'hostname',\n ipAddress: 'ipAddress',\n }],\n firelensConfiguration: {\n options: {\n optionsKey: 'options',\n },\n type: 'type',\n },\n healthCheck: {\n command: ['command'],\n interval: 123,\n retries: 123,\n startPeriod: 123,\n timeout: 123,\n },\n hostname: 'hostname',\n image: 'image',\n interactive: false,\n links: ['links'],\n linuxParameters: {\n capabilities: {\n add: ['add'],\n drop: ['drop'],\n },\n devices: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n permissions: ['permissions'],\n }],\n initProcessEnabled: false,\n maxSwap: 123,\n sharedMemorySize: 123,\n swappiness: 123,\n tmpfs: [{\n size: 123,\n\n // the properties below are optional\n containerPath: 'containerPath',\n mountOptions: ['mountOptions'],\n }],\n },\n logConfiguration: {\n logDriver: 'logDriver',\n\n // the properties below are optional\n options: {\n optionsKey: 'options',\n },\n secretOptions: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n },\n memory: 123,\n memoryReservation: 123,\n mountPoints: [{\n containerPath: 'containerPath',\n readOnly: false,\n sourceVolume: 'sourceVolume',\n }],\n name: 'name',\n portMappings: [{\n containerPort: 123,\n hostPort: 123,\n protocol: 'protocol',\n }],\n privileged: false,\n pseudoTerminal: false,\n readonlyRootFilesystem: false,\n repositoryCredentials: {\n credentialsParameter: 'credentialsParameter',\n },\n resourceRequirements: [{\n type: 'type',\n value: 'value',\n }],\n secrets: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n startTimeout: 123,\n stopTimeout: 123,\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n ulimits: [{\n hardLimit: 123,\n name: 'name',\n softLimit: 123,\n }],\n user: 'user',\n volumesFrom: [{\n readOnly: false,\n sourceContainer: 'sourceContainer',\n }],\n workingDirectory: 'workingDirectory',\n }],\n cpu: 'cpu',\n ephemeralStorage: {\n sizeInGiB: 123,\n },\n executionRoleArn: 'executionRoleArn',\n family: 'family',\n inferenceAccelerators: [{\n deviceName: 'deviceName',\n deviceType: 'deviceType',\n }],\n ipcMode: 'ipcMode',\n memory: 'memory',\n networkMode: 'networkMode',\n pidMode: 'pidMode',\n placementConstraints: [{\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n }],\n proxyConfiguration: {\n containerName: 'containerName',\n\n // the properties below are optional\n proxyConfigurationProperties: [{\n name: 'name',\n value: 'value',\n }],\n type: 'type',\n },\n requiresCompatibilities: ['requiresCompatibilities'],\n runtimePlatform: {\n cpuArchitecture: 'cpuArchitecture',\n operatingSystemFamily: 'operatingSystemFamily',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n taskRoleArn: 'taskRoleArn',\n volumes: [{\n dockerVolumeConfiguration: {\n autoprovision: false,\n driver: 'driver',\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n scope: 'scope',\n },\n efsVolumeConfiguration: {\n filesystemId: 'filesystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n },\n host: {\n sourcePath: 'sourcePath',\n },\n name: 'name',\n }],\n});"
8899 },
8900 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition",
8901 "initializer": {
8902 "docs": {
8903 "stability": "external",
8904 "summary": "Create a new `AWS::ECS::TaskDefinition`."
8905 },
8906 "locationInModule": {
8907 "filename": "lib/ecs.generated.ts",
8908 "line": 3580
8909 },
8910 "parameters": [
8911 {
8912 "docs": {
8913 "summary": "- scope in which this resource is defined."
8914 },
8915 "name": "scope",
8916 "type": {
8917 "fqn": "@aws-cdk/core.Construct"
8918 }
8919 },
8920 {
8921 "docs": {
8922 "summary": "- scoped id of the resource."
8923 },
8924 "name": "id",
8925 "type": {
8926 "primitive": "string"
8927 }
8928 },
8929 {
8930 "docs": {
8931 "summary": "- resource properties."
8932 },
8933 "name": "props",
8934 "optional": true,
8935 "type": {
8936 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinitionProps"
8937 }
8938 }
8939 ]
8940 },
8941 "interfaces": [
8942 "@aws-cdk/core.IInspectable"
8943 ],
8944 "kind": "class",
8945 "locationInModule": {
8946 "filename": "lib/ecs.generated.ts",
8947 "line": 3356
8948 },
8949 "methods": [
8950 {
8951 "docs": {
8952 "stability": "external",
8953 "summary": "Examines the CloudFormation resource and discloses attributes."
8954 },
8955 "locationInModule": {
8956 "filename": "lib/ecs.generated.ts",
8957 "line": 3609
8958 },
8959 "name": "inspect",
8960 "overrides": "@aws-cdk/core.IInspectable",
8961 "parameters": [
8962 {
8963 "docs": {
8964 "summary": "- tree inspector to collect and process attributes."
8965 },
8966 "name": "inspector",
8967 "type": {
8968 "fqn": "@aws-cdk/core.TreeInspector"
8969 }
8970 }
8971 ]
8972 },
8973 {
8974 "docs": {
8975 "stability": "external"
8976 },
8977 "locationInModule": {
8978 "filename": "lib/ecs.generated.ts",
8979 "line": 3636
8980 },
8981 "name": "renderProperties",
8982 "overrides": "@aws-cdk/core.CfnResource",
8983 "parameters": [
8984 {
8985 "name": "props",
8986 "type": {
8987 "collection": {
8988 "elementtype": {
8989 "primitive": "any"
8990 },
8991 "kind": "map"
8992 }
8993 }
8994 }
8995 ],
8996 "protected": true,
8997 "returns": {
8998 "type": {
8999 "collection": {
9000 "elementtype": {
9001 "primitive": "any"
9002 },
9003 "kind": "map"
9004 }
9005 }
9006 }
9007 }
9008 ],
9009 "name": "CfnTaskDefinition",
9010 "properties": [
9011 {
9012 "const": true,
9013 "docs": {
9014 "stability": "external",
9015 "summary": "The CloudFormation resource type name for this resource class."
9016 },
9017 "immutable": true,
9018 "locationInModule": {
9019 "filename": "lib/ecs.generated.ts",
9020 "line": 3360
9021 },
9022 "name": "CFN_RESOURCE_TYPE_NAME",
9023 "static": true,
9024 "type": {
9025 "primitive": "string"
9026 }
9027 },
9028 {
9029 "docs": {
9030 "custom": {
9031 "cloudformationAttribute": "TaskDefinitionArn"
9032 },
9033 "stability": "external"
9034 },
9035 "immutable": true,
9036 "locationInModule": {
9037 "filename": "lib/ecs.generated.ts",
9038 "line": 3385
9039 },
9040 "name": "attrTaskDefinitionArn",
9041 "type": {
9042 "primitive": "string"
9043 }
9044 },
9045 {
9046 "docs": {
9047 "stability": "external"
9048 },
9049 "immutable": true,
9050 "locationInModule": {
9051 "filename": "lib/ecs.generated.ts",
9052 "line": 3614
9053 },
9054 "name": "cfnProperties",
9055 "overrides": "@aws-cdk/core.CfnResource",
9056 "protected": true,
9057 "type": {
9058 "collection": {
9059 "elementtype": {
9060 "primitive": "any"
9061 },
9062 "kind": "map"
9063 }
9064 }
9065 },
9066 {
9067 "docs": {
9068 "custom": {
9069 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-tags"
9070 },
9071 "remarks": "Each tag consists of a key and an optional value. You define both of them.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
9072 "stability": "external",
9073 "summary": "The metadata that you apply to the task definition to help you categorize and organize them."
9074 },
9075 "immutable": true,
9076 "locationInModule": {
9077 "filename": "lib/ecs.generated.ts",
9078 "line": 3553
9079 },
9080 "name": "tags",
9081 "type": {
9082 "fqn": "@aws-cdk/core.TagManager"
9083 }
9084 },
9085 {
9086 "docs": {
9087 "custom": {
9088 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions"
9089 },
9090 "remarks": "For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide* .",
9091 "stability": "external",
9092 "summary": "A list of container definitions in JSON format that describe the different containers that make up your task."
9093 },
9094 "locationInModule": {
9095 "filename": "lib/ecs.generated.ts",
9096 "line": 3392
9097 },
9098 "name": "containerDefinitions",
9099 "optional": true,
9100 "type": {
9101 "union": {
9102 "types": [
9103 {
9104 "fqn": "@aws-cdk/core.IResolvable"
9105 },
9106 {
9107 "collection": {
9108 "elementtype": {
9109 "union": {
9110 "types": [
9111 {
9112 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty"
9113 },
9114 {
9115 "fqn": "@aws-cdk/core.IResolvable"
9116 }
9117 ]
9118 }
9119 },
9120 "kind": "array"
9121 }
9122 }
9123 ]
9124 }
9125 }
9126 },
9127 {
9128 "docs": {
9129 "custom": {
9130 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu"
9131 },
9132 "remarks": "If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the `memory` parameter.\n\nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n\n- 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n- 512 (.5 vCPU) - Available `memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n- 1024 (1 vCPU) - Available `memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n- 2048 (2 vCPU) - Available `memory` values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n- 4096 (4 vCPU) - Available `memory` values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)",
9133 "stability": "external",
9134 "summary": "The number of `cpu` units used by the task."
9135 },
9136 "locationInModule": {
9137 "filename": "lib/ecs.generated.ts",
9138 "line": 3407
9139 },
9140 "name": "cpu",
9141 "optional": true,
9142 "type": {
9143 "primitive": "string"
9144 }
9145 },
9146 {
9147 "docs": {
9148 "custom": {
9149 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ephemeralstorage"
9150 },
9151 "stability": "external",
9152 "summary": "The ephemeral storage settings to use for tasks run with the task definition."
9153 },
9154 "locationInModule": {
9155 "filename": "lib/ecs.generated.ts",
9156 "line": 3414
9157 },
9158 "name": "ephemeralStorage",
9159 "optional": true,
9160 "type": {
9161 "union": {
9162 "types": [
9163 {
9164 "fqn": "@aws-cdk/core.IResolvable"
9165 },
9166 {
9167 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EphemeralStorageProperty"
9168 }
9169 ]
9170 }
9171 }
9172 },
9173 {
9174 "docs": {
9175 "custom": {
9176 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn"
9177 },
9178 "remarks": "The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide* .",
9179 "stability": "external",
9180 "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf."
9181 },
9182 "locationInModule": {
9183 "filename": "lib/ecs.generated.ts",
9184 "line": 3421
9185 },
9186 "name": "executionRoleArn",
9187 "optional": true,
9188 "type": {
9189 "primitive": "string"
9190 }
9191 },
9192 {
9193 "docs": {
9194 "custom": {
9195 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family"
9196 },
9197 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n\nA family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n\n> To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.",
9198 "stability": "external",
9199 "summary": "The name of a family that this task definition is registered to."
9200 },
9201 "locationInModule": {
9202 "filename": "lib/ecs.generated.ts",
9203 "line": 3432
9204 },
9205 "name": "family",
9206 "optional": true,
9207 "type": {
9208 "primitive": "string"
9209 }
9210 },
9211 {
9212 "docs": {
9213 "custom": {
9214 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-inferenceaccelerators"
9215 },
9216 "stability": "external",
9217 "summary": "The Elastic Inference accelerators to use for the containers in the task."
9218 },
9219 "locationInModule": {
9220 "filename": "lib/ecs.generated.ts",
9221 "line": 3439
9222 },
9223 "name": "inferenceAccelerators",
9224 "optional": true,
9225 "type": {
9226 "union": {
9227 "types": [
9228 {
9229 "fqn": "@aws-cdk/core.IResolvable"
9230 },
9231 {
9232 "collection": {
9233 "elementtype": {
9234 "union": {
9235 "types": [
9236 {
9237 "fqn": "@aws-cdk/core.IResolvable"
9238 },
9239 {
9240 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.InferenceAcceleratorProperty"
9241 }
9242 ]
9243 }
9244 },
9245 "kind": "array"
9246 }
9247 }
9248 ]
9249 }
9250 }
9251 },
9252 {
9253 "docs": {
9254 "custom": {
9255 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ipcmode"
9256 },
9257 "remarks": "The valid values are `host` , `task` , or `none` . If `host` is specified, then all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same IPC resources. If `none` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference* .\n\nIf the `host` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/) .\n\nIf you are setting namespaced kernel parameters using `systemControls` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n- For tasks that use the `host` IPC mode, IPC namespace related `systemControls` are not supported.\n- For tasks that use the `task` IPC mode, IPC namespace related `systemControls` will apply to all containers within a task.\n\n> This parameter is not supported for Windows containers or tasks run on AWS Fargate .",
9258 "stability": "external",
9259 "summary": "The IPC resource namespace to use for the containers in the task."
9260 },
9261 "locationInModule": {
9262 "filename": "lib/ecs.generated.ts",
9263 "line": 3455
9264 },
9265 "name": "ipcMode",
9266 "optional": true,
9267 "type": {
9268 "primitive": "string"
9269 }
9270 },
9271 {
9272 "docs": {
9273 "custom": {
9274 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory"
9275 },
9276 "remarks": "If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html) .\n\nIf your tasks runs on AWS Fargate , this field is required. You must use one of the following values. The value you choose determines your range of valid values for the `cpu` parameter.\n\n- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256 (.25 vCPU)\n- 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available `cpu` values: 512 (.5 vCPU)\n- 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available `cpu` values: 1024 (1 vCPU)\n- Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available `cpu` values: 2048 (2 vCPU)\n- Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available `cpu` values: 4096 (4 vCPU)",
9277 "stability": "external",
9278 "summary": "The amount (in MiB) of memory used by the task."
9279 },
9280 "locationInModule": {
9281 "filename": "lib/ecs.generated.ts",
9282 "line": 3472
9283 },
9284 "name": "memory",
9285 "optional": true,
9286 "type": {
9287 "primitive": "string"
9288 }
9289 },
9290 {
9291 "docs": {
9292 "custom": {
9293 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode"
9294 },
9295 "remarks": "The valid values are `none` , `bridge` , `awsvpc` , and `host` . The default Docker network mode is `bridge` . If you are using the Fargate launch type, the `awsvpc` network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to `none` , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode.\n\nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port (for the `host` network mode) or the attached elastic network interface port (for the `awsvpc` network mode), so you cannot take advantage of dynamic host port mappings.\n\nIf the network mode is `awsvpc` , the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the `ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode.\n\nIf the network mode is `host` , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.\n\nDocker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the `<default>` network mode object.\n\nFor more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference* .",
9296 "stability": "external",
9297 "summary": "The Docker networking mode to use for the containers in the task."
9298 },
9299 "locationInModule": {
9300 "filename": "lib/ecs.generated.ts",
9301 "line": 3491
9302 },
9303 "name": "networkMode",
9304 "optional": true,
9305 "type": {
9306 "primitive": "string"
9307 }
9308 },
9309 {
9310 "docs": {
9311 "custom": {
9312 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-pidmode"
9313 },
9314 "remarks": "The valid values are `host` or `task` . If `host` is specified, then all containers within the tasks that specified the `host` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference* .\n\nIf the `host` PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/) .\n\n> This parameter is not supported for Windows containers or tasks run on AWS Fargate .",
9315 "stability": "external",
9316 "summary": "The process namespace to use for the containers in the task."
9317 },
9318 "locationInModule": {
9319 "filename": "lib/ecs.generated.ts",
9320 "line": 3502
9321 },
9322 "name": "pidMode",
9323 "optional": true,
9324 "type": {
9325 "primitive": "string"
9326 }
9327 },
9328 {
9329 "docs": {
9330 "custom": {
9331 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints"
9332 },
9333 "remarks": "> This parameter isn't supported for tasks run on AWS Fargate .",
9334 "stability": "external",
9335 "summary": "An array of placement constraint objects to use for tasks."
9336 },
9337 "locationInModule": {
9338 "filename": "lib/ecs.generated.ts",
9339 "line": 3511
9340 },
9341 "name": "placementConstraints",
9342 "optional": true,
9343 "type": {
9344 "union": {
9345 "types": [
9346 {
9347 "fqn": "@aws-cdk/core.IResolvable"
9348 },
9349 {
9350 "collection": {
9351 "elementtype": {
9352 "union": {
9353 "types": [
9354 {
9355 "fqn": "@aws-cdk/core.IResolvable"
9356 },
9357 {
9358 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty"
9359 }
9360 ]
9361 }
9362 },
9363 "kind": "array"
9364 }
9365 }
9366 ]
9367 }
9368 }
9369 },
9370 {
9371 "docs": {
9372 "custom": {
9373 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-proxyconfiguration"
9374 },
9375 "remarks": "Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the `ecs-init` package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .",
9376 "stability": "external",
9377 "summary": "The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy."
9378 },
9379 "locationInModule": {
9380 "filename": "lib/ecs.generated.ts",
9381 "line": 3520
9382 },
9383 "name": "proxyConfiguration",
9384 "optional": true,
9385 "type": {
9386 "union": {
9387 "types": [
9388 {
9389 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty"
9390 },
9391 {
9392 "fqn": "@aws-cdk/core.IResolvable"
9393 }
9394 ]
9395 }
9396 }
9397 },
9398 {
9399 "docs": {
9400 "custom": {
9401 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities"
9402 },
9403 "remarks": "To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter.",
9404 "stability": "external",
9405 "summary": "The task launch types the task definition was validated against."
9406 },
9407 "locationInModule": {
9408 "filename": "lib/ecs.generated.ts",
9409 "line": 3527
9410 },
9411 "name": "requiresCompatibilities",
9412 "optional": true,
9413 "type": {
9414 "collection": {
9415 "elementtype": {
9416 "primitive": "string"
9417 },
9418 "kind": "array"
9419 }
9420 }
9421 },
9422 {
9423 "docs": {
9424 "custom": {
9425 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-runtimeplatform"
9426 },
9427 "remarks": "A platform family is specified only for tasks using the Fargate launch type.\n\nWhen you specify a task definition in a service, this value must match the `runtimePlatform` value of the service.",
9428 "stability": "external",
9429 "summary": "The operating system that your tasks definitions run on."
9430 },
9431 "locationInModule": {
9432 "filename": "lib/ecs.generated.ts",
9433 "line": 3536
9434 },
9435 "name": "runtimePlatform",
9436 "optional": true,
9437 "type": {
9438 "union": {
9439 "types": [
9440 {
9441 "fqn": "@aws-cdk/core.IResolvable"
9442 },
9443 {
9444 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RuntimePlatformProperty"
9445 }
9446 ]
9447 }
9448 }
9449 },
9450 {
9451 "docs": {
9452 "custom": {
9453 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn"
9454 },
9455 "remarks": "For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIAM roles for tasks on Windows require that the `-EnableTaskIAMRole` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide* .",
9456 "stability": "external",
9457 "summary": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf."
9458 },
9459 "locationInModule": {
9460 "filename": "lib/ecs.generated.ts",
9461 "line": 3562
9462 },
9463 "name": "taskRoleArn",
9464 "optional": true,
9465 "type": {
9466 "primitive": "string"
9467 }
9468 },
9469 {
9470 "docs": {
9471 "custom": {
9472 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes"
9473 },
9474 "remarks": "For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> The `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate .",
9475 "stability": "external",
9476 "summary": "The list of data volume definitions for the task."
9477 },
9478 "locationInModule": {
9479 "filename": "lib/ecs.generated.ts",
9480 "line": 3571
9481 },
9482 "name": "volumes",
9483 "optional": true,
9484 "type": {
9485 "union": {
9486 "types": [
9487 {
9488 "fqn": "@aws-cdk/core.IResolvable"
9489 },
9490 {
9491 "collection": {
9492 "elementtype": {
9493 "union": {
9494 "types": [
9495 {
9496 "fqn": "@aws-cdk/core.IResolvable"
9497 },
9498 {
9499 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeProperty"
9500 }
9501 ]
9502 }
9503 },
9504 "kind": "array"
9505 }
9506 }
9507 ]
9508 }
9509 }
9510 }
9511 ],
9512 "symbolId": "lib/ecs.generated:CfnTaskDefinition"
9513 },
9514 "@aws-cdk/aws-ecs.CfnTaskDefinition.AuthorizationConfigProperty": {
9515 "assembly": "@aws-cdk/aws-ecs",
9516 "datatype": true,
9517 "docs": {
9518 "custom": {
9519 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html",
9520 "exampleMetadata": "fixture=_generated"
9521 },
9522 "stability": "external",
9523 "summary": "The authorization configuration details for the Amazon EFS file system.",
9524 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst authorizationConfigProperty: ecs.CfnTaskDefinition.AuthorizationConfigProperty = {\n accessPointId: 'accessPointId',\n iam: 'iam',\n};"
9525 },
9526 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.AuthorizationConfigProperty",
9527 "kind": "interface",
9528 "locationInModule": {
9529 "filename": "lib/ecs.generated.ts",
9530 "line": 3650
9531 },
9532 "name": "AuthorizationConfigProperty",
9533 "namespace": "CfnTaskDefinition",
9534 "properties": [
9535 {
9536 "abstract": true,
9537 "docs": {
9538 "custom": {
9539 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-accesspointid"
9540 },
9541 "remarks": "If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration` . For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide* .",
9542 "stability": "external",
9543 "summary": "The Amazon EFS access point ID to use."
9544 },
9545 "immutable": true,
9546 "locationInModule": {
9547 "filename": "lib/ecs.generated.ts",
9548 "line": 3656
9549 },
9550 "name": "accessPointId",
9551 "optional": true,
9552 "type": {
9553 "primitive": "string"
9554 }
9555 },
9556 {
9557 "abstract": true,
9558 "docs": {
9559 "custom": {
9560 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-iam"
9561 },
9562 "remarks": "If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration` . If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide* .",
9563 "stability": "external",
9564 "summary": "Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system."
9565 },
9566 "immutable": true,
9567 "locationInModule": {
9568 "filename": "lib/ecs.generated.ts",
9569 "line": 3662
9570 },
9571 "name": "iam",
9572 "optional": true,
9573 "type": {
9574 "primitive": "string"
9575 }
9576 }
9577 ],
9578 "symbolId": "lib/ecs.generated:CfnTaskDefinition.AuthorizationConfigProperty"
9579 },
9580 "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty": {
9581 "assembly": "@aws-cdk/aws-ecs",
9582 "datatype": true,
9583 "docs": {
9584 "custom": {
9585 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html",
9586 "exampleMetadata": "fixture=_generated"
9587 },
9588 "remarks": "Container definitions are used in task definitions to describe the different containers that are launched as part of a task.",
9589 "stability": "external",
9590 "summary": "The `ContainerDefinition` property specifies a container definition.",
9591 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst containerDefinitionProperty: ecs.CfnTaskDefinition.ContainerDefinitionProperty = {\n command: ['command'],\n cpu: 123,\n dependsOn: [{\n condition: 'condition',\n containerName: 'containerName',\n }],\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: [{\n name: 'name',\n value: 'value',\n }],\n environmentFiles: [{\n type: 'type',\n value: 'value',\n }],\n essential: false,\n extraHosts: [{\n hostname: 'hostname',\n ipAddress: 'ipAddress',\n }],\n firelensConfiguration: {\n options: {\n optionsKey: 'options',\n },\n type: 'type',\n },\n healthCheck: {\n command: ['command'],\n interval: 123,\n retries: 123,\n startPeriod: 123,\n timeout: 123,\n },\n hostname: 'hostname',\n image: 'image',\n interactive: false,\n links: ['links'],\n linuxParameters: {\n capabilities: {\n add: ['add'],\n drop: ['drop'],\n },\n devices: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n permissions: ['permissions'],\n }],\n initProcessEnabled: false,\n maxSwap: 123,\n sharedMemorySize: 123,\n swappiness: 123,\n tmpfs: [{\n size: 123,\n\n // the properties below are optional\n containerPath: 'containerPath',\n mountOptions: ['mountOptions'],\n }],\n },\n logConfiguration: {\n logDriver: 'logDriver',\n\n // the properties below are optional\n options: {\n optionsKey: 'options',\n },\n secretOptions: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n },\n memory: 123,\n memoryReservation: 123,\n mountPoints: [{\n containerPath: 'containerPath',\n readOnly: false,\n sourceVolume: 'sourceVolume',\n }],\n name: 'name',\n portMappings: [{\n containerPort: 123,\n hostPort: 123,\n protocol: 'protocol',\n }],\n privileged: false,\n pseudoTerminal: false,\n readonlyRootFilesystem: false,\n repositoryCredentials: {\n credentialsParameter: 'credentialsParameter',\n },\n resourceRequirements: [{\n type: 'type',\n value: 'value',\n }],\n secrets: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n startTimeout: 123,\n stopTimeout: 123,\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n ulimits: [{\n hardLimit: 123,\n name: 'name',\n softLimit: 123,\n }],\n user: 'user',\n volumesFrom: [{\n readOnly: false,\n sourceContainer: 'sourceContainer',\n }],\n workingDirectory: 'workingDirectory',\n};"
9592 },
9593 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty",
9594 "kind": "interface",
9595 "locationInModule": {
9596 "filename": "lib/ecs.generated.ts",
9597 "line": 3726
9598 },
9599 "name": "ContainerDefinitionProperty",
9600 "namespace": "CfnTaskDefinition",
9601 "properties": [
9602 {
9603 "abstract": true,
9604 "docs": {
9605 "custom": {
9606 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-command"
9607 },
9608 "remarks": "This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) . For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) . If there are multiple arguments, each argument is a separated string in the array.",
9609 "stability": "external",
9610 "summary": "The command that's passed to the container."
9611 },
9612 "immutable": true,
9613 "locationInModule": {
9614 "filename": "lib/ecs.generated.ts",
9615 "line": 3732
9616 },
9617 "name": "command",
9618 "optional": true,
9619 "type": {
9620 "collection": {
9621 "elementtype": {
9622 "primitive": "string"
9623 },
9624 "kind": "array"
9625 }
9626 }
9627 },
9628 {
9629 "abstract": true,
9630 "docs": {
9631 "custom": {
9632 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-cpu"
9633 },
9634 "remarks": "This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nThis field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level `cpu` value.\n\n> You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n\nLinux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n\nOn Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:\n\n- *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n- *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as `0` , which Windows interprets as 1% of one CPU.",
9635 "stability": "external",
9636 "summary": "The number of `cpu` units reserved for the container."
9637 },
9638 "immutable": true,
9639 "locationInModule": {
9640 "filename": "lib/ecs.generated.ts",
9641 "line": 3751
9642 },
9643 "name": "cpu",
9644 "optional": true,
9645 "type": {
9646 "primitive": "number"
9647 }
9648 },
9649 {
9650 "abstract": true,
9651 "docs": {
9652 "custom": {
9653 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dependson"
9654 },
9655 "remarks": "A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n\nFor tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide* . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor tasks using the Fargate launch type, the task or service requires the following platforms:\n\n- Linux platform version `1.3.0` or later.\n- Windows platform version `1.0.0` or later.",
9656 "stability": "external",
9657 "summary": "The dependencies defined for container startup and shutdown."
9658 },
9659 "immutable": true,
9660 "locationInModule": {
9661 "filename": "lib/ecs.generated.ts",
9662 "line": 3764
9663 },
9664 "name": "dependsOn",
9665 "optional": true,
9666 "type": {
9667 "union": {
9668 "types": [
9669 {
9670 "fqn": "@aws-cdk/core.IResolvable"
9671 },
9672 {
9673 "collection": {
9674 "elementtype": {
9675 "union": {
9676 "types": [
9677 {
9678 "fqn": "@aws-cdk/core.IResolvable"
9679 },
9680 {
9681 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDependencyProperty"
9682 }
9683 ]
9684 }
9685 },
9686 "kind": "array"
9687 }
9688 }
9689 ]
9690 }
9691 }
9692 },
9693 {
9694 "abstract": true,
9695 "docs": {
9696 "custom": {
9697 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-disablenetworking"
9698 },
9699 "remarks": "This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) .\n\n> This parameter is not supported for Windows containers.",
9700 "stability": "external",
9701 "summary": "When this parameter is true, networking is disabled within the container."
9702 },
9703 "immutable": true,
9704 "locationInModule": {
9705 "filename": "lib/ecs.generated.ts",
9706 "line": 3772
9707 },
9708 "name": "disableNetworking",
9709 "optional": true,
9710 "type": {
9711 "union": {
9712 "types": [
9713 {
9714 "primitive": "boolean"
9715 },
9716 {
9717 "fqn": "@aws-cdk/core.IResolvable"
9718 }
9719 ]
9720 }
9721 }
9722 },
9723 {
9724 "abstract": true,
9725 "docs": {
9726 "custom": {
9727 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnssearchdomains"
9728 },
9729 "remarks": "This parameter maps to `DnsSearch` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--dns-search` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter is not supported for Windows containers.",
9730 "stability": "external",
9731 "summary": "A list of DNS search domains that are presented to the container."
9732 },
9733 "immutable": true,
9734 "locationInModule": {
9735 "filename": "lib/ecs.generated.ts",
9736 "line": 3780
9737 },
9738 "name": "dnsSearchDomains",
9739 "optional": true,
9740 "type": {
9741 "collection": {
9742 "elementtype": {
9743 "primitive": "string"
9744 },
9745 "kind": "array"
9746 }
9747 }
9748 },
9749 {
9750 "abstract": true,
9751 "docs": {
9752 "custom": {
9753 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnsservers"
9754 },
9755 "remarks": "This parameter maps to `Dns` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--dns` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter is not supported for Windows containers.",
9756 "stability": "external",
9757 "summary": "A list of DNS servers that are presented to the container."
9758 },
9759 "immutable": true,
9760 "locationInModule": {
9761 "filename": "lib/ecs.generated.ts",
9762 "line": 3788
9763 },
9764 "name": "dnsServers",
9765 "optional": true,
9766 "type": {
9767 "collection": {
9768 "elementtype": {
9769 "primitive": "string"
9770 },
9771 "kind": "array"
9772 }
9773 }
9774 },
9775 {
9776 "abstract": true,
9777 "docs": {
9778 "custom": {
9779 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockerlabels"
9780 },
9781 "remarks": "This parameter maps to `Labels` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--label` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'`",
9782 "stability": "external",
9783 "summary": "A key/value map of labels to add to the container."
9784 },
9785 "immutable": true,
9786 "locationInModule": {
9787 "filename": "lib/ecs.generated.ts",
9788 "line": 3794
9789 },
9790 "name": "dockerLabels",
9791 "optional": true,
9792 "type": {
9793 "union": {
9794 "types": [
9795 {
9796 "fqn": "@aws-cdk/core.IResolvable"
9797 },
9798 {
9799 "collection": {
9800 "elementtype": {
9801 "primitive": "string"
9802 },
9803 "kind": "map"
9804 }
9805 }
9806 ]
9807 }
9808 }
9809 },
9810 {
9811 "abstract": true,
9812 "docs": {
9813 "custom": {
9814 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions"
9815 },
9816 "remarks": "This field isn't valid for containers in tasks using the Fargate launch type.\n\nWith Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nThis parameter maps to `SecurityOpt` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--security-opt` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> The Amazon ECS container agent running on a container instance must register with the `ECS_SELINUX_CAPABLE=true` or `ECS_APPARMOR_CAPABLE=true` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nValid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"",
9817 "stability": "external",
9818 "summary": "A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems."
9819 },
9820 "immutable": true,
9821 "locationInModule": {
9822 "filename": "lib/ecs.generated.ts",
9823 "line": 3810
9824 },
9825 "name": "dockerSecurityOptions",
9826 "optional": true,
9827 "type": {
9828 "collection": {
9829 "elementtype": {
9830 "primitive": "string"
9831 },
9832 "kind": "array"
9833 }
9834 }
9835 },
9836 {
9837 "abstract": true,
9838 "docs": {
9839 "custom": {
9840 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-entrypoint"
9841 },
9842 "remarks": "If you have problems using `entryPoint` , update your container agent or enter your commands and arguments as `command` array items instead.\n\nThe entry point that's passed to the container. This parameter maps to `Entrypoint` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--entrypoint` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) . For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint) .",
9843 "stability": "external",
9844 "summary": "> Early versions of the Amazon ECS container agent don't properly handle `entryPoint` parameters."
9845 },
9846 "immutable": true,
9847 "locationInModule": {
9848 "filename": "lib/ecs.generated.ts",
9849 "line": 3818
9850 },
9851 "name": "entryPoint",
9852 "optional": true,
9853 "type": {
9854 "collection": {
9855 "elementtype": {
9856 "primitive": "string"
9857 },
9858 "kind": "array"
9859 }
9860 }
9861 },
9862 {
9863 "abstract": true,
9864 "docs": {
9865 "custom": {
9866 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environment"
9867 },
9868 "remarks": "This parameter maps to `Env` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.",
9869 "stability": "external",
9870 "summary": "The environment variables to pass to a container."
9871 },
9872 "immutable": true,
9873 "locationInModule": {
9874 "filename": "lib/ecs.generated.ts",
9875 "line": 3826
9876 },
9877 "name": "environment",
9878 "optional": true,
9879 "type": {
9880 "union": {
9881 "types": [
9882 {
9883 "fqn": "@aws-cdk/core.IResolvable"
9884 },
9885 {
9886 "collection": {
9887 "elementtype": {
9888 "union": {
9889 "types": [
9890 {
9891 "fqn": "@aws-cdk/core.IResolvable"
9892 },
9893 {
9894 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.KeyValuePairProperty"
9895 }
9896 ]
9897 }
9898 },
9899 "kind": "array"
9900 }
9901 }
9902 ]
9903 }
9904 }
9905 },
9906 {
9907 "abstract": true,
9908 "docs": {
9909 "custom": {
9910 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environmentfiles"
9911 },
9912 "remarks": "This parameter maps to the `--env-file` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nYou can specify up to ten environment files. The file must have a `.env` file extension. Each line in an environment file contains an environment variable in `VARIABLE=VALUE` format. Lines beginning with `#` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/) .\n\nIf there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide* .",
9913 "stability": "external",
9914 "summary": "A list of files containing the environment variables to pass to a container."
9915 },
9916 "immutable": true,
9917 "locationInModule": {
9918 "filename": "lib/ecs.generated.ts",
9919 "line": 3836
9920 },
9921 "name": "environmentFiles",
9922 "optional": true,
9923 "type": {
9924 "union": {
9925 "types": [
9926 {
9927 "fqn": "@aws-cdk/core.IResolvable"
9928 },
9929 {
9930 "collection": {
9931 "elementtype": {
9932 "union": {
9933 "types": [
9934 {
9935 "fqn": "@aws-cdk/core.IResolvable"
9936 },
9937 {
9938 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EnvironmentFileProperty"
9939 }
9940 ]
9941 }
9942 },
9943 "kind": "array"
9944 }
9945 }
9946 ]
9947 }
9948 }
9949 },
9950 {
9951 "abstract": true,
9952 "docs": {
9953 "custom": {
9954 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-essential"
9955 },
9956 "remarks": "If the `essential` parameter of a container is marked as `false` , its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n\nAll tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide* .",
9957 "stability": "external",
9958 "summary": "If the `essential` parameter of a container is marked as `true` , and that container fails or stops for any reason, all other containers that are part of the task are stopped."
9959 },
9960 "immutable": true,
9961 "locationInModule": {
9962 "filename": "lib/ecs.generated.ts",
9963 "line": 3844
9964 },
9965 "name": "essential",
9966 "optional": true,
9967 "type": {
9968 "union": {
9969 "types": [
9970 {
9971 "primitive": "boolean"
9972 },
9973 {
9974 "fqn": "@aws-cdk/core.IResolvable"
9975 }
9976 ]
9977 }
9978 }
9979 },
9980 {
9981 "abstract": true,
9982 "docs": {
9983 "custom": {
9984 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-extrahosts"
9985 },
9986 "remarks": "This parameter maps to `ExtraHosts` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode.",
9987 "stability": "external",
9988 "summary": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container."
9989 },
9990 "immutable": true,
9991 "locationInModule": {
9992 "filename": "lib/ecs.generated.ts",
9993 "line": 3852
9994 },
9995 "name": "extraHosts",
9996 "optional": true,
9997 "type": {
9998 "union": {
9999 "types": [
10000 {
10001 "fqn": "@aws-cdk/core.IResolvable"
10002 },
10003 {
10004 "collection": {
10005 "elementtype": {
10006 "union": {
10007 "types": [
10008 {
10009 "fqn": "@aws-cdk/core.IResolvable"
10010 },
10011 {
10012 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HostEntryProperty"
10013 }
10014 ]
10015 }
10016 },
10017 "kind": "array"
10018 }
10019 }
10020 ]
10021 }
10022 }
10023 },
10024 {
10025 "abstract": true,
10026 "docs": {
10027 "custom": {
10028 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-firelensconfiguration"
10029 },
10030 "remarks": "This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide* .",
10031 "stability": "external",
10032 "summary": "The FireLens configuration for the container."
10033 },
10034 "immutable": true,
10035 "locationInModule": {
10036 "filename": "lib/ecs.generated.ts",
10037 "line": 3858
10038 },
10039 "name": "firelensConfiguration",
10040 "optional": true,
10041 "type": {
10042 "union": {
10043 "types": [
10044 {
10045 "fqn": "@aws-cdk/core.IResolvable"
10046 },
10047 {
10048 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.FirelensConfigurationProperty"
10049 }
10050 ]
10051 }
10052 }
10053 },
10054 {
10055 "abstract": true,
10056 "docs": {
10057 "custom": {
10058 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-healthcheck"
10059 },
10060 "remarks": "This parameter maps to `HealthCheck` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `HEALTHCHECK` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10061 "stability": "external",
10062 "summary": "The container health check command and associated configuration parameters for the container."
10063 },
10064 "immutable": true,
10065 "locationInModule": {
10066 "filename": "lib/ecs.generated.ts",
10067 "line": 3864
10068 },
10069 "name": "healthCheck",
10070 "optional": true,
10071 "type": {
10072 "union": {
10073 "types": [
10074 {
10075 "fqn": "@aws-cdk/core.IResolvable"
10076 },
10077 {
10078 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HealthCheckProperty"
10079 }
10080 ]
10081 }
10082 }
10083 },
10084 {
10085 "abstract": true,
10086 "docs": {
10087 "custom": {
10088 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-hostname"
10089 },
10090 "remarks": "This parameter maps to `Hostname` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--hostname` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> The `hostname` parameter is not supported if you're using the `awsvpc` network mode.",
10091 "stability": "external",
10092 "summary": "The hostname to use for your container."
10093 },
10094 "immutable": true,
10095 "locationInModule": {
10096 "filename": "lib/ecs.generated.ts",
10097 "line": 3872
10098 },
10099 "name": "hostname",
10100 "optional": true,
10101 "type": {
10102 "primitive": "string"
10103 }
10104 },
10105 {
10106 "abstract": true,
10107 "docs": {
10108 "custom": {
10109 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-image"
10110 },
10111 "remarks": "This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either `*repository-url* / *image* : *tag*` or `*repository-url* / *image* @ *digest*` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n- When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n- Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest` . For example, `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest` or `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE` .\n- Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo` ).\n- Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent` ).\n- Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu` ).",
10112 "stability": "external",
10113 "summary": "The image used to start a container."
10114 },
10115 "immutable": true,
10116 "locationInModule": {
10117 "filename": "lib/ecs.generated.ts",
10118 "line": 3884
10119 },
10120 "name": "image",
10121 "optional": true,
10122 "type": {
10123 "primitive": "string"
10124 }
10125 },
10126 {
10127 "abstract": true,
10128 "docs": {
10129 "custom": {
10130 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-interactive"
10131 },
10132 "remarks": "This parameter maps to `OpenStdin` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--interactive` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10133 "stability": "external",
10134 "summary": "When this parameter is `true` , you can deploy containerized applications that require `stdin` or a `tty` to be allocated."
10135 },
10136 "immutable": true,
10137 "locationInModule": {
10138 "filename": "lib/ecs.generated.ts",
10139 "line": 3890
10140 },
10141 "name": "interactive",
10142 "optional": true,
10143 "type": {
10144 "union": {
10145 "types": [
10146 {
10147 "primitive": "boolean"
10148 },
10149 {
10150 "fqn": "@aws-cdk/core.IResolvable"
10151 }
10152 ]
10153 }
10154 }
10155 },
10156 {
10157 "abstract": true,
10158 "docs": {
10159 "custom": {
10160 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-links"
10161 },
10162 "remarks": "This parameter is only supported if the network mode of a task definition is `bridge` . The `name:internalName` construct is analogous to `name:alias` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to `Links` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--link` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter is not supported for Windows containers. > Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.",
10163 "stability": "external",
10164 "summary": "The `links` parameter allows containers to communicate with each other without the need for port mappings."
10165 },
10166 "immutable": true,
10167 "locationInModule": {
10168 "filename": "lib/ecs.generated.ts",
10169 "line": 3898
10170 },
10171 "name": "links",
10172 "optional": true,
10173 "type": {
10174 "collection": {
10175 "elementtype": {
10176 "primitive": "string"
10177 },
10178 "kind": "array"
10179 }
10180 }
10181 },
10182 {
10183 "abstract": true,
10184 "docs": {
10185 "custom": {
10186 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-linuxparameters"
10187 },
10188 "remarks": "> This parameter is not supported for Windows containers.",
10189 "stability": "external",
10190 "summary": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) ."
10191 },
10192 "immutable": true,
10193 "locationInModule": {
10194 "filename": "lib/ecs.generated.ts",
10195 "line": 3906
10196 },
10197 "name": "linuxParameters",
10198 "optional": true,
10199 "type": {
10200 "union": {
10201 "types": [
10202 {
10203 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.LinuxParametersProperty"
10204 },
10205 {
10206 "fqn": "@aws-cdk/core.IResolvable"
10207 }
10208 ]
10209 }
10210 }
10211 },
10212 {
10213 "abstract": true,
10214 "docs": {
10215 "custom": {
10216 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration"
10217 },
10218 "remarks": "This parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n\n> Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'`\n\n> The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* .",
10219 "stability": "external",
10220 "summary": "The log configuration specification for the container."
10221 },
10222 "immutable": true,
10223 "locationInModule": {
10224 "filename": "lib/ecs.generated.ts",
10225 "line": 3920
10226 },
10227 "name": "logConfiguration",
10228 "optional": true,
10229 "type": {
10230 "union": {
10231 "types": [
10232 {
10233 "fqn": "@aws-cdk/core.IResolvable"
10234 },
10235 {
10236 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.LogConfigurationProperty"
10237 }
10238 ]
10239 }
10240 }
10241 },
10242 {
10243 "abstract": true,
10244 "docs": {
10245 "custom": {
10246 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memory"
10247 },
10248 "remarks": "If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task `memory` value, if one is specified. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nIf using the Fargate launch type, this parameter is optional.\n\nIf using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level `memory` and `memoryReservation` value, `memory` must be greater than `memoryReservation` . If you specify `memoryReservation` , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of `memory` is used.\n\nThe Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.",
10249 "stability": "external",
10250 "summary": "The amount (in MiB) of memory to present to the container."
10251 },
10252 "immutable": true,
10253 "locationInModule": {
10254 "filename": "lib/ecs.generated.ts",
10255 "line": 3934
10256 },
10257 "name": "memory",
10258 "optional": true,
10259 "type": {
10260 "primitive": "number"
10261 }
10262 },
10263 {
10264 "abstract": true,
10265 "docs": {
10266 "custom": {
10267 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memoryreservation"
10268 },
10269 "remarks": "When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nIf a task-level memory value is not specified, you must specify a non-zero integer for one or both of `memory` or `memoryReservation` in a container definition. If you specify both, `memory` must be greater than `memoryReservation` . If you specify `memoryReservation` , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of `memory` is used.\n\nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n\nThe Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers.",
10270 "stability": "external",
10271 "summary": "The soft limit (in MiB) of memory to reserve for the container."
10272 },
10273 "immutable": true,
10274 "locationInModule": {
10275 "filename": "lib/ecs.generated.ts",
10276 "line": 3946
10277 },
10278 "name": "memoryReservation",
10279 "optional": true,
10280 "type": {
10281 "primitive": "number"
10282 }
10283 },
10284 {
10285 "abstract": true,
10286 "docs": {
10287 "custom": {
10288 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints"
10289 },
10290 "remarks": "This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nWindows containers can mount whole directories on the same drive as `$env:ProgramData` . Windows containers can't mount directories on a different drive, and mount point can't be across drives.",
10291 "stability": "external",
10292 "summary": "The mount points for data volumes in your container."
10293 },
10294 "immutable": true,
10295 "locationInModule": {
10296 "filename": "lib/ecs.generated.ts",
10297 "line": 3956
10298 },
10299 "name": "mountPoints",
10300 "optional": true,
10301 "type": {
10302 "union": {
10303 "types": [
10304 {
10305 "fqn": "@aws-cdk/core.IResolvable"
10306 },
10307 {
10308 "collection": {
10309 "elementtype": {
10310 "union": {
10311 "types": [
10312 {
10313 "fqn": "@aws-cdk/core.IResolvable"
10314 },
10315 {
10316 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.MountPointProperty"
10317 }
10318 ]
10319 }
10320 },
10321 "kind": "array"
10322 }
10323 }
10324 ]
10325 }
10326 }
10327 },
10328 {
10329 "abstract": true,
10330 "docs": {
10331 "custom": {
10332 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-name"
10333 },
10334 "remarks": "If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to `name` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10335 "stability": "external",
10336 "summary": "The name of a container."
10337 },
10338 "immutable": true,
10339 "locationInModule": {
10340 "filename": "lib/ecs.generated.ts",
10341 "line": 3962
10342 },
10343 "name": "name",
10344 "optional": true,
10345 "type": {
10346 "primitive": "string"
10347 }
10348 },
10349 {
10350 "abstract": true,
10351 "docs": {
10352 "custom": {
10353 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-portmappings"
10354 },
10355 "remarks": "Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n\nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort` . The `hostPort` can be left blank or it must be the same value as the `containerPort` .\n\nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost` . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.\n\nThis parameter maps to `PortBindings` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . If the network mode of a task definition is set to `none` , then you can't specify port mappings. If the network mode of a task definition is set to `host` , then host ports must either be undefined or they must match the container port in the port mapping.\n\n> After a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.",
10356 "stability": "external",
10357 "summary": "The list of port mappings for the container."
10358 },
10359 "immutable": true,
10360 "locationInModule": {
10361 "filename": "lib/ecs.generated.ts",
10362 "line": 3976
10363 },
10364 "name": "portMappings",
10365 "optional": true,
10366 "type": {
10367 "union": {
10368 "types": [
10369 {
10370 "fqn": "@aws-cdk/core.IResolvable"
10371 },
10372 {
10373 "collection": {
10374 "elementtype": {
10375 "union": {
10376 "types": [
10377 {
10378 "fqn": "@aws-cdk/core.IResolvable"
10379 },
10380 {
10381 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.PortMappingProperty"
10382 }
10383 ]
10384 }
10385 },
10386 "kind": "array"
10387 }
10388 }
10389 ]
10390 }
10391 }
10392 },
10393 {
10394 "abstract": true,
10395 "docs": {
10396 "custom": {
10397 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-privileged"
10398 },
10399 "remarks": "This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter is not supported for Windows containers or tasks run on AWS Fargate .",
10400 "stability": "external",
10401 "summary": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user)."
10402 },
10403 "immutable": true,
10404 "locationInModule": {
10405 "filename": "lib/ecs.generated.ts",
10406 "line": 3984
10407 },
10408 "name": "privileged",
10409 "optional": true,
10410 "type": {
10411 "union": {
10412 "types": [
10413 {
10414 "primitive": "boolean"
10415 },
10416 {
10417 "fqn": "@aws-cdk/core.IResolvable"
10418 }
10419 ]
10420 }
10421 }
10422 },
10423 {
10424 "abstract": true,
10425 "docs": {
10426 "custom": {
10427 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-pseudoterminal"
10428 },
10429 "remarks": "This parameter maps to `Tty` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--tty` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10430 "stability": "external",
10431 "summary": "When this parameter is `true` , a TTY is allocated."
10432 },
10433 "immutable": true,
10434 "locationInModule": {
10435 "filename": "lib/ecs.generated.ts",
10436 "line": 3990
10437 },
10438 "name": "pseudoTerminal",
10439 "optional": true,
10440 "type": {
10441 "union": {
10442 "types": [
10443 {
10444 "primitive": "boolean"
10445 },
10446 {
10447 "fqn": "@aws-cdk/core.IResolvable"
10448 }
10449 ]
10450 }
10451 }
10452 },
10453 {
10454 "abstract": true,
10455 "docs": {
10456 "custom": {
10457 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-readonlyrootfilesystem"
10458 },
10459 "remarks": "This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--read-only` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> This parameter is not supported for Windows containers.",
10460 "stability": "external",
10461 "summary": "When this parameter is true, the container is given read-only access to its root file system."
10462 },
10463 "immutable": true,
10464 "locationInModule": {
10465 "filename": "lib/ecs.generated.ts",
10466 "line": 3998
10467 },
10468 "name": "readonlyRootFilesystem",
10469 "optional": true,
10470 "type": {
10471 "union": {
10472 "types": [
10473 {
10474 "primitive": "boolean"
10475 },
10476 {
10477 "fqn": "@aws-cdk/core.IResolvable"
10478 }
10479 ]
10480 }
10481 }
10482 },
10483 {
10484 "abstract": true,
10485 "docs": {
10486 "custom": {
10487 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-repositorycredentials"
10488 },
10489 "stability": "external",
10490 "summary": "The private repository authentication credentials to use."
10491 },
10492 "immutable": true,
10493 "locationInModule": {
10494 "filename": "lib/ecs.generated.ts",
10495 "line": 4004
10496 },
10497 "name": "repositoryCredentials",
10498 "optional": true,
10499 "type": {
10500 "union": {
10501 "types": [
10502 {
10503 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RepositoryCredentialsProperty"
10504 },
10505 {
10506 "fqn": "@aws-cdk/core.IResolvable"
10507 }
10508 ]
10509 }
10510 }
10511 },
10512 {
10513 "abstract": true,
10514 "docs": {
10515 "custom": {
10516 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-resourcerequirements"
10517 },
10518 "remarks": "The only supported resource is a GPU.",
10519 "stability": "external",
10520 "summary": "The type and amount of a resource to assign to a container."
10521 },
10522 "immutable": true,
10523 "locationInModule": {
10524 "filename": "lib/ecs.generated.ts",
10525 "line": 4010
10526 },
10527 "name": "resourceRequirements",
10528 "optional": true,
10529 "type": {
10530 "union": {
10531 "types": [
10532 {
10533 "fqn": "@aws-cdk/core.IResolvable"
10534 },
10535 {
10536 "collection": {
10537 "elementtype": {
10538 "union": {
10539 "types": [
10540 {
10541 "fqn": "@aws-cdk/core.IResolvable"
10542 },
10543 {
10544 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ResourceRequirementProperty"
10545 }
10546 ]
10547 }
10548 },
10549 "kind": "array"
10550 }
10551 }
10552 ]
10553 }
10554 }
10555 },
10556 {
10557 "abstract": true,
10558 "docs": {
10559 "custom": {
10560 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-secrets"
10561 },
10562 "remarks": "For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* .",
10563 "stability": "external",
10564 "summary": "The secrets to pass to the container."
10565 },
10566 "immutable": true,
10567 "locationInModule": {
10568 "filename": "lib/ecs.generated.ts",
10569 "line": 4016
10570 },
10571 "name": "secrets",
10572 "optional": true,
10573 "type": {
10574 "union": {
10575 "types": [
10576 {
10577 "fqn": "@aws-cdk/core.IResolvable"
10578 },
10579 {
10580 "collection": {
10581 "elementtype": {
10582 "union": {
10583 "types": [
10584 {
10585 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SecretProperty"
10586 },
10587 {
10588 "fqn": "@aws-cdk/core.IResolvable"
10589 }
10590 ]
10591 }
10592 },
10593 "kind": "array"
10594 }
10595 }
10596 ]
10597 }
10598 }
10599 },
10600 {
10601 "abstract": true,
10602 "docs": {
10603 "custom": {
10604 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-starttimeout"
10605 },
10606 "remarks": "For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a `COMPLETE` , `SUCCESS` , or `HEALTHY` status. If a `startTimeout` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a `STOPPED` state.\n\n> When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration variable is used, it's enforced independently from this start timeout value.\n\nFor tasks using the Fargate launch type, the task or service requires the following platforms:\n\n- Linux platform version `1.3.0` or later.\n- Windows platform version `1.0.0` or later.\n\nFor tasks using the EC2 launch type, your container instances require at least version `1.26.0` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide* . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version `1.26.0-1` of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .",
10607 "stability": "external",
10608 "summary": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container."
10609 },
10610 "immutable": true,
10611 "locationInModule": {
10612 "filename": "lib/ecs.generated.ts",
10613 "line": 4031
10614 },
10615 "name": "startTimeout",
10616 "optional": true,
10617 "type": {
10618 "primitive": "number"
10619 }
10620 },
10621 {
10622 "abstract": true,
10623 "docs": {
10624 "custom": {
10625 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-stoptimeout"
10626 },
10627 "remarks": "For tasks using the Fargate launch type, the task or service requires the following platforms:\n\n- Linux platform version `1.3.0` or later.\n- Windows platform version `1.0.0` or later.\n\nThe max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n\nFor tasks that use the EC2 launch type, if the `stopTimeout` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT` is used. If neither the `stopTimeout` parameter or the `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide* . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .",
10628 "stability": "external",
10629 "summary": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own."
10630 },
10631 "immutable": true,
10632 "locationInModule": {
10633 "filename": "lib/ecs.generated.ts",
10634 "line": 4046
10635 },
10636 "name": "stopTimeout",
10637 "optional": true,
10638 "type": {
10639 "primitive": "number"
10640 }
10641 },
10642 {
10643 "abstract": true,
10644 "docs": {
10645 "custom": {
10646 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-systemcontrols"
10647 },
10648 "remarks": "This parameter maps to `Sysctls` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--sysctl` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> We don't recommended that you specify network-related `systemControls` parameters for multiple containers in a single task that also uses either the `awsvpc` or `host` network modes. For tasks that use the `awsvpc` network mode, the container that's started last determines which `systemControls` parameters take effect. For tasks that use the `host` network mode, it changes the container instance's namespaced kernel parameters as well as the containers.",
10649 "stability": "external",
10650 "summary": "A list of namespaced kernel parameters to set in the container."
10651 },
10652 "immutable": true,
10653 "locationInModule": {
10654 "filename": "lib/ecs.generated.ts",
10655 "line": 4054
10656 },
10657 "name": "systemControls",
10658 "optional": true,
10659 "type": {
10660 "union": {
10661 "types": [
10662 {
10663 "fqn": "@aws-cdk/core.IResolvable"
10664 },
10665 {
10666 "collection": {
10667 "elementtype": {
10668 "union": {
10669 "types": [
10670 {
10671 "fqn": "@aws-cdk/core.IResolvable"
10672 },
10673 {
10674 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SystemControlProperty"
10675 }
10676 ]
10677 }
10678 },
10679 "kind": "array"
10680 }
10681 }
10682 ]
10683 }
10684 }
10685 },
10686 {
10687 "abstract": true,
10688 "docs": {
10689 "custom": {
10690 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-ulimits"
10691 },
10692 "remarks": "This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'`\n\n> This parameter is not supported for Windows containers.",
10693 "stability": "external",
10694 "summary": "A list of `ulimits` to set in the container."
10695 },
10696 "immutable": true,
10697 "locationInModule": {
10698 "filename": "lib/ecs.generated.ts",
10699 "line": 4062
10700 },
10701 "name": "ulimits",
10702 "optional": true,
10703 "type": {
10704 "union": {
10705 "types": [
10706 {
10707 "fqn": "@aws-cdk/core.IResolvable"
10708 },
10709 {
10710 "collection": {
10711 "elementtype": {
10712 "union": {
10713 "types": [
10714 {
10715 "fqn": "@aws-cdk/core.IResolvable"
10716 },
10717 {
10718 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.UlimitProperty"
10719 }
10720 ]
10721 }
10722 },
10723 "kind": "array"
10724 }
10725 }
10726 ]
10727 }
10728 }
10729 },
10730 {
10731 "abstract": true,
10732 "docs": {
10733 "custom": {
10734 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-user"
10735 },
10736 "remarks": "This parameter maps to `User` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--user` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> When running tasks using the `host` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n\nYou can specify the `user` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n\n- `user`\n- `user:group`\n- `uid`\n- `uid:gid`\n- `user:gid`\n- `uid:group`\n\n> This parameter is not supported for Windows containers.",
10737 "stability": "external",
10738 "summary": "The user to use inside the container."
10739 },
10740 "immutable": true,
10741 "locationInModule": {
10742 "filename": "lib/ecs.generated.ts",
10743 "line": 4081
10744 },
10745 "name": "user",
10746 "optional": true,
10747 "type": {
10748 "primitive": "string"
10749 }
10750 },
10751 {
10752 "abstract": true,
10753 "docs": {
10754 "custom": {
10755 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom"
10756 },
10757 "remarks": "This parameter maps to `VolumesFrom` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10758 "stability": "external",
10759 "summary": "Data volumes to mount from another container."
10760 },
10761 "immutable": true,
10762 "locationInModule": {
10763 "filename": "lib/ecs.generated.ts",
10764 "line": 4087
10765 },
10766 "name": "volumesFrom",
10767 "optional": true,
10768 "type": {
10769 "union": {
10770 "types": [
10771 {
10772 "fqn": "@aws-cdk/core.IResolvable"
10773 },
10774 {
10775 "collection": {
10776 "elementtype": {
10777 "union": {
10778 "types": [
10779 {
10780 "fqn": "@aws-cdk/core.IResolvable"
10781 },
10782 {
10783 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeFromProperty"
10784 }
10785 ]
10786 }
10787 },
10788 "kind": "array"
10789 }
10790 }
10791 ]
10792 }
10793 }
10794 },
10795 {
10796 "abstract": true,
10797 "docs": {
10798 "custom": {
10799 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-workingdirectory"
10800 },
10801 "remarks": "This parameter maps to `WorkingDir` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--workdir` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .",
10802 "stability": "external",
10803 "summary": "The working directory to run commands inside the container in."
10804 },
10805 "immutable": true,
10806 "locationInModule": {
10807 "filename": "lib/ecs.generated.ts",
10808 "line": 4093
10809 },
10810 "name": "workingDirectory",
10811 "optional": true,
10812 "type": {
10813 "primitive": "string"
10814 }
10815 }
10816 ],
10817 "symbolId": "lib/ecs.generated:CfnTaskDefinition.ContainerDefinitionProperty"
10818 },
10819 "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDependencyProperty": {
10820 "assembly": "@aws-cdk/aws-ecs",
10821 "datatype": true,
10822 "docs": {
10823 "custom": {
10824 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html",
10825 "exampleMetadata": "fixture=_generated"
10826 },
10827 "remarks": "A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide* . If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.",
10828 "stability": "external",
10829 "summary": "The `ContainerDependency` property specifies the dependencies defined for container startup and shutdown.",
10830 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst containerDependencyProperty: ecs.CfnTaskDefinition.ContainerDependencyProperty = {\n condition: 'condition',\n containerName: 'containerName',\n};"
10831 },
10832 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDependencyProperty",
10833 "kind": "interface",
10834 "locationInModule": {
10835 "filename": "lib/ecs.generated.ts",
10836 "line": 4272
10837 },
10838 "name": "ContainerDependencyProperty",
10839 "namespace": "CfnTaskDefinition",
10840 "properties": [
10841 {
10842 "abstract": true,
10843 "docs": {
10844 "custom": {
10845 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-condition"
10846 },
10847 "remarks": "- `START` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n- `COMPLETE` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n- `SUCCESS` - This condition is the same as `COMPLETE` , but it also requires that the container exits with a `zero` status. This condition can't be set on an essential container.\n- `HEALTHY` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.",
10848 "stability": "external",
10849 "summary": "The dependency condition of the container. The following are the available conditions and their behavior:."
10850 },
10851 "immutable": true,
10852 "locationInModule": {
10853 "filename": "lib/ecs.generated.ts",
10854 "line": 4283
10855 },
10856 "name": "condition",
10857 "optional": true,
10858 "type": {
10859 "primitive": "string"
10860 }
10861 },
10862 {
10863 "abstract": true,
10864 "docs": {
10865 "custom": {
10866 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-containername"
10867 },
10868 "stability": "external",
10869 "summary": "The name of a container."
10870 },
10871 "immutable": true,
10872 "locationInModule": {
10873 "filename": "lib/ecs.generated.ts",
10874 "line": 4289
10875 },
10876 "name": "containerName",
10877 "optional": true,
10878 "type": {
10879 "primitive": "string"
10880 }
10881 }
10882 ],
10883 "symbolId": "lib/ecs.generated:CfnTaskDefinition.ContainerDependencyProperty"
10884 },
10885 "@aws-cdk/aws-ecs.CfnTaskDefinition.DeviceProperty": {
10886 "assembly": "@aws-cdk/aws-ecs",
10887 "datatype": true,
10888 "docs": {
10889 "custom": {
10890 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html",
10891 "exampleMetadata": "fixture=_generated"
10892 },
10893 "stability": "external",
10894 "summary": "The `Device` property specifies an object representing a container instance host device.",
10895 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst deviceProperty: ecs.CfnTaskDefinition.DeviceProperty = {\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n permissions: ['permissions'],\n};"
10896 },
10897 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.DeviceProperty",
10898 "kind": "interface",
10899 "locationInModule": {
10900 "filename": "lib/ecs.generated.ts",
10901 "line": 4353
10902 },
10903 "name": "DeviceProperty",
10904 "namespace": "CfnTaskDefinition",
10905 "properties": [
10906 {
10907 "abstract": true,
10908 "docs": {
10909 "custom": {
10910 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-containerpath"
10911 },
10912 "stability": "external",
10913 "summary": "The path inside the container at which to expose the host device."
10914 },
10915 "immutable": true,
10916 "locationInModule": {
10917 "filename": "lib/ecs.generated.ts",
10918 "line": 4359
10919 },
10920 "name": "containerPath",
10921 "optional": true,
10922 "type": {
10923 "primitive": "string"
10924 }
10925 },
10926 {
10927 "abstract": true,
10928 "docs": {
10929 "custom": {
10930 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-hostpath"
10931 },
10932 "stability": "external",
10933 "summary": "The path for the device on the host container instance."
10934 },
10935 "immutable": true,
10936 "locationInModule": {
10937 "filename": "lib/ecs.generated.ts",
10938 "line": 4365
10939 },
10940 "name": "hostPath",
10941 "optional": true,
10942 "type": {
10943 "primitive": "string"
10944 }
10945 },
10946 {
10947 "abstract": true,
10948 "docs": {
10949 "custom": {
10950 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-permissions"
10951 },
10952 "remarks": "By default, the container has permissions for `read` , `write` , and `mknod` for the device.",
10953 "stability": "external",
10954 "summary": "The explicit permissions to provide to the container for the device."
10955 },
10956 "immutable": true,
10957 "locationInModule": {
10958 "filename": "lib/ecs.generated.ts",
10959 "line": 4371
10960 },
10961 "name": "permissions",
10962 "optional": true,
10963 "type": {
10964 "collection": {
10965 "elementtype": {
10966 "primitive": "string"
10967 },
10968 "kind": "array"
10969 }
10970 }
10971 }
10972 ],
10973 "symbolId": "lib/ecs.generated:CfnTaskDefinition.DeviceProperty"
10974 },
10975 "@aws-cdk/aws-ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty": {
10976 "assembly": "@aws-cdk/aws-ecs",
10977 "datatype": true,
10978 "docs": {
10979 "custom": {
10980 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html",
10981 "exampleMetadata": "fixture=_generated"
10982 },
10983 "remarks": "Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the `local` driver. To use bind mounts, specify a `host` instead.",
10984 "stability": "external",
10985 "summary": "The `DockerVolumeConfiguration` property specifies a Docker volume configuration and is used when you use Docker volumes.",
10986 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst dockerVolumeConfigurationProperty: ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty = {\n autoprovision: false,\n driver: 'driver',\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n scope: 'scope',\n};"
10987 },
10988 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty",
10989 "kind": "interface",
10990 "locationInModule": {
10991 "filename": "lib/ecs.generated.ts",
10992 "line": 4438
10993 },
10994 "name": "DockerVolumeConfigurationProperty",
10995 "namespace": "CfnTaskDefinition",
10996 "properties": [
10997 {
10998 "abstract": true,
10999 "docs": {
11000 "custom": {
11001 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-autoprovision"
11002 },
11003 "remarks": "> This field is only used if the `scope` is `shared` .",
11004 "stability": "external",
11005 "summary": "If this value is `true` , the Docker volume is created if it doesn't already exist."
11006 },
11007 "immutable": true,
11008 "locationInModule": {
11009 "filename": "lib/ecs.generated.ts",
11010 "line": 4446
11011 },
11012 "name": "autoprovision",
11013 "optional": true,
11014 "type": {
11015 "union": {
11016 "types": [
11017 {
11018 "primitive": "boolean"
11019 },
11020 {
11021 "fqn": "@aws-cdk/core.IResolvable"
11022 }
11023 ]
11024 }
11025 }
11026 },
11027 {
11028 "abstract": true,
11029 "docs": {
11030 "custom": {
11031 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver"
11032 },
11033 "remarks": "The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use `docker plugin ls` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery) . This parameter maps to `Driver` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `xxdriver` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/) .",
11034 "stability": "external",
11035 "summary": "The Docker volume driver to use."
11036 },
11037 "immutable": true,
11038 "locationInModule": {
11039 "filename": "lib/ecs.generated.ts",
11040 "line": 4452
11041 },
11042 "name": "driver",
11043 "optional": true,
11044 "type": {
11045 "primitive": "string"
11046 }
11047 },
11048 {
11049 "abstract": true,
11050 "docs": {
11051 "custom": {
11052 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts"
11053 },
11054 "remarks": "This parameter maps to `DriverOpts` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `xxopt` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/) .",
11055 "stability": "external",
11056 "summary": "A map of Docker driver-specific options passed through."
11057 },
11058 "immutable": true,
11059 "locationInModule": {
11060 "filename": "lib/ecs.generated.ts",
11061 "line": 4458
11062 },
11063 "name": "driverOpts",
11064 "optional": true,
11065 "type": {
11066 "union": {
11067 "types": [
11068 {
11069 "fqn": "@aws-cdk/core.IResolvable"
11070 },
11071 {
11072 "collection": {
11073 "elementtype": {
11074 "primitive": "string"
11075 },
11076 "kind": "map"
11077 }
11078 }
11079 ]
11080 }
11081 }
11082 },
11083 {
11084 "abstract": true,
11085 "docs": {
11086 "custom": {
11087 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels"
11088 },
11089 "remarks": "This parameter maps to `Labels` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `xxlabel` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/) .",
11090 "stability": "external",
11091 "summary": "Custom metadata to add to your Docker volume."
11092 },
11093 "immutable": true,
11094 "locationInModule": {
11095 "filename": "lib/ecs.generated.ts",
11096 "line": 4464
11097 },
11098 "name": "labels",
11099 "optional": true,
11100 "type": {
11101 "union": {
11102 "types": [
11103 {
11104 "fqn": "@aws-cdk/core.IResolvable"
11105 },
11106 {
11107 "collection": {
11108 "elementtype": {
11109 "primitive": "string"
11110 },
11111 "kind": "map"
11112 }
11113 }
11114 ]
11115 }
11116 }
11117 },
11118 {
11119 "abstract": true,
11120 "docs": {
11121 "custom": {
11122 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-scope"
11123 },
11124 "remarks": "Docker volumes that are scoped to a `task` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as `shared` persist after the task stops.",
11125 "stability": "external",
11126 "summary": "The scope for the Docker volume that determines its lifecycle."
11127 },
11128 "immutable": true,
11129 "locationInModule": {
11130 "filename": "lib/ecs.generated.ts",
11131 "line": 4470
11132 },
11133 "name": "scope",
11134 "optional": true,
11135 "type": {
11136 "primitive": "string"
11137 }
11138 }
11139 ],
11140 "symbolId": "lib/ecs.generated:CfnTaskDefinition.DockerVolumeConfigurationProperty"
11141 },
11142 "@aws-cdk/aws-ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty": {
11143 "assembly": "@aws-cdk/aws-ecs",
11144 "datatype": true,
11145 "docs": {
11146 "custom": {
11147 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html",
11148 "exampleMetadata": "fixture=_generated"
11149 },
11150 "remarks": "For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide* .",
11151 "stability": "external",
11152 "summary": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage.",
11153 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst eFSVolumeConfigurationProperty: ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty = {\n filesystemId: 'filesystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n};"
11154 },
11155 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty",
11156 "kind": "interface",
11157 "locationInModule": {
11158 "filename": "lib/ecs.generated.ts",
11159 "line": 4543
11160 },
11161 "name": "EFSVolumeConfigurationProperty",
11162 "namespace": "CfnTaskDefinition",
11163 "properties": [
11164 {
11165 "abstract": true,
11166 "docs": {
11167 "custom": {
11168 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-filesystemid"
11169 },
11170 "stability": "external",
11171 "summary": "The Amazon EFS file system ID to use."
11172 },
11173 "immutable": true,
11174 "locationInModule": {
11175 "filename": "lib/ecs.generated.ts",
11176 "line": 4555
11177 },
11178 "name": "filesystemId",
11179 "type": {
11180 "primitive": "string"
11181 }
11182 },
11183 {
11184 "abstract": true,
11185 "docs": {
11186 "custom": {
11187 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-authorizationconfig"
11188 },
11189 "stability": "external",
11190 "summary": "The authorization configuration details for the Amazon EFS file system."
11191 },
11192 "immutable": true,
11193 "locationInModule": {
11194 "filename": "lib/ecs.generated.ts",
11195 "line": 4549
11196 },
11197 "name": "authorizationConfig",
11198 "optional": true,
11199 "type": {
11200 "union": {
11201 "types": [
11202 {
11203 "fqn": "@aws-cdk/core.IResolvable"
11204 },
11205 {
11206 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.AuthorizationConfigProperty"
11207 }
11208 ]
11209 }
11210 }
11211 },
11212 {
11213 "abstract": true,
11214 "docs": {
11215 "custom": {
11216 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-rootdirectory"
11217 },
11218 "remarks": "If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying `/` will have the same effect as omitting this parameter.\n\n> If an EFS access point is specified in the `authorizationConfig` , the root directory parameter must either be omitted or set to `/` which will enforce the path set on the EFS access point.",
11219 "stability": "external",
11220 "summary": "The directory within the Amazon EFS file system to mount as the root directory inside the host."
11221 },
11222 "immutable": true,
11223 "locationInModule": {
11224 "filename": "lib/ecs.generated.ts",
11225 "line": 4563
11226 },
11227 "name": "rootDirectory",
11228 "optional": true,
11229 "type": {
11230 "primitive": "string"
11231 }
11232 },
11233 {
11234 "abstract": true,
11235 "docs": {
11236 "custom": {
11237 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryption"
11238 },
11239 "remarks": "Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide* .",
11240 "stability": "external",
11241 "summary": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server."
11242 },
11243 "immutable": true,
11244 "locationInModule": {
11245 "filename": "lib/ecs.generated.ts",
11246 "line": 4569
11247 },
11248 "name": "transitEncryption",
11249 "optional": true,
11250 "type": {
11251 "primitive": "string"
11252 }
11253 },
11254 {
11255 "abstract": true,
11256 "docs": {
11257 "custom": {
11258 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryptionport"
11259 },
11260 "remarks": "If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide* .",
11261 "stability": "external",
11262 "summary": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server."
11263 },
11264 "immutable": true,
11265 "locationInModule": {
11266 "filename": "lib/ecs.generated.ts",
11267 "line": 4575
11268 },
11269 "name": "transitEncryptionPort",
11270 "optional": true,
11271 "type": {
11272 "primitive": "number"
11273 }
11274 }
11275 ],
11276 "symbolId": "lib/ecs.generated:CfnTaskDefinition.EFSVolumeConfigurationProperty"
11277 },
11278 "@aws-cdk/aws-ecs.CfnTaskDefinition.EnvironmentFileProperty": {
11279 "assembly": "@aws-cdk/aws-ecs",
11280 "datatype": true,
11281 "docs": {
11282 "custom": {
11283 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html",
11284 "exampleMetadata": "fixture=_generated"
11285 },
11286 "remarks": "You can specify up to ten environment files. The file must have a `.env` file extension. Each line in an environment file should contain an environment variable in `VARIABLE=VALUE` format. Lines beginning with `#` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/) .\n\nIf there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying environment variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nThis parameter is only supported for tasks hosted on Fargate using the following platform versions:\n\n- Linux platform version `1.4.0` or later.\n- Windows platform version `1.0.0` or later.",
11287 "stability": "external",
11288 "summary": "A list of files containing the environment variables to pass to a container.",
11289 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst environmentFileProperty: ecs.CfnTaskDefinition.EnvironmentFileProperty = {\n type: 'type',\n value: 'value',\n};"
11290 },
11291 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EnvironmentFileProperty",
11292 "kind": "interface",
11293 "locationInModule": {
11294 "filename": "lib/ecs.generated.ts",
11295 "line": 4656
11296 },
11297 "name": "EnvironmentFileProperty",
11298 "namespace": "CfnTaskDefinition",
11299 "properties": [
11300 {
11301 "abstract": true,
11302 "docs": {
11303 "custom": {
11304 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-type"
11305 },
11306 "remarks": "The only supported value is `s3` .",
11307 "stability": "external",
11308 "summary": "The file type to use."
11309 },
11310 "immutable": true,
11311 "locationInModule": {
11312 "filename": "lib/ecs.generated.ts",
11313 "line": 4662
11314 },
11315 "name": "type",
11316 "optional": true,
11317 "type": {
11318 "primitive": "string"
11319 }
11320 },
11321 {
11322 "abstract": true,
11323 "docs": {
11324 "custom": {
11325 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-value"
11326 },
11327 "stability": "external",
11328 "summary": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file."
11329 },
11330 "immutable": true,
11331 "locationInModule": {
11332 "filename": "lib/ecs.generated.ts",
11333 "line": 4668
11334 },
11335 "name": "value",
11336 "optional": true,
11337 "type": {
11338 "primitive": "string"
11339 }
11340 }
11341 ],
11342 "symbolId": "lib/ecs.generated:CfnTaskDefinition.EnvironmentFileProperty"
11343 },
11344 "@aws-cdk/aws-ecs.CfnTaskDefinition.EphemeralStorageProperty": {
11345 "assembly": "@aws-cdk/aws-ecs",
11346 "datatype": true,
11347 "docs": {
11348 "custom": {
11349 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ephemeralstorage.html",
11350 "exampleMetadata": "fixture=_generated"
11351 },
11352 "remarks": "This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate . For more information, see [Fargate task storage](https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the *Amazon ECS User Guide for AWS Fargate* .\n\n> This parameter is only supported for tasks hosted on Fargate using Linux platform version `1.4.0` or later. This parameter is not supported for Windows containers on Fargate.",
11353 "stability": "external",
11354 "summary": "The amount of ephemeral storage to allocate for the task.",
11355 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst ephemeralStorageProperty: ecs.CfnTaskDefinition.EphemeralStorageProperty = {\n sizeInGiB: 123,\n};"
11356 },
11357 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EphemeralStorageProperty",
11358 "kind": "interface",
11359 "locationInModule": {
11360 "filename": "lib/ecs.generated.ts",
11361 "line": 4734
11362 },
11363 "name": "EphemeralStorageProperty",
11364 "namespace": "CfnTaskDefinition",
11365 "properties": [
11366 {
11367 "abstract": true,
11368 "docs": {
11369 "custom": {
11370 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ephemeralstorage.html#cfn-ecs-taskdefinition-ephemeralstorage-sizeingib"
11371 },
11372 "remarks": "The minimum supported value is `21` GiB and the maximum supported value is `200` GiB.",
11373 "stability": "external",
11374 "summary": "The total amount, in GiB, of ephemeral storage to set for the task."
11375 },
11376 "immutable": true,
11377 "locationInModule": {
11378 "filename": "lib/ecs.generated.ts",
11379 "line": 4740
11380 },
11381 "name": "sizeInGiB",
11382 "optional": true,
11383 "type": {
11384 "primitive": "number"
11385 }
11386 }
11387 ],
11388 "symbolId": "lib/ecs.generated:CfnTaskDefinition.EphemeralStorageProperty"
11389 },
11390 "@aws-cdk/aws-ecs.CfnTaskDefinition.FirelensConfigurationProperty": {
11391 "assembly": "@aws-cdk/aws-ecs",
11392 "datatype": true,
11393 "docs": {
11394 "custom": {
11395 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html",
11396 "exampleMetadata": "fixture=_generated"
11397 },
11398 "remarks": "This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide* .",
11399 "stability": "external",
11400 "summary": "The FireLens configuration for the container.",
11401 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst firelensConfigurationProperty: ecs.CfnTaskDefinition.FirelensConfigurationProperty = {\n options: {\n optionsKey: 'options',\n },\n type: 'type',\n};"
11402 },
11403 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.FirelensConfigurationProperty",
11404 "kind": "interface",
11405 "locationInModule": {
11406 "filename": "lib/ecs.generated.ts",
11407 "line": 4801
11408 },
11409 "name": "FirelensConfigurationProperty",
11410 "namespace": "CfnTaskDefinition",
11411 "properties": [
11412 {
11413 "abstract": true,
11414 "docs": {
11415 "custom": {
11416 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-options"
11417 },
11418 "remarks": "This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n\nIf specified, valid option keys are:\n\n- `enable-ecs-log-metadata` , which can be `true` or `false`\n- `config-file-type` , which can be `s3` or `file`\n- `config-file-value` , which is either an S3 ARN or a file path",
11419 "stability": "external",
11420 "summary": "The options to use when configuring the log router."
11421 },
11422 "immutable": true,
11423 "locationInModule": {
11424 "filename": "lib/ecs.generated.ts",
11425 "line": 4813
11426 },
11427 "name": "options",
11428 "optional": true,
11429 "type": {
11430 "union": {
11431 "types": [
11432 {
11433 "fqn": "@aws-cdk/core.IResolvable"
11434 },
11435 {
11436 "collection": {
11437 "elementtype": {
11438 "primitive": "string"
11439 },
11440 "kind": "map"
11441 }
11442 }
11443 ]
11444 }
11445 }
11446 },
11447 {
11448 "abstract": true,
11449 "docs": {
11450 "custom": {
11451 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-type"
11452 },
11453 "remarks": "The valid values are `fluentd` or `fluentbit` .",
11454 "stability": "external",
11455 "summary": "The log router to use."
11456 },
11457 "immutable": true,
11458 "locationInModule": {
11459 "filename": "lib/ecs.generated.ts",
11460 "line": 4819
11461 },
11462 "name": "type",
11463 "optional": true,
11464 "type": {
11465 "primitive": "string"
11466 }
11467 }
11468 ],
11469 "symbolId": "lib/ecs.generated:CfnTaskDefinition.FirelensConfigurationProperty"
11470 },
11471 "@aws-cdk/aws-ecs.CfnTaskDefinition.HealthCheckProperty": {
11472 "assembly": "@aws-cdk/aws-ecs",
11473 "datatype": true,
11474 "docs": {
11475 "custom": {
11476 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html",
11477 "exampleMetadata": "fixture=_generated"
11478 },
11479 "remarks": "Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).\n\nThe following are notes about container health check support:\n\n- Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) .\n- Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) .\n- Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.",
11480 "stability": "external",
11481 "summary": "The `HealthCheck` property specifies an object representing a container health check.",
11482 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst healthCheckProperty: ecs.CfnTaskDefinition.HealthCheckProperty = {\n command: ['command'],\n interval: 123,\n retries: 123,\n startPeriod: 123,\n timeout: 123,\n};"
11483 },
11484 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HealthCheckProperty",
11485 "kind": "interface",
11486 "locationInModule": {
11487 "filename": "lib/ecs.generated.ts",
11488 "line": 4889
11489 },
11490 "name": "HealthCheckProperty",
11491 "namespace": "CfnTaskDefinition",
11492 "properties": [
11493 {
11494 "abstract": true,
11495 "docs": {
11496 "custom": {
11497 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command"
11498 },
11499 "remarks": "The string array must start with `CMD` to execute the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell.\n\nWhen you use the AWS Management Console JSON panel, the AWS Command Line Interface , or the APIs, enclose the list of commands in brackets.\n\n`[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`\n\nYou don't need to include the brackets when you use the AWS Management Console.\n\n`\"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\"`\n\nAn exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see `HealthCheck` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) .",
11500 "stability": "external",
11501 "summary": "A string array representing the command that the container runs to determine if it is healthy."
11502 },
11503 "immutable": true,
11504 "locationInModule": {
11505 "filename": "lib/ecs.generated.ts",
11506 "line": 4905
11507 },
11508 "name": "command",
11509 "optional": true,
11510 "type": {
11511 "collection": {
11512 "elementtype": {
11513 "primitive": "string"
11514 },
11515 "kind": "array"
11516 }
11517 }
11518 },
11519 {
11520 "abstract": true,
11521 "docs": {
11522 "custom": {
11523 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval"
11524 },
11525 "remarks": "You may specify between 5 and 300 seconds. The default value is 30 seconds.",
11526 "stability": "external",
11527 "summary": "The time period in seconds between each health check execution."
11528 },
11529 "immutable": true,
11530 "locationInModule": {
11531 "filename": "lib/ecs.generated.ts",
11532 "line": 4911
11533 },
11534 "name": "interval",
11535 "optional": true,
11536 "type": {
11537 "primitive": "number"
11538 }
11539 },
11540 {
11541 "abstract": true,
11542 "docs": {
11543 "custom": {
11544 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries"
11545 },
11546 "remarks": "You may specify between 1 and 10 retries. The default value is 3.",
11547 "stability": "external",
11548 "summary": "The number of times to retry a failed health check before the container is considered unhealthy."
11549 },
11550 "immutable": true,
11551 "locationInModule": {
11552 "filename": "lib/ecs.generated.ts",
11553 "line": 4917
11554 },
11555 "name": "retries",
11556 "optional": true,
11557 "type": {
11558 "primitive": "number"
11559 }
11560 },
11561 {
11562 "abstract": true,
11563 "docs": {
11564 "custom": {
11565 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod"
11566 },
11567 "remarks": "You can specify between 0 and 300 seconds. By default, the `startPeriod` is disabled.\n\n> If a health check succeeds within the `startPeriod` , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.",
11568 "stability": "external",
11569 "summary": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries."
11570 },
11571 "immutable": true,
11572 "locationInModule": {
11573 "filename": "lib/ecs.generated.ts",
11574 "line": 4925
11575 },
11576 "name": "startPeriod",
11577 "optional": true,
11578 "type": {
11579 "primitive": "number"
11580 }
11581 },
11582 {
11583 "abstract": true,
11584 "docs": {
11585 "custom": {
11586 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout"
11587 },
11588 "remarks": "You may specify between 2 and 60 seconds. The default value is 5.",
11589 "stability": "external",
11590 "summary": "The time period in seconds to wait for a health check to succeed before it is considered a failure."
11591 },
11592 "immutable": true,
11593 "locationInModule": {
11594 "filename": "lib/ecs.generated.ts",
11595 "line": 4931
11596 },
11597 "name": "timeout",
11598 "optional": true,
11599 "type": {
11600 "primitive": "number"
11601 }
11602 }
11603 ],
11604 "symbolId": "lib/ecs.generated:CfnTaskDefinition.HealthCheckProperty"
11605 },
11606 "@aws-cdk/aws-ecs.CfnTaskDefinition.HostEntryProperty": {
11607 "assembly": "@aws-cdk/aws-ecs",
11608 "datatype": true,
11609 "docs": {
11610 "custom": {
11611 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html",
11612 "exampleMetadata": "fixture=_generated"
11613 },
11614 "stability": "external",
11615 "summary": "The `HostEntry` property specifies a hostname and an IP address that are added to the `/etc/hosts` file of a container through the `extraHosts` parameter of its `ContainerDefinition` resource.",
11616 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst hostEntryProperty: ecs.CfnTaskDefinition.HostEntryProperty = {\n hostname: 'hostname',\n ipAddress: 'ipAddress',\n};"
11617 },
11618 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HostEntryProperty",
11619 "kind": "interface",
11620 "locationInModule": {
11621 "filename": "lib/ecs.generated.ts",
11622 "line": 5004
11623 },
11624 "name": "HostEntryProperty",
11625 "namespace": "CfnTaskDefinition",
11626 "properties": [
11627 {
11628 "abstract": true,
11629 "docs": {
11630 "custom": {
11631 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-hostname"
11632 },
11633 "stability": "external",
11634 "summary": "The hostname to use in the `/etc/hosts` entry."
11635 },
11636 "immutable": true,
11637 "locationInModule": {
11638 "filename": "lib/ecs.generated.ts",
11639 "line": 5010
11640 },
11641 "name": "hostname",
11642 "optional": true,
11643 "type": {
11644 "primitive": "string"
11645 }
11646 },
11647 {
11648 "abstract": true,
11649 "docs": {
11650 "custom": {
11651 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-ipaddress"
11652 },
11653 "stability": "external",
11654 "summary": "The IP address to use in the `/etc/hosts` entry."
11655 },
11656 "immutable": true,
11657 "locationInModule": {
11658 "filename": "lib/ecs.generated.ts",
11659 "line": 5016
11660 },
11661 "name": "ipAddress",
11662 "optional": true,
11663 "type": {
11664 "primitive": "string"
11665 }
11666 }
11667 ],
11668 "symbolId": "lib/ecs.generated:CfnTaskDefinition.HostEntryProperty"
11669 },
11670 "@aws-cdk/aws-ecs.CfnTaskDefinition.HostVolumePropertiesProperty": {
11671 "assembly": "@aws-cdk/aws-ecs",
11672 "datatype": true,
11673 "docs": {
11674 "custom": {
11675 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html",
11676 "exampleMetadata": "fixture=_generated"
11677 },
11678 "stability": "external",
11679 "summary": "The `HostVolumeProperties` property specifies details on a container instance bind mount host volume.",
11680 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst hostVolumePropertiesProperty: ecs.CfnTaskDefinition.HostVolumePropertiesProperty = {\n sourcePath: 'sourcePath',\n};"
11681 },
11682 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HostVolumePropertiesProperty",
11683 "kind": "interface",
11684 "locationInModule": {
11685 "filename": "lib/ecs.generated.ts",
11686 "line": 5080
11687 },
11688 "name": "HostVolumePropertiesProperty",
11689 "namespace": "CfnTaskDefinition",
11690 "properties": [
11691 {
11692 "abstract": true,
11693 "docs": {
11694 "custom": {
11695 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html#cfn-ecs-taskdefinition-volumes-host-sourcepath"
11696 },
11697 "remarks": "If this parameter is empty, then the Docker daemon has assigned a host path for you. If the `host` parameter contains a `sourcePath` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the `sourcePath` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n\nIf you're using the Fargate launch type, the `sourcePath` parameter is not supported.",
11698 "stability": "external",
11699 "summary": "When the `host` parameter is used, specify a `sourcePath` to declare the path on the host container instance that's presented to the container."
11700 },
11701 "immutable": true,
11702 "locationInModule": {
11703 "filename": "lib/ecs.generated.ts",
11704 "line": 5088
11705 },
11706 "name": "sourcePath",
11707 "optional": true,
11708 "type": {
11709 "primitive": "string"
11710 }
11711 }
11712 ],
11713 "symbolId": "lib/ecs.generated:CfnTaskDefinition.HostVolumePropertiesProperty"
11714 },
11715 "@aws-cdk/aws-ecs.CfnTaskDefinition.InferenceAcceleratorProperty": {
11716 "assembly": "@aws-cdk/aws-ecs",
11717 "datatype": true,
11718 "docs": {
11719 "custom": {
11720 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html",
11721 "exampleMetadata": "fixture=_generated"
11722 },
11723 "remarks": "For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html) in the *Amazon Elastic Container Service Developer Guide* .",
11724 "stability": "external",
11725 "summary": "Details on an Elastic Inference accelerator.",
11726 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst inferenceAcceleratorProperty: ecs.CfnTaskDefinition.InferenceAcceleratorProperty = {\n deviceName: 'deviceName',\n deviceType: 'deviceType',\n};"
11727 },
11728 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.InferenceAcceleratorProperty",
11729 "kind": "interface",
11730 "locationInModule": {
11731 "filename": "lib/ecs.generated.ts",
11732 "line": 5149
11733 },
11734 "name": "InferenceAcceleratorProperty",
11735 "namespace": "CfnTaskDefinition",
11736 "properties": [
11737 {
11738 "abstract": true,
11739 "docs": {
11740 "custom": {
11741 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicename"
11742 },
11743 "remarks": "The `deviceName` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html) .",
11744 "stability": "external",
11745 "summary": "The Elastic Inference accelerator device name."
11746 },
11747 "immutable": true,
11748 "locationInModule": {
11749 "filename": "lib/ecs.generated.ts",
11750 "line": 5155
11751 },
11752 "name": "deviceName",
11753 "optional": true,
11754 "type": {
11755 "primitive": "string"
11756 }
11757 },
11758 {
11759 "abstract": true,
11760 "docs": {
11761 "custom": {
11762 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicetype"
11763 },
11764 "stability": "external",
11765 "summary": "The Elastic Inference accelerator type to use."
11766 },
11767 "immutable": true,
11768 "locationInModule": {
11769 "filename": "lib/ecs.generated.ts",
11770 "line": 5161
11771 },
11772 "name": "deviceType",
11773 "optional": true,
11774 "type": {
11775 "primitive": "string"
11776 }
11777 }
11778 ],
11779 "symbolId": "lib/ecs.generated:CfnTaskDefinition.InferenceAcceleratorProperty"
11780 },
11781 "@aws-cdk/aws-ecs.CfnTaskDefinition.KernelCapabilitiesProperty": {
11782 "assembly": "@aws-cdk/aws-ecs",
11783 "datatype": true,
11784 "docs": {
11785 "custom": {
11786 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html",
11787 "exampleMetadata": "fixture=_generated"
11788 },
11789 "remarks": "For more information on the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference* . For more detailed information on these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.",
11790 "stability": "external",
11791 "summary": "The `KernelCapabilities` property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker.",
11792 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst kernelCapabilitiesProperty: ecs.CfnTaskDefinition.KernelCapabilitiesProperty = {\n add: ['add'],\n drop: ['drop'],\n};"
11793 },
11794 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.KernelCapabilitiesProperty",
11795 "kind": "interface",
11796 "locationInModule": {
11797 "filename": "lib/ecs.generated.ts",
11798 "line": 5225
11799 },
11800 "name": "KernelCapabilitiesProperty",
11801 "namespace": "CfnTaskDefinition",
11802 "properties": [
11803 {
11804 "abstract": true,
11805 "docs": {
11806 "custom": {
11807 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-add"
11808 },
11809 "remarks": "This parameter maps to `CapAdd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--cap-add` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> Tasks launched on AWS Fargate only support adding the `SYS_PTRACE` kernel capability.\n\nValid values: `\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"`",
11810 "stability": "external",
11811 "summary": "The Linux capabilities for the container that have been added to the default configuration provided by Docker."
11812 },
11813 "immutable": true,
11814 "locationInModule": {
11815 "filename": "lib/ecs.generated.ts",
11816 "line": 5235
11817 },
11818 "name": "add",
11819 "optional": true,
11820 "type": {
11821 "collection": {
11822 "elementtype": {
11823 "primitive": "string"
11824 },
11825 "kind": "array"
11826 }
11827 }
11828 },
11829 {
11830 "abstract": true,
11831 "docs": {
11832 "custom": {
11833 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-drop"
11834 },
11835 "remarks": "This parameter maps to `CapDrop` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--cap-drop` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nValid values: `\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"`",
11836 "stability": "external",
11837 "summary": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker."
11838 },
11839 "immutable": true,
11840 "locationInModule": {
11841 "filename": "lib/ecs.generated.ts",
11842 "line": 5243
11843 },
11844 "name": "drop",
11845 "optional": true,
11846 "type": {
11847 "collection": {
11848 "elementtype": {
11849 "primitive": "string"
11850 },
11851 "kind": "array"
11852 }
11853 }
11854 }
11855 ],
11856 "symbolId": "lib/ecs.generated:CfnTaskDefinition.KernelCapabilitiesProperty"
11857 },
11858 "@aws-cdk/aws-ecs.CfnTaskDefinition.KeyValuePairProperty": {
11859 "assembly": "@aws-cdk/aws-ecs",
11860 "datatype": true,
11861 "docs": {
11862 "custom": {
11863 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html",
11864 "exampleMetadata": "fixture=_generated"
11865 },
11866 "stability": "external",
11867 "summary": "The `KeyValuePair` property specifies a key-value pair object.",
11868 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst keyValuePairProperty: ecs.CfnTaskDefinition.KeyValuePairProperty = {\n name: 'name',\n value: 'value',\n};"
11869 },
11870 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.KeyValuePairProperty",
11871 "kind": "interface",
11872 "locationInModule": {
11873 "filename": "lib/ecs.generated.ts",
11874 "line": 5307
11875 },
11876 "name": "KeyValuePairProperty",
11877 "namespace": "CfnTaskDefinition",
11878 "properties": [
11879 {
11880 "abstract": true,
11881 "docs": {
11882 "custom": {
11883 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-name"
11884 },
11885 "remarks": "For environment variables, this is the name of the environment variable.",
11886 "stability": "external",
11887 "summary": "The name of the key-value pair."
11888 },
11889 "immutable": true,
11890 "locationInModule": {
11891 "filename": "lib/ecs.generated.ts",
11892 "line": 5313
11893 },
11894 "name": "name",
11895 "optional": true,
11896 "type": {
11897 "primitive": "string"
11898 }
11899 },
11900 {
11901 "abstract": true,
11902 "docs": {
11903 "custom": {
11904 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-value"
11905 },
11906 "remarks": "For environment variables, this is the value of the environment variable.",
11907 "stability": "external",
11908 "summary": "The value of the key-value pair."
11909 },
11910 "immutable": true,
11911 "locationInModule": {
11912 "filename": "lib/ecs.generated.ts",
11913 "line": 5319
11914 },
11915 "name": "value",
11916 "optional": true,
11917 "type": {
11918 "primitive": "string"
11919 }
11920 }
11921 ],
11922 "symbolId": "lib/ecs.generated:CfnTaskDefinition.KeyValuePairProperty"
11923 },
11924 "@aws-cdk/aws-ecs.CfnTaskDefinition.LinuxParametersProperty": {
11925 "assembly": "@aws-cdk/aws-ecs",
11926 "datatype": true,
11927 "docs": {
11928 "custom": {
11929 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html",
11930 "exampleMetadata": "fixture=_generated"
11931 },
11932 "stability": "external",
11933 "summary": "The `LinuxParameters` property specifies Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) .",
11934 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst linuxParametersProperty: ecs.CfnTaskDefinition.LinuxParametersProperty = {\n capabilities: {\n add: ['add'],\n drop: ['drop'],\n },\n devices: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n permissions: ['permissions'],\n }],\n initProcessEnabled: false,\n maxSwap: 123,\n sharedMemorySize: 123,\n swappiness: 123,\n tmpfs: [{\n size: 123,\n\n // the properties below are optional\n containerPath: 'containerPath',\n mountOptions: ['mountOptions'],\n }],\n};"
11935 },
11936 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.LinuxParametersProperty",
11937 "kind": "interface",
11938 "locationInModule": {
11939 "filename": "lib/ecs.generated.ts",
11940 "line": 5383
11941 },
11942 "name": "LinuxParametersProperty",
11943 "namespace": "CfnTaskDefinition",
11944 "properties": [
11945 {
11946 "abstract": true,
11947 "docs": {
11948 "custom": {
11949 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities"
11950 },
11951 "remarks": "> For tasks that use the Fargate launch type, `capabilities` is supported for all platform versions but the `add` parameter is only supported if using platform version 1.4.0 or later.",
11952 "stability": "external",
11953 "summary": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker."
11954 },
11955 "immutable": true,
11956 "locationInModule": {
11957 "filename": "lib/ecs.generated.ts",
11958 "line": 5391
11959 },
11960 "name": "capabilities",
11961 "optional": true,
11962 "type": {
11963 "union": {
11964 "types": [
11965 {
11966 "fqn": "@aws-cdk/core.IResolvable"
11967 },
11968 {
11969 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.KernelCapabilitiesProperty"
11970 }
11971 ]
11972 }
11973 }
11974 },
11975 {
11976 "abstract": true,
11977 "docs": {
11978 "custom": {
11979 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-devices"
11980 },
11981 "remarks": "This parameter maps to `Devices` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--device` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> If you're using tasks that use the Fargate launch type, the `devices` parameter isn't supported.",
11982 "stability": "external",
11983 "summary": "Any host devices to expose to the container."
11984 },
11985 "immutable": true,
11986 "locationInModule": {
11987 "filename": "lib/ecs.generated.ts",
11988 "line": 5399
11989 },
11990 "name": "devices",
11991 "optional": true,
11992 "type": {
11993 "union": {
11994 "types": [
11995 {
11996 "fqn": "@aws-cdk/core.IResolvable"
11997 },
11998 {
11999 "collection": {
12000 "elementtype": {
12001 "union": {
12002 "types": [
12003 {
12004 "fqn": "@aws-cdk/core.IResolvable"
12005 },
12006 {
12007 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.DeviceProperty"
12008 }
12009 ]
12010 }
12011 },
12012 "kind": "array"
12013 }
12014 }
12015 ]
12016 }
12017 }
12018 },
12019 {
12020 "abstract": true,
12021 "docs": {
12022 "custom": {
12023 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-initprocessenabled"
12024 },
12025 "remarks": "This parameter maps to the `--init` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'`",
12026 "stability": "external",
12027 "summary": "Run an `init` process inside the container that forwards signals and reaps processes."
12028 },
12029 "immutable": true,
12030 "locationInModule": {
12031 "filename": "lib/ecs.generated.ts",
12032 "line": 5405
12033 },
12034 "name": "initProcessEnabled",
12035 "optional": true,
12036 "type": {
12037 "union": {
12038 "types": [
12039 {
12040 "primitive": "boolean"
12041 },
12042 {
12043 "fqn": "@aws-cdk/core.IResolvable"
12044 }
12045 ]
12046 }
12047 }
12048 },
12049 {
12050 "abstract": true,
12051 "docs": {
12052 "custom": {
12053 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-maxswap"
12054 },
12055 "remarks": "This parameter will be translated to the `--memory-swap` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the `maxSwap` value.\n\nIf a `maxSwap` value of `0` is specified, the container will not use swap. Accepted values are `0` or any positive integer. If the `maxSwap` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A `maxSwap` value must be set for the `swappiness` parameter to be used.\n\n> If you're using tasks that use the Fargate launch type, the `maxSwap` parameter isn't supported.",
12056 "stability": "external",
12057 "summary": "The total amount of swap memory (in MiB) a container can use."
12058 },
12059 "immutable": true,
12060 "locationInModule": {
12061 "filename": "lib/ecs.generated.ts",
12062 "line": 5415
12063 },
12064 "name": "maxSwap",
12065 "optional": true,
12066 "type": {
12067 "primitive": "number"
12068 }
12069 },
12070 {
12071 "abstract": true,
12072 "docs": {
12073 "custom": {
12074 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-sharedmemorysize"
12075 },
12076 "remarks": "This parameter maps to the `--shm-size` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> If you are using tasks that use the Fargate launch type, the `sharedMemorySize` parameter is not supported.",
12077 "stability": "external",
12078 "summary": "The value for the size (in MiB) of the `/dev/shm` volume."
12079 },
12080 "immutable": true,
12081 "locationInModule": {
12082 "filename": "lib/ecs.generated.ts",
12083 "line": 5423
12084 },
12085 "name": "sharedMemorySize",
12086 "optional": true,
12087 "type": {
12088 "primitive": "number"
12089 }
12090 },
12091 {
12092 "abstract": true,
12093 "docs": {
12094 "custom": {
12095 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-swappiness"
12096 },
12097 "remarks": "A `swappiness` value of `0` will cause swapping to not happen unless absolutely necessary. A `swappiness` value of `100` will cause pages to be swapped very aggressively. Accepted values are whole numbers between `0` and `100` . If the `swappiness` parameter is not specified, a default value of `60` is used. If a value is not specified for `maxSwap` then this parameter is ignored. This parameter maps to the `--memory-swappiness` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> If you're using tasks that use the Fargate launch type, the `swappiness` parameter isn't supported.",
12098 "stability": "external",
12099 "summary": "This allows you to tune a container's memory swappiness behavior."
12100 },
12101 "immutable": true,
12102 "locationInModule": {
12103 "filename": "lib/ecs.generated.ts",
12104 "line": 5431
12105 },
12106 "name": "swappiness",
12107 "optional": true,
12108 "type": {
12109 "primitive": "number"
12110 }
12111 },
12112 {
12113 "abstract": true,
12114 "docs": {
12115 "custom": {
12116 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-tmpfs"
12117 },
12118 "remarks": "This parameter maps to the `--tmpfs` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n> If you're using tasks that use the Fargate launch type, the `tmpfs` parameter isn't supported.",
12119 "stability": "external",
12120 "summary": "The container path, mount options, and size (in MiB) of the tmpfs mount."
12121 },
12122 "immutable": true,
12123 "locationInModule": {
12124 "filename": "lib/ecs.generated.ts",
12125 "line": 5439
12126 },
12127 "name": "tmpfs",
12128 "optional": true,
12129 "type": {
12130 "union": {
12131 "types": [
12132 {
12133 "fqn": "@aws-cdk/core.IResolvable"
12134 },
12135 {
12136 "collection": {
12137 "elementtype": {
12138 "union": {
12139 "types": [
12140 {
12141 "fqn": "@aws-cdk/core.IResolvable"
12142 },
12143 {
12144 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.TmpfsProperty"
12145 }
12146 ]
12147 }
12148 },
12149 "kind": "array"
12150 }
12151 }
12152 ]
12153 }
12154 }
12155 }
12156 ],
12157 "symbolId": "lib/ecs.generated:CfnTaskDefinition.LinuxParametersProperty"
12158 },
12159 "@aws-cdk/aws-ecs.CfnTaskDefinition.LogConfigurationProperty": {
12160 "assembly": "@aws-cdk/aws-ecs",
12161 "datatype": true,
12162 "docs": {
12163 "custom": {
12164 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html",
12165 "exampleMetadata": "fixture=_generated"
12166 },
12167 "stability": "external",
12168 "summary": "The `LogConfiguration` property specifies log configuration options to send to a custom log driver for the container.",
12169 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst logConfigurationProperty: ecs.CfnTaskDefinition.LogConfigurationProperty = {\n logDriver: 'logDriver',\n\n // the properties below are optional\n options: {\n optionsKey: 'options',\n },\n secretOptions: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n};"
12170 },
12171 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.LogConfigurationProperty",
12172 "kind": "interface",
12173 "locationInModule": {
12174 "filename": "lib/ecs.generated.ts",
12175 "line": 5518
12176 },
12177 "name": "LogConfigurationProperty",
12178 "namespace": "CfnTaskDefinition",
12179 "properties": [
12180 {
12181 "abstract": true,
12182 "docs": {
12183 "custom": {
12184 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-logdriver"
12185 },
12186 "remarks": "For tasks on AWS Fargate , the supported log drivers are `awslogs` , `splunk` , and `awsfirelens` .\n\nFor tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` , `logentries` , `syslog` , `splunk` , and `awsfirelens` .\n\nFor more information about using the `awslogs` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor more information about using the `awsfirelens` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.",
12187 "stability": "external",
12188 "summary": "The log driver to use for the container."
12189 },
12190 "immutable": true,
12191 "locationInModule": {
12192 "filename": "lib/ecs.generated.ts",
12193 "line": 5534
12194 },
12195 "name": "logDriver",
12196 "type": {
12197 "primitive": "string"
12198 }
12199 },
12200 {
12201 "abstract": true,
12202 "docs": {
12203 "custom": {
12204 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-options"
12205 },
12206 "remarks": "This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'`",
12207 "stability": "external",
12208 "summary": "The configuration options to send to the log driver."
12209 },
12210 "immutable": true,
12211 "locationInModule": {
12212 "filename": "lib/ecs.generated.ts",
12213 "line": 5540
12214 },
12215 "name": "options",
12216 "optional": true,
12217 "type": {
12218 "union": {
12219 "types": [
12220 {
12221 "fqn": "@aws-cdk/core.IResolvable"
12222 },
12223 {
12224 "collection": {
12225 "elementtype": {
12226 "primitive": "string"
12227 },
12228 "kind": "map"
12229 }
12230 }
12231 ]
12232 }
12233 }
12234 },
12235 {
12236 "abstract": true,
12237 "docs": {
12238 "custom": {
12239 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-secretoptions"
12240 },
12241 "remarks": "For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* .",
12242 "stability": "external",
12243 "summary": "The secrets to pass to the log configuration."
12244 },
12245 "immutable": true,
12246 "locationInModule": {
12247 "filename": "lib/ecs.generated.ts",
12248 "line": 5546
12249 },
12250 "name": "secretOptions",
12251 "optional": true,
12252 "type": {
12253 "union": {
12254 "types": [
12255 {
12256 "fqn": "@aws-cdk/core.IResolvable"
12257 },
12258 {
12259 "collection": {
12260 "elementtype": {
12261 "union": {
12262 "types": [
12263 {
12264 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SecretProperty"
12265 },
12266 {
12267 "fqn": "@aws-cdk/core.IResolvable"
12268 }
12269 ]
12270 }
12271 },
12272 "kind": "array"
12273 }
12274 }
12275 ]
12276 }
12277 }
12278 }
12279 ],
12280 "symbolId": "lib/ecs.generated:CfnTaskDefinition.LogConfigurationProperty"
12281 },
12282 "@aws-cdk/aws-ecs.CfnTaskDefinition.MountPointProperty": {
12283 "assembly": "@aws-cdk/aws-ecs",
12284 "datatype": true,
12285 "docs": {
12286 "custom": {
12287 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html",
12288 "exampleMetadata": "fixture=_generated"
12289 },
12290 "stability": "external",
12291 "summary": "The `MountPoint` property specifies details on a volume mount point that is used in a container definition.",
12292 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst mountPointProperty: ecs.CfnTaskDefinition.MountPointProperty = {\n containerPath: 'containerPath',\n readOnly: false,\n sourceVolume: 'sourceVolume',\n};"
12293 },
12294 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.MountPointProperty",
12295 "kind": "interface",
12296 "locationInModule": {
12297 "filename": "lib/ecs.generated.ts",
12298 "line": 5614
12299 },
12300 "name": "MountPointProperty",
12301 "namespace": "CfnTaskDefinition",
12302 "properties": [
12303 {
12304 "abstract": true,
12305 "docs": {
12306 "custom": {
12307 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-containerpath"
12308 },
12309 "stability": "external",
12310 "summary": "The path on the container to mount the host volume at."
12311 },
12312 "immutable": true,
12313 "locationInModule": {
12314 "filename": "lib/ecs.generated.ts",
12315 "line": 5620
12316 },
12317 "name": "containerPath",
12318 "optional": true,
12319 "type": {
12320 "primitive": "string"
12321 }
12322 },
12323 {
12324 "abstract": true,
12325 "docs": {
12326 "custom": {
12327 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-readonly"
12328 },
12329 "remarks": "If this value is `false` , then the container can write to the volume. The default value is `false` .",
12330 "stability": "external",
12331 "summary": "If this value is `true` , the container has read-only access to the volume."
12332 },
12333 "immutable": true,
12334 "locationInModule": {
12335 "filename": "lib/ecs.generated.ts",
12336 "line": 5626
12337 },
12338 "name": "readOnly",
12339 "optional": true,
12340 "type": {
12341 "union": {
12342 "types": [
12343 {
12344 "primitive": "boolean"
12345 },
12346 {
12347 "fqn": "@aws-cdk/core.IResolvable"
12348 }
12349 ]
12350 }
12351 }
12352 },
12353 {
12354 "abstract": true,
12355 "docs": {
12356 "custom": {
12357 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-sourcevolume"
12358 },
12359 "remarks": "Must be a volume name referenced in the `name` parameter of task definition `volume` .",
12360 "stability": "external",
12361 "summary": "The name of the volume to mount."
12362 },
12363 "immutable": true,
12364 "locationInModule": {
12365 "filename": "lib/ecs.generated.ts",
12366 "line": 5632
12367 },
12368 "name": "sourceVolume",
12369 "optional": true,
12370 "type": {
12371 "primitive": "string"
12372 }
12373 }
12374 ],
12375 "symbolId": "lib/ecs.generated:CfnTaskDefinition.MountPointProperty"
12376 },
12377 "@aws-cdk/aws-ecs.CfnTaskDefinition.PortMappingProperty": {
12378 "assembly": "@aws-cdk/aws-ecs",
12379 "datatype": true,
12380 "docs": {
12381 "custom": {
12382 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html",
12383 "exampleMetadata": "fixture=_generated"
12384 },
12385 "remarks": "Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.\n\nIf you are using containers in a task with the `awsvpc` or `host` network mode, exposed ports should be specified using `containerPort` . The `hostPort` can be left blank or it must be the same value as the `containerPort` .\n\nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the `networkBindings` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.",
12386 "stability": "external",
12387 "summary": "The `PortMapping` property specifies a port mapping.",
12388 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst portMappingProperty: ecs.CfnTaskDefinition.PortMappingProperty = {\n containerPort: 123,\n hostPort: 123,\n protocol: 'protocol',\n};"
12389 },
12390 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.PortMappingProperty",
12391 "kind": "interface",
12392 "locationInModule": {
12393 "filename": "lib/ecs.generated.ts",
12394 "line": 5703
12395 },
12396 "name": "PortMappingProperty",
12397 "namespace": "CfnTaskDefinition",
12398 "properties": [
12399 {
12400 "abstract": true,
12401 "docs": {
12402 "custom": {
12403 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-containerport"
12404 },
12405 "remarks": "If you use containers in a task with the `awsvpc` or `host` network mode, specify the exposed ports using `containerPort` .\n\nIf you use containers in a task with the `bridge` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see `hostPort` . Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.",
12406 "stability": "external",
12407 "summary": "The port number on the container that's bound to the user-specified or automatically assigned host port."
12408 },
12409 "immutable": true,
12410 "locationInModule": {
12411 "filename": "lib/ecs.generated.ts",
12412 "line": 5713
12413 },
12414 "name": "containerPort",
12415 "optional": true,
12416 "type": {
12417 "primitive": "number"
12418 }
12419 },
12420 {
12421 "abstract": true,
12422 "docs": {
12423 "custom": {
12424 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-readonly"
12425 },
12426 "remarks": "If you are using containers in a task with the `awsvpc` or `host` network mode, the `hostPort` can either be left blank or set to the same value as the `containerPort` .\n\nIf you are using containers in a task with the `bridge` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the `hostPort` (or set it to `0` ) while specifying a `containerPort` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n\nThe default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under `/proc/sys/net/ipv4/ip_local_port_range` . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n\n> The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.\n\nThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the `remainingResources` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.",
12427 "stability": "external",
12428 "summary": "The port number on the container instance to reserve for your container."
12429 },
12430 "immutable": true,
12431 "locationInModule": {
12432 "filename": "lib/ecs.generated.ts",
12433 "line": 5729
12434 },
12435 "name": "hostPort",
12436 "optional": true,
12437 "type": {
12438 "primitive": "number"
12439 }
12440 },
12441 {
12442 "abstract": true,
12443 "docs": {
12444 "custom": {
12445 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-sourcevolume"
12446 },
12447 "remarks": "Valid values are `tcp` and `udp` . The default is `tcp` .",
12448 "stability": "external",
12449 "summary": "The protocol used for the port mapping."
12450 },
12451 "immutable": true,
12452 "locationInModule": {
12453 "filename": "lib/ecs.generated.ts",
12454 "line": 5735
12455 },
12456 "name": "protocol",
12457 "optional": true,
12458 "type": {
12459 "primitive": "string"
12460 }
12461 }
12462 ],
12463 "symbolId": "lib/ecs.generated:CfnTaskDefinition.PortMappingProperty"
12464 },
12465 "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty": {
12466 "assembly": "@aws-cdk/aws-ecs",
12467 "datatype": true,
12468 "docs": {
12469 "custom": {
12470 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html",
12471 "exampleMetadata": "fixture=_generated"
12472 },
12473 "remarks": "For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the `ecs-init` package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.",
12474 "stability": "external",
12475 "summary": "The `ProxyConfiguration` property specifies the details for the App Mesh proxy.",
12476 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst proxyConfigurationProperty: ecs.CfnTaskDefinition.ProxyConfigurationProperty = {\n containerName: 'containerName',\n\n // the properties below are optional\n proxyConfigurationProperties: [{\n name: 'name',\n value: 'value',\n }],\n type: 'type',\n};"
12477 },
12478 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty",
12479 "kind": "interface",
12480 "locationInModule": {
12481 "filename": "lib/ecs.generated.ts",
12482 "line": 5806
12483 },
12484 "name": "ProxyConfigurationProperty",
12485 "namespace": "CfnTaskDefinition",
12486 "properties": [
12487 {
12488 "abstract": true,
12489 "docs": {
12490 "custom": {
12491 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-containername"
12492 },
12493 "stability": "external",
12494 "summary": "The name of the container that will serve as the App Mesh proxy."
12495 },
12496 "immutable": true,
12497 "locationInModule": {
12498 "filename": "lib/ecs.generated.ts",
12499 "line": 5812
12500 },
12501 "name": "containerName",
12502 "type": {
12503 "primitive": "string"
12504 }
12505 },
12506 {
12507 "abstract": true,
12508 "docs": {
12509 "custom": {
12510 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-proxyconfigurationproperties"
12511 },
12512 "remarks": "- `IgnoredUID` - (Required) The user ID (UID) of the proxy container as defined by the `user` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If `IgnoredGID` is specified, this field can be empty.\n- `IgnoredGID` - (Required) The group ID (GID) of the proxy container as defined by the `user` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If `IgnoredUID` is specified, this field can be empty.\n- `AppPorts` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort` .\n- `ProxyIngressPort` - (Required) Specifies the port that incoming traffic to the `AppPorts` is directed to.\n- `ProxyEgressPort` - (Required) Specifies the port that outgoing traffic from the `AppPorts` is directed to.\n- `EgressIgnoredPorts` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort` . It can be an empty list.\n- `EgressIgnoredIPs` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort` . It can be an empty list.",
12513 "stability": "external",
12514 "summary": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs."
12515 },
12516 "immutable": true,
12517 "locationInModule": {
12518 "filename": "lib/ecs.generated.ts",
12519 "line": 5826
12520 },
12521 "name": "proxyConfigurationProperties",
12522 "optional": true,
12523 "type": {
12524 "union": {
12525 "types": [
12526 {
12527 "fqn": "@aws-cdk/core.IResolvable"
12528 },
12529 {
12530 "collection": {
12531 "elementtype": {
12532 "union": {
12533 "types": [
12534 {
12535 "fqn": "@aws-cdk/core.IResolvable"
12536 },
12537 {
12538 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.KeyValuePairProperty"
12539 }
12540 ]
12541 }
12542 },
12543 "kind": "array"
12544 }
12545 }
12546 ]
12547 }
12548 }
12549 },
12550 {
12551 "abstract": true,
12552 "docs": {
12553 "custom": {
12554 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-type"
12555 },
12556 "remarks": "The only supported value is `APPMESH` .",
12557 "stability": "external",
12558 "summary": "The proxy type."
12559 },
12560 "immutable": true,
12561 "locationInModule": {
12562 "filename": "lib/ecs.generated.ts",
12563 "line": 5832
12564 },
12565 "name": "type",
12566 "optional": true,
12567 "type": {
12568 "primitive": "string"
12569 }
12570 }
12571 ],
12572 "symbolId": "lib/ecs.generated:CfnTaskDefinition.ProxyConfigurationProperty"
12573 },
12574 "@aws-cdk/aws-ecs.CfnTaskDefinition.RepositoryCredentialsProperty": {
12575 "assembly": "@aws-cdk/aws-ecs",
12576 "datatype": true,
12577 "docs": {
12578 "custom": {
12579 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html",
12580 "exampleMetadata": "fixture=_generated"
12581 },
12582 "stability": "external",
12583 "summary": "The `RepositoryCredentials` property specifies the repository credentials for private registry authentication.",
12584 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst repositoryCredentialsProperty: ecs.CfnTaskDefinition.RepositoryCredentialsProperty = {\n credentialsParameter: 'credentialsParameter',\n};"
12585 },
12586 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RepositoryCredentialsProperty",
12587 "kind": "interface",
12588 "locationInModule": {
12589 "filename": "lib/ecs.generated.ts",
12590 "line": 5900
12591 },
12592 "name": "RepositoryCredentialsProperty",
12593 "namespace": "CfnTaskDefinition",
12594 "properties": [
12595 {
12596 "abstract": true,
12597 "docs": {
12598 "custom": {
12599 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html#cfn-ecs-taskdefinition-repositorycredentials-credentialsparameter"
12600 },
12601 "remarks": "> When you use the Amazon ECS API, AWS CLI , or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.",
12602 "stability": "external",
12603 "summary": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials."
12604 },
12605 "immutable": true,
12606 "locationInModule": {
12607 "filename": "lib/ecs.generated.ts",
12608 "line": 5908
12609 },
12610 "name": "credentialsParameter",
12611 "optional": true,
12612 "type": {
12613 "primitive": "string"
12614 }
12615 }
12616 ],
12617 "symbolId": "lib/ecs.generated:CfnTaskDefinition.RepositoryCredentialsProperty"
12618 },
12619 "@aws-cdk/aws-ecs.CfnTaskDefinition.ResourceRequirementProperty": {
12620 "assembly": "@aws-cdk/aws-ecs",
12621 "datatype": true,
12622 "docs": {
12623 "custom": {
12624 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html",
12625 "exampleMetadata": "fixture=_generated"
12626 },
12627 "remarks": "The only supported resource is a GPU. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) in the *Amazon Elastic Container Service Developer Guide*",
12628 "stability": "external",
12629 "summary": "The `ResourceRequirement` property specifies the type and amount of a resource to assign to a container.",
12630 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst resourceRequirementProperty: ecs.CfnTaskDefinition.ResourceRequirementProperty = {\n type: 'type',\n value: 'value',\n};"
12631 },
12632 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ResourceRequirementProperty",
12633 "kind": "interface",
12634 "locationInModule": {
12635 "filename": "lib/ecs.generated.ts",
12636 "line": 5969
12637 },
12638 "name": "ResourceRequirementProperty",
12639 "namespace": "CfnTaskDefinition",
12640 "properties": [
12641 {
12642 "abstract": true,
12643 "docs": {
12644 "custom": {
12645 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-type"
12646 },
12647 "remarks": "The supported values are `GPU` or `InferenceAccelerator` .",
12648 "stability": "external",
12649 "summary": "The type of resource to assign to a container."
12650 },
12651 "immutable": true,
12652 "locationInModule": {
12653 "filename": "lib/ecs.generated.ts",
12654 "line": 5975
12655 },
12656 "name": "type",
12657 "type": {
12658 "primitive": "string"
12659 }
12660 },
12661 {
12662 "abstract": true,
12663 "docs": {
12664 "custom": {
12665 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-value"
12666 },
12667 "remarks": "If the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.\n\nIf the `InferenceAccelerator` type is used, the `value` should match the `DeviceName` for an [InferenceAccelerator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html) specified in a task definition.",
12668 "stability": "external",
12669 "summary": "The value for the specified resource type."
12670 },
12671 "immutable": true,
12672 "locationInModule": {
12673 "filename": "lib/ecs.generated.ts",
12674 "line": 5985
12675 },
12676 "name": "value",
12677 "type": {
12678 "primitive": "string"
12679 }
12680 }
12681 ],
12682 "symbolId": "lib/ecs.generated:CfnTaskDefinition.ResourceRequirementProperty"
12683 },
12684 "@aws-cdk/aws-ecs.CfnTaskDefinition.RuntimePlatformProperty": {
12685 "assembly": "@aws-cdk/aws-ecs",
12686 "datatype": true,
12687 "docs": {
12688 "custom": {
12689 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html",
12690 "exampleMetadata": "fixture=_generated"
12691 },
12692 "remarks": "For more informataion about `RuntimePlatform` , see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide* .",
12693 "stability": "external",
12694 "summary": "Information about the platform for the Amazon ECS service or task.",
12695 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst runtimePlatformProperty: ecs.CfnTaskDefinition.RuntimePlatformProperty = {\n cpuArchitecture: 'cpuArchitecture',\n operatingSystemFamily: 'operatingSystemFamily',\n};"
12696 },
12697 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RuntimePlatformProperty",
12698 "kind": "interface",
12699 "locationInModule": {
12700 "filename": "lib/ecs.generated.ts",
12701 "line": 6053
12702 },
12703 "name": "RuntimePlatformProperty",
12704 "namespace": "CfnTaskDefinition",
12705 "properties": [
12706 {
12707 "abstract": true,
12708 "docs": {
12709 "custom": {
12710 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-cpuarchitecture"
12711 },
12712 "remarks": "You can run your Linux tasks on an ARM-based platform by setting the value to `ARM64` . This option is avaiable for tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate.",
12713 "stability": "external",
12714 "summary": "The CPU architecture."
12715 },
12716 "immutable": true,
12717 "locationInModule": {
12718 "filename": "lib/ecs.generated.ts",
12719 "line": 6061
12720 },
12721 "name": "cpuArchitecture",
12722 "optional": true,
12723 "type": {
12724 "primitive": "string"
12725 }
12726 },
12727 {
12728 "abstract": true,
12729 "docs": {
12730 "custom": {
12731 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-operatingsystemfamily"
12732 },
12733 "stability": "external",
12734 "summary": "The operating system."
12735 },
12736 "immutable": true,
12737 "locationInModule": {
12738 "filename": "lib/ecs.generated.ts",
12739 "line": 6067
12740 },
12741 "name": "operatingSystemFamily",
12742 "optional": true,
12743 "type": {
12744 "primitive": "string"
12745 }
12746 }
12747 ],
12748 "symbolId": "lib/ecs.generated:CfnTaskDefinition.RuntimePlatformProperty"
12749 },
12750 "@aws-cdk/aws-ecs.CfnTaskDefinition.SecretProperty": {
12751 "assembly": "@aws-cdk/aws-ecs",
12752 "datatype": true,
12753 "docs": {
12754 "custom": {
12755 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html",
12756 "exampleMetadata": "fixture=_generated"
12757 },
12758 "remarks": "For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* .",
12759 "stability": "external",
12760 "summary": "The `Secret` property specifies an object representing the secret to expose to your container.",
12761 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst secretProperty: ecs.CfnTaskDefinition.SecretProperty = {\n name: 'name',\n valueFrom: 'valueFrom',\n};"
12762 },
12763 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SecretProperty",
12764 "kind": "interface",
12765 "locationInModule": {
12766 "filename": "lib/ecs.generated.ts",
12767 "line": 6131
12768 },
12769 "name": "SecretProperty",
12770 "namespace": "CfnTaskDefinition",
12771 "properties": [
12772 {
12773 "abstract": true,
12774 "docs": {
12775 "custom": {
12776 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-name"
12777 },
12778 "stability": "external",
12779 "summary": "The name of the secret."
12780 },
12781 "immutable": true,
12782 "locationInModule": {
12783 "filename": "lib/ecs.generated.ts",
12784 "line": 6137
12785 },
12786 "name": "name",
12787 "type": {
12788 "primitive": "string"
12789 }
12790 },
12791 {
12792 "abstract": true,
12793 "docs": {
12794 "custom": {
12795 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-valuefrom"
12796 },
12797 "remarks": "The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.\n\nFor information about the require AWS Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide* .\n\n> If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.",
12798 "stability": "external",
12799 "summary": "The secret to expose to the container."
12800 },
12801 "immutable": true,
12802 "locationInModule": {
12803 "filename": "lib/ecs.generated.ts",
12804 "line": 6147
12805 },
12806 "name": "valueFrom",
12807 "type": {
12808 "primitive": "string"
12809 }
12810 }
12811 ],
12812 "symbolId": "lib/ecs.generated:CfnTaskDefinition.SecretProperty"
12813 },
12814 "@aws-cdk/aws-ecs.CfnTaskDefinition.SystemControlProperty": {
12815 "assembly": "@aws-cdk/aws-ecs",
12816 "datatype": true,
12817 "docs": {
12818 "custom": {
12819 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html",
12820 "exampleMetadata": "fixture=_generated"
12821 },
12822 "remarks": "This parameter maps to `Sysctls` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--sysctl` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nWe don't recommend that you specify network-related `systemControls` parameters for multiple containers in a single task. This task also uses either the `awsvpc` or `host` network mode. It does it for the following reasons.\n\n- For tasks that use the `awsvpc` network mode, if you set `systemControls` for any container, it applies to all containers in the task. If you set different `systemControls` for multiple containers in a single task, the container that's started last determines which `systemControls` take effect.\n- For tasks that use the `host` network mode, the `systemControls` parameter applies to the container instance's kernel parameter and that of all containers of any tasks running on that container instance.",
12823 "stability": "external",
12824 "summary": "A list of namespaced kernel parameters to set in the container.",
12825 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst systemControlProperty: ecs.CfnTaskDefinition.SystemControlProperty = {\n namespace: 'namespace',\n value: 'value',\n};"
12826 },
12827 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SystemControlProperty",
12828 "kind": "interface",
12829 "locationInModule": {
12830 "filename": "lib/ecs.generated.ts",
12831 "line": 6218
12832 },
12833 "name": "SystemControlProperty",
12834 "namespace": "CfnTaskDefinition",
12835 "properties": [
12836 {
12837 "abstract": true,
12838 "docs": {
12839 "custom": {
12840 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-namespace"
12841 },
12842 "stability": "external",
12843 "summary": "The namespaced kernel parameter to set a `value` for."
12844 },
12845 "immutable": true,
12846 "locationInModule": {
12847 "filename": "lib/ecs.generated.ts",
12848 "line": 6224
12849 },
12850 "name": "namespace",
12851 "optional": true,
12852 "type": {
12853 "primitive": "string"
12854 }
12855 },
12856 {
12857 "abstract": true,
12858 "docs": {
12859 "custom": {
12860 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-value"
12861 },
12862 "stability": "external",
12863 "summary": "The value for the namespaced kernel parameter that's specified in `namespace` ."
12864 },
12865 "immutable": true,
12866 "locationInModule": {
12867 "filename": "lib/ecs.generated.ts",
12868 "line": 6230
12869 },
12870 "name": "value",
12871 "optional": true,
12872 "type": {
12873 "primitive": "string"
12874 }
12875 }
12876 ],
12877 "symbolId": "lib/ecs.generated:CfnTaskDefinition.SystemControlProperty"
12878 },
12879 "@aws-cdk/aws-ecs.CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty": {
12880 "assembly": "@aws-cdk/aws-ecs",
12881 "datatype": true,
12882 "docs": {
12883 "custom": {
12884 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html",
12885 "exampleMetadata": "fixture=_generated"
12886 },
12887 "remarks": "If you are using the Fargate launch type, task placement constraints are not supported.\n\nFor more information, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide* .",
12888 "stability": "external",
12889 "summary": "The `TaskDefinitionPlacementConstraint` property specifies an object representing a constraint on task placement in the task definition.",
12890 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst taskDefinitionPlacementConstraintProperty: ecs.CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty = {\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n};"
12891 },
12892 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty",
12893 "kind": "interface",
12894 "locationInModule": {
12895 "filename": "lib/ecs.generated.ts",
12896 "line": 6298
12897 },
12898 "name": "TaskDefinitionPlacementConstraintProperty",
12899 "namespace": "CfnTaskDefinition",
12900 "properties": [
12901 {
12902 "abstract": true,
12903 "docs": {
12904 "custom": {
12905 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type"
12906 },
12907 "remarks": "The `MemberOf` constraint restricts selection to be from a group of valid candidates.",
12908 "stability": "external",
12909 "summary": "The type of constraint."
12910 },
12911 "immutable": true,
12912 "locationInModule": {
12913 "filename": "lib/ecs.generated.ts",
12914 "line": 6310
12915 },
12916 "name": "type",
12917 "type": {
12918 "primitive": "string"
12919 }
12920 },
12921 {
12922 "abstract": true,
12923 "docs": {
12924 "custom": {
12925 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-expression"
12926 },
12927 "remarks": "For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide* .",
12928 "stability": "external",
12929 "summary": "A cluster query language expression to apply to the constraint."
12930 },
12931 "immutable": true,
12932 "locationInModule": {
12933 "filename": "lib/ecs.generated.ts",
12934 "line": 6304
12935 },
12936 "name": "expression",
12937 "optional": true,
12938 "type": {
12939 "primitive": "string"
12940 }
12941 }
12942 ],
12943 "symbolId": "lib/ecs.generated:CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty"
12944 },
12945 "@aws-cdk/aws-ecs.CfnTaskDefinition.TmpfsProperty": {
12946 "assembly": "@aws-cdk/aws-ecs",
12947 "datatype": true,
12948 "docs": {
12949 "custom": {
12950 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html",
12951 "exampleMetadata": "fixture=_generated"
12952 },
12953 "stability": "external",
12954 "summary": "The `Tmpfs` property specifies the container path, mount options, and size of the tmpfs mount.",
12955 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst tmpfsProperty: ecs.CfnTaskDefinition.TmpfsProperty = {\n size: 123,\n\n // the properties below are optional\n containerPath: 'containerPath',\n mountOptions: ['mountOptions'],\n};"
12956 },
12957 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.TmpfsProperty",
12958 "kind": "interface",
12959 "locationInModule": {
12960 "filename": "lib/ecs.generated.ts",
12961 "line": 6375
12962 },
12963 "name": "TmpfsProperty",
12964 "namespace": "CfnTaskDefinition",
12965 "properties": [
12966 {
12967 "abstract": true,
12968 "docs": {
12969 "custom": {
12970 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-size"
12971 },
12972 "stability": "external",
12973 "summary": "The maximum size (in MiB) of the tmpfs volume."
12974 },
12975 "immutable": true,
12976 "locationInModule": {
12977 "filename": "lib/ecs.generated.ts",
12978 "line": 6395
12979 },
12980 "name": "size",
12981 "type": {
12982 "primitive": "number"
12983 }
12984 },
12985 {
12986 "abstract": true,
12987 "docs": {
12988 "custom": {
12989 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-containerpath"
12990 },
12991 "stability": "external",
12992 "summary": "The absolute file path where the tmpfs volume is to be mounted."
12993 },
12994 "immutable": true,
12995 "locationInModule": {
12996 "filename": "lib/ecs.generated.ts",
12997 "line": 6381
12998 },
12999 "name": "containerPath",
13000 "optional": true,
13001 "type": {
13002 "primitive": "string"
13003 }
13004 },
13005 {
13006 "abstract": true,
13007 "docs": {
13008 "custom": {
13009 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-mountoptions"
13010 },
13011 "remarks": "Valid values: `\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"`",
13012 "stability": "external",
13013 "summary": "The list of tmpfs volume mount options."
13014 },
13015 "immutable": true,
13016 "locationInModule": {
13017 "filename": "lib/ecs.generated.ts",
13018 "line": 6389
13019 },
13020 "name": "mountOptions",
13021 "optional": true,
13022 "type": {
13023 "collection": {
13024 "elementtype": {
13025 "primitive": "string"
13026 },
13027 "kind": "array"
13028 }
13029 }
13030 }
13031 ],
13032 "symbolId": "lib/ecs.generated:CfnTaskDefinition.TmpfsProperty"
13033 },
13034 "@aws-cdk/aws-ecs.CfnTaskDefinition.UlimitProperty": {
13035 "assembly": "@aws-cdk/aws-ecs",
13036 "datatype": true,
13037 "docs": {
13038 "custom": {
13039 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html",
13040 "exampleMetadata": "fixture=_generated"
13041 },
13042 "stability": "external",
13043 "summary": "The `Ulimit` property specifies the `ulimit` settings to pass to the container.",
13044 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst ulimitProperty: ecs.CfnTaskDefinition.UlimitProperty = {\n hardLimit: 123,\n name: 'name',\n softLimit: 123,\n};"
13045 },
13046 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.UlimitProperty",
13047 "kind": "interface",
13048 "locationInModule": {
13049 "filename": "lib/ecs.generated.ts",
13050 "line": 6463
13051 },
13052 "name": "UlimitProperty",
13053 "namespace": "CfnTaskDefinition",
13054 "properties": [
13055 {
13056 "abstract": true,
13057 "docs": {
13058 "custom": {
13059 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-hardlimit"
13060 },
13061 "stability": "external",
13062 "summary": "The hard limit for the ulimit type."
13063 },
13064 "immutable": true,
13065 "locationInModule": {
13066 "filename": "lib/ecs.generated.ts",
13067 "line": 6469
13068 },
13069 "name": "hardLimit",
13070 "type": {
13071 "primitive": "number"
13072 }
13073 },
13074 {
13075 "abstract": true,
13076 "docs": {
13077 "custom": {
13078 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-name"
13079 },
13080 "stability": "external",
13081 "summary": "The `type` of the `ulimit` ."
13082 },
13083 "immutable": true,
13084 "locationInModule": {
13085 "filename": "lib/ecs.generated.ts",
13086 "line": 6475
13087 },
13088 "name": "name",
13089 "type": {
13090 "primitive": "string"
13091 }
13092 },
13093 {
13094 "abstract": true,
13095 "docs": {
13096 "custom": {
13097 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-softlimit"
13098 },
13099 "stability": "external",
13100 "summary": "The soft limit for the ulimit type."
13101 },
13102 "immutable": true,
13103 "locationInModule": {
13104 "filename": "lib/ecs.generated.ts",
13105 "line": 6481
13106 },
13107 "name": "softLimit",
13108 "type": {
13109 "primitive": "number"
13110 }
13111 }
13112 ],
13113 "symbolId": "lib/ecs.generated:CfnTaskDefinition.UlimitProperty"
13114 },
13115 "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeFromProperty": {
13116 "assembly": "@aws-cdk/aws-ecs",
13117 "datatype": true,
13118 "docs": {
13119 "custom": {
13120 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html",
13121 "exampleMetadata": "fixture=_generated"
13122 },
13123 "stability": "external",
13124 "summary": "The `VolumeFrom` property specifies details on a data volume from another container in the same task definition.",
13125 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst volumeFromProperty: ecs.CfnTaskDefinition.VolumeFromProperty = {\n readOnly: false,\n sourceContainer: 'sourceContainer',\n};"
13126 },
13127 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeFromProperty",
13128 "kind": "interface",
13129 "locationInModule": {
13130 "filename": "lib/ecs.generated.ts",
13131 "line": 6651
13132 },
13133 "name": "VolumeFromProperty",
13134 "namespace": "CfnTaskDefinition",
13135 "properties": [
13136 {
13137 "abstract": true,
13138 "docs": {
13139 "custom": {
13140 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-readonly"
13141 },
13142 "remarks": "If this value is `false` , then the container can write to the volume. The default value is `false` .",
13143 "stability": "external",
13144 "summary": "If this value is `true` , the container has read-only access to the volume."
13145 },
13146 "immutable": true,
13147 "locationInModule": {
13148 "filename": "lib/ecs.generated.ts",
13149 "line": 6657
13150 },
13151 "name": "readOnly",
13152 "optional": true,
13153 "type": {
13154 "union": {
13155 "types": [
13156 {
13157 "primitive": "boolean"
13158 },
13159 {
13160 "fqn": "@aws-cdk/core.IResolvable"
13161 }
13162 ]
13163 }
13164 }
13165 },
13166 {
13167 "abstract": true,
13168 "docs": {
13169 "custom": {
13170 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-sourcecontainer"
13171 },
13172 "stability": "external",
13173 "summary": "The name of another container within the same task definition to mount volumes from."
13174 },
13175 "immutable": true,
13176 "locationInModule": {
13177 "filename": "lib/ecs.generated.ts",
13178 "line": 6663
13179 },
13180 "name": "sourceContainer",
13181 "optional": true,
13182 "type": {
13183 "primitive": "string"
13184 }
13185 }
13186 ],
13187 "symbolId": "lib/ecs.generated:CfnTaskDefinition.VolumeFromProperty"
13188 },
13189 "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeProperty": {
13190 "assembly": "@aws-cdk/aws-ecs",
13191 "datatype": true,
13192 "docs": {
13193 "custom": {
13194 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html",
13195 "exampleMetadata": "fixture=_generated"
13196 },
13197 "remarks": "For tasks that use a Docker volume, specify a `DockerVolumeConfiguration` . For tasks that use a bind mount host volume, specify a `host` and optional `sourcePath` . For more information, see [Using Data Volumes in Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) .",
13198 "stability": "external",
13199 "summary": "The `Volume` property specifies a data volume used in a task definition.",
13200 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst volumeProperty: ecs.CfnTaskDefinition.VolumeProperty = {\n dockerVolumeConfiguration: {\n autoprovision: false,\n driver: 'driver',\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n scope: 'scope',\n },\n efsVolumeConfiguration: {\n filesystemId: 'filesystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n },\n host: {\n sourcePath: 'sourcePath',\n },\n name: 'name',\n};"
13201 },
13202 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeProperty",
13203 "kind": "interface",
13204 "locationInModule": {
13205 "filename": "lib/ecs.generated.ts",
13206 "line": 6551
13207 },
13208 "name": "VolumeProperty",
13209 "namespace": "CfnTaskDefinition",
13210 "properties": [
13211 {
13212 "abstract": true,
13213 "docs": {
13214 "custom": {
13215 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration"
13216 },
13217 "remarks": "Windows containers only support the use of the `local` driver. To use bind mounts, specify the `host` parameter instead.\n\n> Docker volumes aren't supported by tasks run on AWS Fargate .",
13218 "stability": "external",
13219 "summary": "This parameter is specified when you use Docker volumes."
13220 },
13221 "immutable": true,
13222 "locationInModule": {
13223 "filename": "lib/ecs.generated.ts",
13224 "line": 6561
13225 },
13226 "name": "dockerVolumeConfiguration",
13227 "optional": true,
13228 "type": {
13229 "union": {
13230 "types": [
13231 {
13232 "fqn": "@aws-cdk/core.IResolvable"
13233 },
13234 {
13235 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty"
13236 }
13237 ]
13238 }
13239 }
13240 },
13241 {
13242 "abstract": true,
13243 "docs": {
13244 "custom": {
13245 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-efsvolumeconfiguration"
13246 },
13247 "stability": "external",
13248 "summary": "This parameter is specified when you use an Amazon Elastic File System file system for task storage."
13249 },
13250 "immutable": true,
13251 "locationInModule": {
13252 "filename": "lib/ecs.generated.ts",
13253 "line": 6567
13254 },
13255 "name": "efsVolumeConfiguration",
13256 "optional": true,
13257 "type": {
13258 "union": {
13259 "types": [
13260 {
13261 "fqn": "@aws-cdk/core.IResolvable"
13262 },
13263 {
13264 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty"
13265 }
13266 ]
13267 }
13268 }
13269 },
13270 {
13271 "abstract": true,
13272 "docs": {
13273 "custom": {
13274 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-host"
13275 },
13276 "remarks": "The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n\nWindows containers can mount whole directories on the same drive as `$env:ProgramData` . Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\` , but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path` .",
13277 "stability": "external",
13278 "summary": "This parameter is specified when you use bind mount host volumes."
13279 },
13280 "immutable": true,
13281 "locationInModule": {
13282 "filename": "lib/ecs.generated.ts",
13283 "line": 6575
13284 },
13285 "name": "host",
13286 "optional": true,
13287 "type": {
13288 "union": {
13289 "types": [
13290 {
13291 "fqn": "@aws-cdk/core.IResolvable"
13292 },
13293 {
13294 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.HostVolumePropertiesProperty"
13295 }
13296 ]
13297 }
13298 }
13299 },
13300 {
13301 "abstract": true,
13302 "docs": {
13303 "custom": {
13304 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-name"
13305 },
13306 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the `sourceVolume` parameter of container definition `mountPoints` .",
13307 "stability": "external",
13308 "summary": "The name of the volume."
13309 },
13310 "immutable": true,
13311 "locationInModule": {
13312 "filename": "lib/ecs.generated.ts",
13313 "line": 6581
13314 },
13315 "name": "name",
13316 "optional": true,
13317 "type": {
13318 "primitive": "string"
13319 }
13320 }
13321 ],
13322 "symbolId": "lib/ecs.generated:CfnTaskDefinition.VolumeProperty"
13323 },
13324 "@aws-cdk/aws-ecs.CfnTaskDefinitionProps": {
13325 "assembly": "@aws-cdk/aws-ecs",
13326 "datatype": true,
13327 "docs": {
13328 "custom": {
13329 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html",
13330 "exampleMetadata": "fixture=_generated"
13331 },
13332 "stability": "external",
13333 "summary": "Properties for defining a `CfnTaskDefinition`.",
13334 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnTaskDefinitionProps: ecs.CfnTaskDefinitionProps = {\n containerDefinitions: [{\n command: ['command'],\n cpu: 123,\n dependsOn: [{\n condition: 'condition',\n containerName: 'containerName',\n }],\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: [{\n name: 'name',\n value: 'value',\n }],\n environmentFiles: [{\n type: 'type',\n value: 'value',\n }],\n essential: false,\n extraHosts: [{\n hostname: 'hostname',\n ipAddress: 'ipAddress',\n }],\n firelensConfiguration: {\n options: {\n optionsKey: 'options',\n },\n type: 'type',\n },\n healthCheck: {\n command: ['command'],\n interval: 123,\n retries: 123,\n startPeriod: 123,\n timeout: 123,\n },\n hostname: 'hostname',\n image: 'image',\n interactive: false,\n links: ['links'],\n linuxParameters: {\n capabilities: {\n add: ['add'],\n drop: ['drop'],\n },\n devices: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n permissions: ['permissions'],\n }],\n initProcessEnabled: false,\n maxSwap: 123,\n sharedMemorySize: 123,\n swappiness: 123,\n tmpfs: [{\n size: 123,\n\n // the properties below are optional\n containerPath: 'containerPath',\n mountOptions: ['mountOptions'],\n }],\n },\n logConfiguration: {\n logDriver: 'logDriver',\n\n // the properties below are optional\n options: {\n optionsKey: 'options',\n },\n secretOptions: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n },\n memory: 123,\n memoryReservation: 123,\n mountPoints: [{\n containerPath: 'containerPath',\n readOnly: false,\n sourceVolume: 'sourceVolume',\n }],\n name: 'name',\n portMappings: [{\n containerPort: 123,\n hostPort: 123,\n protocol: 'protocol',\n }],\n privileged: false,\n pseudoTerminal: false,\n readonlyRootFilesystem: false,\n repositoryCredentials: {\n credentialsParameter: 'credentialsParameter',\n },\n resourceRequirements: [{\n type: 'type',\n value: 'value',\n }],\n secrets: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n startTimeout: 123,\n stopTimeout: 123,\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n ulimits: [{\n hardLimit: 123,\n name: 'name',\n softLimit: 123,\n }],\n user: 'user',\n volumesFrom: [{\n readOnly: false,\n sourceContainer: 'sourceContainer',\n }],\n workingDirectory: 'workingDirectory',\n }],\n cpu: 'cpu',\n ephemeralStorage: {\n sizeInGiB: 123,\n },\n executionRoleArn: 'executionRoleArn',\n family: 'family',\n inferenceAccelerators: [{\n deviceName: 'deviceName',\n deviceType: 'deviceType',\n }],\n ipcMode: 'ipcMode',\n memory: 'memory',\n networkMode: 'networkMode',\n pidMode: 'pidMode',\n placementConstraints: [{\n type: 'type',\n\n // the properties below are optional\n expression: 'expression',\n }],\n proxyConfiguration: {\n containerName: 'containerName',\n\n // the properties below are optional\n proxyConfigurationProperties: [{\n name: 'name',\n value: 'value',\n }],\n type: 'type',\n },\n requiresCompatibilities: ['requiresCompatibilities'],\n runtimePlatform: {\n cpuArchitecture: 'cpuArchitecture',\n operatingSystemFamily: 'operatingSystemFamily',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n taskRoleArn: 'taskRoleArn',\n volumes: [{\n dockerVolumeConfiguration: {\n autoprovision: false,\n driver: 'driver',\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n scope: 'scope',\n },\n efsVolumeConfiguration: {\n filesystemId: 'filesystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n },\n host: {\n sourcePath: 'sourcePath',\n },\n name: 'name',\n }],\n};"
13335 },
13336 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinitionProps",
13337 "kind": "interface",
13338 "locationInModule": {
13339 "filename": "lib/ecs.generated.ts",
13340 "line": 3064
13341 },
13342 "name": "CfnTaskDefinitionProps",
13343 "properties": [
13344 {
13345 "abstract": true,
13346 "docs": {
13347 "custom": {
13348 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions"
13349 },
13350 "remarks": "For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide* .",
13351 "stability": "external",
13352 "summary": "A list of container definitions in JSON format that describe the different containers that make up your task."
13353 },
13354 "immutable": true,
13355 "locationInModule": {
13356 "filename": "lib/ecs.generated.ts",
13357 "line": 3071
13358 },
13359 "name": "containerDefinitions",
13360 "optional": true,
13361 "type": {
13362 "union": {
13363 "types": [
13364 {
13365 "fqn": "@aws-cdk/core.IResolvable"
13366 },
13367 {
13368 "collection": {
13369 "elementtype": {
13370 "union": {
13371 "types": [
13372 {
13373 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty"
13374 },
13375 {
13376 "fqn": "@aws-cdk/core.IResolvable"
13377 }
13378 ]
13379 }
13380 },
13381 "kind": "array"
13382 }
13383 }
13384 ]
13385 }
13386 }
13387 },
13388 {
13389 "abstract": true,
13390 "docs": {
13391 "custom": {
13392 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu"
13393 },
13394 "remarks": "If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the `memory` parameter.\n\nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n\n- 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n- 512 (.5 vCPU) - Available `memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n- 1024 (1 vCPU) - Available `memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n- 2048 (2 vCPU) - Available `memory` values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n- 4096 (4 vCPU) - Available `memory` values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)",
13395 "stability": "external",
13396 "summary": "The number of `cpu` units used by the task."
13397 },
13398 "immutable": true,
13399 "locationInModule": {
13400 "filename": "lib/ecs.generated.ts",
13401 "line": 3086
13402 },
13403 "name": "cpu",
13404 "optional": true,
13405 "type": {
13406 "primitive": "string"
13407 }
13408 },
13409 {
13410 "abstract": true,
13411 "docs": {
13412 "custom": {
13413 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ephemeralstorage"
13414 },
13415 "stability": "external",
13416 "summary": "The ephemeral storage settings to use for tasks run with the task definition."
13417 },
13418 "immutable": true,
13419 "locationInModule": {
13420 "filename": "lib/ecs.generated.ts",
13421 "line": 3093
13422 },
13423 "name": "ephemeralStorage",
13424 "optional": true,
13425 "type": {
13426 "union": {
13427 "types": [
13428 {
13429 "fqn": "@aws-cdk/core.IResolvable"
13430 },
13431 {
13432 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.EphemeralStorageProperty"
13433 }
13434 ]
13435 }
13436 }
13437 },
13438 {
13439 "abstract": true,
13440 "docs": {
13441 "custom": {
13442 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn"
13443 },
13444 "remarks": "The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide* .",
13445 "stability": "external",
13446 "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf."
13447 },
13448 "immutable": true,
13449 "locationInModule": {
13450 "filename": "lib/ecs.generated.ts",
13451 "line": 3100
13452 },
13453 "name": "executionRoleArn",
13454 "optional": true,
13455 "type": {
13456 "primitive": "string"
13457 }
13458 },
13459 {
13460 "abstract": true,
13461 "docs": {
13462 "custom": {
13463 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family"
13464 },
13465 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n\nA family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n\n> To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.",
13466 "stability": "external",
13467 "summary": "The name of a family that this task definition is registered to."
13468 },
13469 "immutable": true,
13470 "locationInModule": {
13471 "filename": "lib/ecs.generated.ts",
13472 "line": 3111
13473 },
13474 "name": "family",
13475 "optional": true,
13476 "type": {
13477 "primitive": "string"
13478 }
13479 },
13480 {
13481 "abstract": true,
13482 "docs": {
13483 "custom": {
13484 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-inferenceaccelerators"
13485 },
13486 "stability": "external",
13487 "summary": "The Elastic Inference accelerators to use for the containers in the task."
13488 },
13489 "immutable": true,
13490 "locationInModule": {
13491 "filename": "lib/ecs.generated.ts",
13492 "line": 3118
13493 },
13494 "name": "inferenceAccelerators",
13495 "optional": true,
13496 "type": {
13497 "union": {
13498 "types": [
13499 {
13500 "fqn": "@aws-cdk/core.IResolvable"
13501 },
13502 {
13503 "collection": {
13504 "elementtype": {
13505 "union": {
13506 "types": [
13507 {
13508 "fqn": "@aws-cdk/core.IResolvable"
13509 },
13510 {
13511 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.InferenceAcceleratorProperty"
13512 }
13513 ]
13514 }
13515 },
13516 "kind": "array"
13517 }
13518 }
13519 ]
13520 }
13521 }
13522 },
13523 {
13524 "abstract": true,
13525 "docs": {
13526 "custom": {
13527 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ipcmode"
13528 },
13529 "remarks": "The valid values are `host` , `task` , or `none` . If `host` is specified, then all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same IPC resources. If `none` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference* .\n\nIf the `host` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/) .\n\nIf you are setting namespaced kernel parameters using `systemControls` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n- For tasks that use the `host` IPC mode, IPC namespace related `systemControls` are not supported.\n- For tasks that use the `task` IPC mode, IPC namespace related `systemControls` will apply to all containers within a task.\n\n> This parameter is not supported for Windows containers or tasks run on AWS Fargate .",
13530 "stability": "external",
13531 "summary": "The IPC resource namespace to use for the containers in the task."
13532 },
13533 "immutable": true,
13534 "locationInModule": {
13535 "filename": "lib/ecs.generated.ts",
13536 "line": 3134
13537 },
13538 "name": "ipcMode",
13539 "optional": true,
13540 "type": {
13541 "primitive": "string"
13542 }
13543 },
13544 {
13545 "abstract": true,
13546 "docs": {
13547 "custom": {
13548 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory"
13549 },
13550 "remarks": "If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html) .\n\nIf your tasks runs on AWS Fargate , this field is required. You must use one of the following values. The value you choose determines your range of valid values for the `cpu` parameter.\n\n- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256 (.25 vCPU)\n- 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available `cpu` values: 512 (.5 vCPU)\n- 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available `cpu` values: 1024 (1 vCPU)\n- Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available `cpu` values: 2048 (2 vCPU)\n- Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available `cpu` values: 4096 (4 vCPU)",
13551 "stability": "external",
13552 "summary": "The amount (in MiB) of memory used by the task."
13553 },
13554 "immutable": true,
13555 "locationInModule": {
13556 "filename": "lib/ecs.generated.ts",
13557 "line": 3151
13558 },
13559 "name": "memory",
13560 "optional": true,
13561 "type": {
13562 "primitive": "string"
13563 }
13564 },
13565 {
13566 "abstract": true,
13567 "docs": {
13568 "custom": {
13569 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode"
13570 },
13571 "remarks": "The valid values are `none` , `bridge` , `awsvpc` , and `host` . The default Docker network mode is `bridge` . If you are using the Fargate launch type, the `awsvpc` network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to `none` , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode.\n\nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port (for the `host` network mode) or the attached elastic network interface port (for the `awsvpc` network mode), so you cannot take advantage of dynamic host port mappings.\n\nIf the network mode is `awsvpc` , the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the `ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode.\n\nIf the network mode is `host` , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.\n\nDocker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the `<default>` network mode object.\n\nFor more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference* .",
13572 "stability": "external",
13573 "summary": "The Docker networking mode to use for the containers in the task."
13574 },
13575 "immutable": true,
13576 "locationInModule": {
13577 "filename": "lib/ecs.generated.ts",
13578 "line": 3170
13579 },
13580 "name": "networkMode",
13581 "optional": true,
13582 "type": {
13583 "primitive": "string"
13584 }
13585 },
13586 {
13587 "abstract": true,
13588 "docs": {
13589 "custom": {
13590 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-pidmode"
13591 },
13592 "remarks": "The valid values are `host` or `task` . If `host` is specified, then all containers within the tasks that specified the `host` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference* .\n\nIf the `host` PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/) .\n\n> This parameter is not supported for Windows containers or tasks run on AWS Fargate .",
13593 "stability": "external",
13594 "summary": "The process namespace to use for the containers in the task."
13595 },
13596 "immutable": true,
13597 "locationInModule": {
13598 "filename": "lib/ecs.generated.ts",
13599 "line": 3181
13600 },
13601 "name": "pidMode",
13602 "optional": true,
13603 "type": {
13604 "primitive": "string"
13605 }
13606 },
13607 {
13608 "abstract": true,
13609 "docs": {
13610 "custom": {
13611 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints"
13612 },
13613 "remarks": "> This parameter isn't supported for tasks run on AWS Fargate .",
13614 "stability": "external",
13615 "summary": "An array of placement constraint objects to use for tasks."
13616 },
13617 "immutable": true,
13618 "locationInModule": {
13619 "filename": "lib/ecs.generated.ts",
13620 "line": 3190
13621 },
13622 "name": "placementConstraints",
13623 "optional": true,
13624 "type": {
13625 "union": {
13626 "types": [
13627 {
13628 "fqn": "@aws-cdk/core.IResolvable"
13629 },
13630 {
13631 "collection": {
13632 "elementtype": {
13633 "union": {
13634 "types": [
13635 {
13636 "fqn": "@aws-cdk/core.IResolvable"
13637 },
13638 {
13639 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty"
13640 }
13641 ]
13642 }
13643 },
13644 "kind": "array"
13645 }
13646 }
13647 ]
13648 }
13649 }
13650 },
13651 {
13652 "abstract": true,
13653 "docs": {
13654 "custom": {
13655 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-proxyconfiguration"
13656 },
13657 "remarks": "Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the `ecs-init` package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init` . For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide* .",
13658 "stability": "external",
13659 "summary": "The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy."
13660 },
13661 "immutable": true,
13662 "locationInModule": {
13663 "filename": "lib/ecs.generated.ts",
13664 "line": 3199
13665 },
13666 "name": "proxyConfiguration",
13667 "optional": true,
13668 "type": {
13669 "union": {
13670 "types": [
13671 {
13672 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty"
13673 },
13674 {
13675 "fqn": "@aws-cdk/core.IResolvable"
13676 }
13677 ]
13678 }
13679 }
13680 },
13681 {
13682 "abstract": true,
13683 "docs": {
13684 "custom": {
13685 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities"
13686 },
13687 "remarks": "To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter.",
13688 "stability": "external",
13689 "summary": "The task launch types the task definition was validated against."
13690 },
13691 "immutable": true,
13692 "locationInModule": {
13693 "filename": "lib/ecs.generated.ts",
13694 "line": 3206
13695 },
13696 "name": "requiresCompatibilities",
13697 "optional": true,
13698 "type": {
13699 "collection": {
13700 "elementtype": {
13701 "primitive": "string"
13702 },
13703 "kind": "array"
13704 }
13705 }
13706 },
13707 {
13708 "abstract": true,
13709 "docs": {
13710 "custom": {
13711 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-runtimeplatform"
13712 },
13713 "remarks": "A platform family is specified only for tasks using the Fargate launch type.\n\nWhen you specify a task definition in a service, this value must match the `runtimePlatform` value of the service.",
13714 "stability": "external",
13715 "summary": "The operating system that your tasks definitions run on."
13716 },
13717 "immutable": true,
13718 "locationInModule": {
13719 "filename": "lib/ecs.generated.ts",
13720 "line": 3215
13721 },
13722 "name": "runtimePlatform",
13723 "optional": true,
13724 "type": {
13725 "union": {
13726 "types": [
13727 {
13728 "fqn": "@aws-cdk/core.IResolvable"
13729 },
13730 {
13731 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RuntimePlatformProperty"
13732 }
13733 ]
13734 }
13735 }
13736 },
13737 {
13738 "abstract": true,
13739 "docs": {
13740 "custom": {
13741 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-tags"
13742 },
13743 "remarks": "Each tag consists of a key and an optional value. You define both of them.\n\nThe following basic restrictions apply to tags:\n\n- Maximum number of tags per resource - 50\n- For each resource, each tag key must be unique, and each tag key can have only one value.\n- Maximum key length - 128 Unicode characters in UTF-8\n- Maximum value length - 256 Unicode characters in UTF-8\n- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n- Tag keys and values are case-sensitive.\n- Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.",
13744 "stability": "external",
13745 "summary": "The metadata that you apply to the task definition to help you categorize and organize them."
13746 },
13747 "immutable": true,
13748 "locationInModule": {
13749 "filename": "lib/ecs.generated.ts",
13750 "line": 3232
13751 },
13752 "name": "tags",
13753 "optional": true,
13754 "type": {
13755 "collection": {
13756 "elementtype": {
13757 "fqn": "@aws-cdk/core.CfnTag"
13758 },
13759 "kind": "array"
13760 }
13761 }
13762 },
13763 {
13764 "abstract": true,
13765 "docs": {
13766 "custom": {
13767 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn"
13768 },
13769 "remarks": "For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIAM roles for tasks on Windows require that the `-EnableTaskIAMRole` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide* .",
13770 "stability": "external",
13771 "summary": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf."
13772 },
13773 "immutable": true,
13774 "locationInModule": {
13775 "filename": "lib/ecs.generated.ts",
13776 "line": 3241
13777 },
13778 "name": "taskRoleArn",
13779 "optional": true,
13780 "type": {
13781 "primitive": "string"
13782 }
13783 },
13784 {
13785 "abstract": true,
13786 "docs": {
13787 "custom": {
13788 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes"
13789 },
13790 "remarks": "For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> The `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate .",
13791 "stability": "external",
13792 "summary": "The list of data volume definitions for the task."
13793 },
13794 "immutable": true,
13795 "locationInModule": {
13796 "filename": "lib/ecs.generated.ts",
13797 "line": 3250
13798 },
13799 "name": "volumes",
13800 "optional": true,
13801 "type": {
13802 "union": {
13803 "types": [
13804 {
13805 "fqn": "@aws-cdk/core.IResolvable"
13806 },
13807 {
13808 "collection": {
13809 "elementtype": {
13810 "union": {
13811 "types": [
13812 {
13813 "fqn": "@aws-cdk/core.IResolvable"
13814 },
13815 {
13816 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.VolumeProperty"
13817 }
13818 ]
13819 }
13820 },
13821 "kind": "array"
13822 }
13823 }
13824 ]
13825 }
13826 }
13827 }
13828 ],
13829 "symbolId": "lib/ecs.generated:CfnTaskDefinitionProps"
13830 },
13831 "@aws-cdk/aws-ecs.CfnTaskSet": {
13832 "assembly": "@aws-cdk/aws-ecs",
13833 "base": "@aws-cdk/core.CfnResource",
13834 "docs": {
13835 "custom": {
13836 "cloudformationResource": "AWS::ECS::TaskSet",
13837 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html",
13838 "exampleMetadata": "fixture=_generated"
13839 },
13840 "remarks": "Create a task set in the specified cluster and service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide* .",
13841 "stability": "external",
13842 "summary": "A CloudFormation `AWS::ECS::TaskSet`.",
13843 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnTaskSet = new ecs.CfnTaskSet(this, 'MyCfnTaskSet', {\n cluster: 'cluster',\n service: 'service',\n taskDefinition: 'taskDefinition',\n\n // the properties below are optional\n externalId: 'externalId',\n launchType: 'launchType',\n loadBalancers: [{\n containerName: 'containerName',\n containerPort: 123,\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n }],\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n platformVersion: 'platformVersion',\n scale: {\n unit: 'unit',\n value: 123,\n },\n serviceRegistries: [{\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n }],\n});"
13844 },
13845 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet",
13846 "initializer": {
13847 "docs": {
13848 "stability": "external",
13849 "summary": "Create a new `AWS::ECS::TaskSet`."
13850 },
13851 "locationInModule": {
13852 "filename": "lib/ecs.generated.ts",
13853 "line": 6996
13854 },
13855 "parameters": [
13856 {
13857 "docs": {
13858 "summary": "- scope in which this resource is defined."
13859 },
13860 "name": "scope",
13861 "type": {
13862 "fqn": "@aws-cdk/core.Construct"
13863 }
13864 },
13865 {
13866 "docs": {
13867 "summary": "- scoped id of the resource."
13868 },
13869 "name": "id",
13870 "type": {
13871 "primitive": "string"
13872 }
13873 },
13874 {
13875 "docs": {
13876 "summary": "- resource properties."
13877 },
13878 "name": "props",
13879 "type": {
13880 "fqn": "@aws-cdk/aws-ecs.CfnTaskSetProps"
13881 }
13882 }
13883 ]
13884 },
13885 "interfaces": [
13886 "@aws-cdk/core.IInspectable"
13887 ],
13888 "kind": "class",
13889 "locationInModule": {
13890 "filename": "lib/ecs.generated.ts",
13891 "line": 6886
13892 },
13893 "methods": [
13894 {
13895 "docs": {
13896 "stability": "external",
13897 "summary": "Examines the CloudFormation resource and discloses attributes."
13898 },
13899 "locationInModule": {
13900 "filename": "lib/ecs.generated.ts",
13901 "line": 7021
13902 },
13903 "name": "inspect",
13904 "overrides": "@aws-cdk/core.IInspectable",
13905 "parameters": [
13906 {
13907 "docs": {
13908 "summary": "- tree inspector to collect and process attributes."
13909 },
13910 "name": "inspector",
13911 "type": {
13912 "fqn": "@aws-cdk/core.TreeInspector"
13913 }
13914 }
13915 ]
13916 },
13917 {
13918 "docs": {
13919 "stability": "external"
13920 },
13921 "locationInModule": {
13922 "filename": "lib/ecs.generated.ts",
13923 "line": 7041
13924 },
13925 "name": "renderProperties",
13926 "overrides": "@aws-cdk/core.CfnResource",
13927 "parameters": [
13928 {
13929 "name": "props",
13930 "type": {
13931 "collection": {
13932 "elementtype": {
13933 "primitive": "any"
13934 },
13935 "kind": "map"
13936 }
13937 }
13938 }
13939 ],
13940 "protected": true,
13941 "returns": {
13942 "type": {
13943 "collection": {
13944 "elementtype": {
13945 "primitive": "any"
13946 },
13947 "kind": "map"
13948 }
13949 }
13950 }
13951 }
13952 ],
13953 "name": "CfnTaskSet",
13954 "properties": [
13955 {
13956 "const": true,
13957 "docs": {
13958 "stability": "external",
13959 "summary": "The CloudFormation resource type name for this resource class."
13960 },
13961 "immutable": true,
13962 "locationInModule": {
13963 "filename": "lib/ecs.generated.ts",
13964 "line": 6890
13965 },
13966 "name": "CFN_RESOURCE_TYPE_NAME",
13967 "static": true,
13968 "type": {
13969 "primitive": "string"
13970 }
13971 },
13972 {
13973 "docs": {
13974 "custom": {
13975 "cloudformationAttribute": "Id"
13976 },
13977 "stability": "external",
13978 "summary": "The ID of the task set."
13979 },
13980 "immutable": true,
13981 "locationInModule": {
13982 "filename": "lib/ecs.generated.ts",
13983 "line": 6915
13984 },
13985 "name": "attrId",
13986 "type": {
13987 "primitive": "string"
13988 }
13989 },
13990 {
13991 "docs": {
13992 "stability": "external"
13993 },
13994 "immutable": true,
13995 "locationInModule": {
13996 "filename": "lib/ecs.generated.ts",
13997 "line": 7026
13998 },
13999 "name": "cfnProperties",
14000 "overrides": "@aws-cdk/core.CfnResource",
14001 "protected": true,
14002 "type": {
14003 "collection": {
14004 "elementtype": {
14005 "primitive": "any"
14006 },
14007 "kind": "map"
14008 }
14009 }
14010 },
14011 {
14012 "docs": {
14013 "custom": {
14014 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster"
14015 },
14016 "stability": "external",
14017 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in."
14018 },
14019 "locationInModule": {
14020 "filename": "lib/ecs.generated.ts",
14021 "line": 6922
14022 },
14023 "name": "cluster",
14024 "type": {
14025 "primitive": "string"
14026 }
14027 },
14028 {
14029 "docs": {
14030 "custom": {
14031 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service"
14032 },
14033 "stability": "external",
14034 "summary": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in."
14035 },
14036 "locationInModule": {
14037 "filename": "lib/ecs.generated.ts",
14038 "line": 6929
14039 },
14040 "name": "service",
14041 "type": {
14042 "primitive": "string"
14043 }
14044 },
14045 {
14046 "docs": {
14047 "custom": {
14048 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition"
14049 },
14050 "stability": "external",
14051 "summary": "The task definition for the tasks in the task set to use."
14052 },
14053 "locationInModule": {
14054 "filename": "lib/ecs.generated.ts",
14055 "line": 6936
14056 },
14057 "name": "taskDefinition",
14058 "type": {
14059 "primitive": "string"
14060 }
14061 },
14062 {
14063 "docs": {
14064 "custom": {
14065 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid"
14066 },
14067 "remarks": "If the task set is associated with a service discovery registry, the tasks in this task set will have the `ECS_TASK_SET_EXTERNAL_ID` AWS Cloud Map attribute set to the provided value.",
14068 "stability": "external",
14069 "summary": "An optional non-unique tag that identifies this task set in external systems."
14070 },
14071 "locationInModule": {
14072 "filename": "lib/ecs.generated.ts",
14073 "line": 6943
14074 },
14075 "name": "externalId",
14076 "optional": true,
14077 "type": {
14078 "primitive": "string"
14079 }
14080 },
14081 {
14082 "docs": {
14083 "custom": {
14084 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype"
14085 },
14086 "remarks": "For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted.",
14087 "stability": "external",
14088 "summary": "The launch type that new tasks in the task set uses."
14089 },
14090 "locationInModule": {
14091 "filename": "lib/ecs.generated.ts",
14092 "line": 6952
14093 },
14094 "name": "launchType",
14095 "optional": true,
14096 "type": {
14097 "primitive": "string"
14098 }
14099 },
14100 {
14101 "docs": {
14102 "custom": {
14103 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers"
14104 },
14105 "remarks": "The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.",
14106 "stability": "external",
14107 "summary": "A load balancer object representing the load balancer to use with the task set."
14108 },
14109 "locationInModule": {
14110 "filename": "lib/ecs.generated.ts",
14111 "line": 6959
14112 },
14113 "name": "loadBalancers",
14114 "optional": true,
14115 "type": {
14116 "union": {
14117 "types": [
14118 {
14119 "fqn": "@aws-cdk/core.IResolvable"
14120 },
14121 {
14122 "collection": {
14123 "elementtype": {
14124 "union": {
14125 "types": [
14126 {
14127 "fqn": "@aws-cdk/core.IResolvable"
14128 },
14129 {
14130 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.LoadBalancerProperty"
14131 }
14132 ]
14133 }
14134 },
14135 "kind": "array"
14136 }
14137 }
14138 ]
14139 }
14140 }
14141 },
14142 {
14143 "docs": {
14144 "custom": {
14145 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration"
14146 },
14147 "stability": "external",
14148 "summary": "The network configuration for the task set."
14149 },
14150 "locationInModule": {
14151 "filename": "lib/ecs.generated.ts",
14152 "line": 6966
14153 },
14154 "name": "networkConfiguration",
14155 "optional": true,
14156 "type": {
14157 "union": {
14158 "types": [
14159 {
14160 "fqn": "@aws-cdk/core.IResolvable"
14161 },
14162 {
14163 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.NetworkConfigurationProperty"
14164 }
14165 ]
14166 }
14167 }
14168 },
14169 {
14170 "docs": {
14171 "custom": {
14172 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion"
14173 },
14174 "remarks": "A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used.",
14175 "stability": "external",
14176 "summary": "The platform version that the tasks in the task set uses."
14177 },
14178 "locationInModule": {
14179 "filename": "lib/ecs.generated.ts",
14180 "line": 6973
14181 },
14182 "name": "platformVersion",
14183 "optional": true,
14184 "type": {
14185 "primitive": "string"
14186 }
14187 },
14188 {
14189 "docs": {
14190 "custom": {
14191 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale"
14192 },
14193 "stability": "external",
14194 "summary": "A floating-point percentage of your desired number of tasks to place and keep running in the task set."
14195 },
14196 "locationInModule": {
14197 "filename": "lib/ecs.generated.ts",
14198 "line": 6980
14199 },
14200 "name": "scale",
14201 "optional": true,
14202 "type": {
14203 "union": {
14204 "types": [
14205 {
14206 "fqn": "@aws-cdk/core.IResolvable"
14207 },
14208 {
14209 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ScaleProperty"
14210 }
14211 ]
14212 }
14213 }
14214 },
14215 {
14216 "docs": {
14217 "custom": {
14218 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries"
14219 },
14220 "remarks": "For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .",
14221 "stability": "external",
14222 "summary": "The details of the service discovery registries to assign to this task set."
14223 },
14224 "locationInModule": {
14225 "filename": "lib/ecs.generated.ts",
14226 "line": 6987
14227 },
14228 "name": "serviceRegistries",
14229 "optional": true,
14230 "type": {
14231 "union": {
14232 "types": [
14233 {
14234 "fqn": "@aws-cdk/core.IResolvable"
14235 },
14236 {
14237 "collection": {
14238 "elementtype": {
14239 "union": {
14240 "types": [
14241 {
14242 "fqn": "@aws-cdk/core.IResolvable"
14243 },
14244 {
14245 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ServiceRegistryProperty"
14246 }
14247 ]
14248 }
14249 },
14250 "kind": "array"
14251 }
14252 }
14253 ]
14254 }
14255 }
14256 }
14257 ],
14258 "symbolId": "lib/ecs.generated:CfnTaskSet"
14259 },
14260 "@aws-cdk/aws-ecs.CfnTaskSet.AwsVpcConfigurationProperty": {
14261 "assembly": "@aws-cdk/aws-ecs",
14262 "datatype": true,
14263 "docs": {
14264 "custom": {
14265 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html",
14266 "exampleMetadata": "fixture=_generated"
14267 },
14268 "stability": "external",
14269 "summary": "The networking details for a task.",
14270 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst awsVpcConfigurationProperty: ecs.CfnTaskSet.AwsVpcConfigurationProperty = {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n};"
14271 },
14272 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.AwsVpcConfigurationProperty",
14273 "kind": "interface",
14274 "locationInModule": {
14275 "filename": "lib/ecs.generated.ts",
14276 "line": 7055
14277 },
14278 "name": "AwsVpcConfigurationProperty",
14279 "namespace": "CfnTaskSet",
14280 "properties": [
14281 {
14282 "abstract": true,
14283 "docs": {
14284 "custom": {
14285 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-subnets"
14286 },
14287 "remarks": "There's a limit of 16 subnets that can be specified per `AwsVpcConfiguration` .\n\n> All specified subnets must be from the same VPC.",
14288 "stability": "external",
14289 "summary": "The IDs of the subnets associated with the task or service."
14290 },
14291 "immutable": true,
14292 "locationInModule": {
14293 "filename": "lib/ecs.generated.ts",
14294 "line": 7077
14295 },
14296 "name": "subnets",
14297 "type": {
14298 "collection": {
14299 "elementtype": {
14300 "primitive": "string"
14301 },
14302 "kind": "array"
14303 }
14304 }
14305 },
14306 {
14307 "abstract": true,
14308 "docs": {
14309 "custom": {
14310 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-assignpublicip"
14311 },
14312 "remarks": "The default value is `DISABLED` .",
14313 "stability": "external",
14314 "summary": "Whether the task's elastic network interface receives a public IP address."
14315 },
14316 "immutable": true,
14317 "locationInModule": {
14318 "filename": "lib/ecs.generated.ts",
14319 "line": 7061
14320 },
14321 "name": "assignPublicIp",
14322 "optional": true,
14323 "type": {
14324 "primitive": "string"
14325 }
14326 },
14327 {
14328 "abstract": true,
14329 "docs": {
14330 "custom": {
14331 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-securitygroups"
14332 },
14333 "remarks": "If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per `AwsVpcConfiguration` .\n\n> All specified security groups must be from the same VPC.",
14334 "stability": "external",
14335 "summary": "The IDs of the security groups associated with the task or service."
14336 },
14337 "immutable": true,
14338 "locationInModule": {
14339 "filename": "lib/ecs.generated.ts",
14340 "line": 7069
14341 },
14342 "name": "securityGroups",
14343 "optional": true,
14344 "type": {
14345 "collection": {
14346 "elementtype": {
14347 "primitive": "string"
14348 },
14349 "kind": "array"
14350 }
14351 }
14352 }
14353 ],
14354 "symbolId": "lib/ecs.generated:CfnTaskSet.AwsVpcConfigurationProperty"
14355 },
14356 "@aws-cdk/aws-ecs.CfnTaskSet.LoadBalancerProperty": {
14357 "assembly": "@aws-cdk/aws-ecs",
14358 "datatype": true,
14359 "docs": {
14360 "custom": {
14361 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html",
14362 "exampleMetadata": "fixture=_generated"
14363 },
14364 "stability": "external",
14365 "summary": "Details on the load balancer or load balancers to use with a task set.",
14366 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst loadBalancerProperty: ecs.CfnTaskSet.LoadBalancerProperty = {\n containerName: 'containerName',\n containerPort: 123,\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n};"
14367 },
14368 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.LoadBalancerProperty",
14369 "kind": "interface",
14370 "locationInModule": {
14371 "filename": "lib/ecs.generated.ts",
14372 "line": 7145
14373 },
14374 "name": "LoadBalancerProperty",
14375 "namespace": "CfnTaskSet",
14376 "properties": [
14377 {
14378 "abstract": true,
14379 "docs": {
14380 "custom": {
14381 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containername"
14382 },
14383 "stability": "external",
14384 "summary": "The name of the container (as it appears in a container definition) to associate with the load balancer."
14385 },
14386 "immutable": true,
14387 "locationInModule": {
14388 "filename": "lib/ecs.generated.ts",
14389 "line": 7151
14390 },
14391 "name": "containerName",
14392 "optional": true,
14393 "type": {
14394 "primitive": "string"
14395 }
14396 },
14397 {
14398 "abstract": true,
14399 "docs": {
14400 "custom": {
14401 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containerport"
14402 },
14403 "remarks": "This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the `hostPort` of the port mapping.",
14404 "stability": "external",
14405 "summary": "The port on the container to associate with the load balancer."
14406 },
14407 "immutable": true,
14408 "locationInModule": {
14409 "filename": "lib/ecs.generated.ts",
14410 "line": 7157
14411 },
14412 "name": "containerPort",
14413 "optional": true,
14414 "type": {
14415 "primitive": "number"
14416 }
14417 },
14418 {
14419 "abstract": true,
14420 "docs": {
14421 "custom": {
14422 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-loadbalancername"
14423 },
14424 "remarks": "A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.",
14425 "stability": "external",
14426 "summary": "The name of the load balancer to associate with the Amazon ECS service or task set."
14427 },
14428 "immutable": true,
14429 "locationInModule": {
14430 "filename": "lib/ecs.generated.ts",
14431 "line": 7165
14432 },
14433 "name": "loadBalancerName",
14434 "optional": true,
14435 "type": {
14436 "primitive": "string"
14437 }
14438 },
14439 {
14440 "abstract": true,
14441 "docs": {
14442 "custom": {
14443 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-targetgrouparn"
14444 },
14445 "remarks": "A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.\n\nFor services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> If your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance` . Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.",
14446 "stability": "external",
14447 "summary": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set."
14448 },
14449 "immutable": true,
14450 "locationInModule": {
14451 "filename": "lib/ecs.generated.ts",
14452 "line": 7179
14453 },
14454 "name": "targetGroupArn",
14455 "optional": true,
14456 "type": {
14457 "primitive": "string"
14458 }
14459 }
14460 ],
14461 "symbolId": "lib/ecs.generated:CfnTaskSet.LoadBalancerProperty"
14462 },
14463 "@aws-cdk/aws-ecs.CfnTaskSet.NetworkConfigurationProperty": {
14464 "assembly": "@aws-cdk/aws-ecs",
14465 "datatype": true,
14466 "docs": {
14467 "custom": {
14468 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html",
14469 "exampleMetadata": "fixture=_generated"
14470 },
14471 "stability": "external",
14472 "summary": "The network configuration for a task.",
14473 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst networkConfigurationProperty: ecs.CfnTaskSet.NetworkConfigurationProperty = {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n};"
14474 },
14475 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.NetworkConfigurationProperty",
14476 "kind": "interface",
14477 "locationInModule": {
14478 "filename": "lib/ecs.generated.ts",
14479 "line": 7249
14480 },
14481 "name": "NetworkConfigurationProperty",
14482 "namespace": "CfnTaskSet",
14483 "properties": [
14484 {
14485 "abstract": true,
14486 "docs": {
14487 "custom": {
14488 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html#cfn-ecs-taskset-networkconfiguration-awsvpcconfiguration"
14489 },
14490 "remarks": "> All specified subnets and security groups must be from the same VPC.",
14491 "stability": "external",
14492 "summary": "The VPC subnets and security groups that are associated with a task."
14493 },
14494 "immutable": true,
14495 "locationInModule": {
14496 "filename": "lib/ecs.generated.ts",
14497 "line": 7257
14498 },
14499 "name": "awsVpcConfiguration",
14500 "optional": true,
14501 "type": {
14502 "union": {
14503 "types": [
14504 {
14505 "fqn": "@aws-cdk/core.IResolvable"
14506 },
14507 {
14508 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.AwsVpcConfigurationProperty"
14509 }
14510 ]
14511 }
14512 }
14513 }
14514 ],
14515 "symbolId": "lib/ecs.generated:CfnTaskSet.NetworkConfigurationProperty"
14516 },
14517 "@aws-cdk/aws-ecs.CfnTaskSet.ScaleProperty": {
14518 "assembly": "@aws-cdk/aws-ecs",
14519 "datatype": true,
14520 "docs": {
14521 "custom": {
14522 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html",
14523 "exampleMetadata": "fixture=_generated"
14524 },
14525 "stability": "external",
14526 "summary": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.",
14527 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst scaleProperty: ecs.CfnTaskSet.ScaleProperty = {\n unit: 'unit',\n value: 123,\n};"
14528 },
14529 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ScaleProperty",
14530 "kind": "interface",
14531 "locationInModule": {
14532 "filename": "lib/ecs.generated.ts",
14533 "line": 7318
14534 },
14535 "name": "ScaleProperty",
14536 "namespace": "CfnTaskSet",
14537 "properties": [
14538 {
14539 "abstract": true,
14540 "docs": {
14541 "custom": {
14542 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-unit"
14543 },
14544 "stability": "external",
14545 "summary": "The unit of measure for the scale value."
14546 },
14547 "immutable": true,
14548 "locationInModule": {
14549 "filename": "lib/ecs.generated.ts",
14550 "line": 7324
14551 },
14552 "name": "unit",
14553 "optional": true,
14554 "type": {
14555 "primitive": "string"
14556 }
14557 },
14558 {
14559 "abstract": true,
14560 "docs": {
14561 "custom": {
14562 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-value"
14563 },
14564 "remarks": "Accepted values are numbers between 0 and 100.",
14565 "stability": "external",
14566 "summary": "The value, specified as a percent total of a service's `desiredCount` , to scale the task set."
14567 },
14568 "immutable": true,
14569 "locationInModule": {
14570 "filename": "lib/ecs.generated.ts",
14571 "line": 7330
14572 },
14573 "name": "value",
14574 "optional": true,
14575 "type": {
14576 "primitive": "number"
14577 }
14578 }
14579 ],
14580 "symbolId": "lib/ecs.generated:CfnTaskSet.ScaleProperty"
14581 },
14582 "@aws-cdk/aws-ecs.CfnTaskSet.ServiceRegistryProperty": {
14583 "assembly": "@aws-cdk/aws-ecs",
14584 "datatype": true,
14585 "docs": {
14586 "custom": {
14587 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html",
14588 "exampleMetadata": "fixture=_generated"
14589 },
14590 "remarks": "Each service may be associated with one service registry. Multiple service registries for each service are not supported.\n\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.",
14591 "stability": "external",
14592 "summary": "The details for the service registry.",
14593 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst serviceRegistryProperty: ecs.CfnTaskSet.ServiceRegistryProperty = {\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n};"
14594 },
14595 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ServiceRegistryProperty",
14596 "kind": "interface",
14597 "locationInModule": {
14598 "filename": "lib/ecs.generated.ts",
14599 "line": 7398
14600 },
14601 "name": "ServiceRegistryProperty",
14602 "namespace": "CfnTaskSet",
14603 "properties": [
14604 {
14605 "abstract": true,
14606 "docs": {
14607 "custom": {
14608 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containername"
14609 },
14610 "remarks": "It's already specified in the task definition. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can't specify both.",
14611 "stability": "external",
14612 "summary": "The container name value to be used for your service discovery service."
14613 },
14614 "immutable": true,
14615 "locationInModule": {
14616 "filename": "lib/ecs.generated.ts",
14617 "line": 7404
14618 },
14619 "name": "containerName",
14620 "optional": true,
14621 "type": {
14622 "primitive": "string"
14623 }
14624 },
14625 {
14626 "abstract": true,
14627 "docs": {
14628 "custom": {
14629 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containerport"
14630 },
14631 "remarks": "It's already specified in the task definition. If the task definition your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can't specify both.",
14632 "stability": "external",
14633 "summary": "The port value to be used for your service discovery service."
14634 },
14635 "immutable": true,
14636 "locationInModule": {
14637 "filename": "lib/ecs.generated.ts",
14638 "line": 7410
14639 },
14640 "name": "containerPort",
14641 "optional": true,
14642 "type": {
14643 "primitive": "number"
14644 }
14645 },
14646 {
14647 "abstract": true,
14648 "docs": {
14649 "custom": {
14650 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-port"
14651 },
14652 "remarks": "This field might be used if both the `awsvpc` network mode and SRV records are used.",
14653 "stability": "external",
14654 "summary": "The port value used if your service discovery service specified an SRV record."
14655 },
14656 "immutable": true,
14657 "locationInModule": {
14658 "filename": "lib/ecs.generated.ts",
14659 "line": 7416
14660 },
14661 "name": "port",
14662 "optional": true,
14663 "type": {
14664 "primitive": "number"
14665 }
14666 },
14667 {
14668 "abstract": true,
14669 "docs": {
14670 "custom": {
14671 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-registryarn"
14672 },
14673 "remarks": "The currently supported service registry is AWS Cloud Map . For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) .",
14674 "stability": "external",
14675 "summary": "The Amazon Resource Name (ARN) of the service registry."
14676 },
14677 "immutable": true,
14678 "locationInModule": {
14679 "filename": "lib/ecs.generated.ts",
14680 "line": 7422
14681 },
14682 "name": "registryArn",
14683 "optional": true,
14684 "type": {
14685 "primitive": "string"
14686 }
14687 }
14688 ],
14689 "symbolId": "lib/ecs.generated:CfnTaskSet.ServiceRegistryProperty"
14690 },
14691 "@aws-cdk/aws-ecs.CfnTaskSetProps": {
14692 "assembly": "@aws-cdk/aws-ecs",
14693 "datatype": true,
14694 "docs": {
14695 "custom": {
14696 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html",
14697 "exampleMetadata": "fixture=_generated"
14698 },
14699 "stability": "external",
14700 "summary": "Properties for defining a `CfnTaskSet`.",
14701 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst cfnTaskSetProps: ecs.CfnTaskSetProps = {\n cluster: 'cluster',\n service: 'service',\n taskDefinition: 'taskDefinition',\n\n // the properties below are optional\n externalId: 'externalId',\n launchType: 'launchType',\n loadBalancers: [{\n containerName: 'containerName',\n containerPort: 123,\n loadBalancerName: 'loadBalancerName',\n targetGroupArn: 'targetGroupArn',\n }],\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n platformVersion: 'platformVersion',\n scale: {\n unit: 'unit',\n value: 123,\n },\n serviceRegistries: [{\n containerName: 'containerName',\n containerPort: 123,\n port: 123,\n registryArn: 'registryArn',\n }],\n};"
14702 },
14703 "fqn": "@aws-cdk/aws-ecs.CfnTaskSetProps",
14704 "kind": "interface",
14705 "locationInModule": {
14706 "filename": "lib/ecs.generated.ts",
14707 "line": 6726
14708 },
14709 "name": "CfnTaskSetProps",
14710 "properties": [
14711 {
14712 "abstract": true,
14713 "docs": {
14714 "custom": {
14715 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster"
14716 },
14717 "stability": "external",
14718 "summary": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in."
14719 },
14720 "immutable": true,
14721 "locationInModule": {
14722 "filename": "lib/ecs.generated.ts",
14723 "line": 6733
14724 },
14725 "name": "cluster",
14726 "type": {
14727 "primitive": "string"
14728 }
14729 },
14730 {
14731 "abstract": true,
14732 "docs": {
14733 "custom": {
14734 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service"
14735 },
14736 "stability": "external",
14737 "summary": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in."
14738 },
14739 "immutable": true,
14740 "locationInModule": {
14741 "filename": "lib/ecs.generated.ts",
14742 "line": 6740
14743 },
14744 "name": "service",
14745 "type": {
14746 "primitive": "string"
14747 }
14748 },
14749 {
14750 "abstract": true,
14751 "docs": {
14752 "custom": {
14753 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition"
14754 },
14755 "stability": "external",
14756 "summary": "The task definition for the tasks in the task set to use."
14757 },
14758 "immutable": true,
14759 "locationInModule": {
14760 "filename": "lib/ecs.generated.ts",
14761 "line": 6747
14762 },
14763 "name": "taskDefinition",
14764 "type": {
14765 "primitive": "string"
14766 }
14767 },
14768 {
14769 "abstract": true,
14770 "docs": {
14771 "custom": {
14772 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid"
14773 },
14774 "remarks": "If the task set is associated with a service discovery registry, the tasks in this task set will have the `ECS_TASK_SET_EXTERNAL_ID` AWS Cloud Map attribute set to the provided value.",
14775 "stability": "external",
14776 "summary": "An optional non-unique tag that identifies this task set in external systems."
14777 },
14778 "immutable": true,
14779 "locationInModule": {
14780 "filename": "lib/ecs.generated.ts",
14781 "line": 6754
14782 },
14783 "name": "externalId",
14784 "optional": true,
14785 "type": {
14786 "primitive": "string"
14787 }
14788 },
14789 {
14790 "abstract": true,
14791 "docs": {
14792 "custom": {
14793 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype"
14794 },
14795 "remarks": "For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* .\n\nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted.",
14796 "stability": "external",
14797 "summary": "The launch type that new tasks in the task set uses."
14798 },
14799 "immutable": true,
14800 "locationInModule": {
14801 "filename": "lib/ecs.generated.ts",
14802 "line": 6763
14803 },
14804 "name": "launchType",
14805 "optional": true,
14806 "type": {
14807 "primitive": "string"
14808 }
14809 },
14810 {
14811 "abstract": true,
14812 "docs": {
14813 "custom": {
14814 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers"
14815 },
14816 "remarks": "The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.",
14817 "stability": "external",
14818 "summary": "A load balancer object representing the load balancer to use with the task set."
14819 },
14820 "immutable": true,
14821 "locationInModule": {
14822 "filename": "lib/ecs.generated.ts",
14823 "line": 6770
14824 },
14825 "name": "loadBalancers",
14826 "optional": true,
14827 "type": {
14828 "union": {
14829 "types": [
14830 {
14831 "fqn": "@aws-cdk/core.IResolvable"
14832 },
14833 {
14834 "collection": {
14835 "elementtype": {
14836 "union": {
14837 "types": [
14838 {
14839 "fqn": "@aws-cdk/core.IResolvable"
14840 },
14841 {
14842 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.LoadBalancerProperty"
14843 }
14844 ]
14845 }
14846 },
14847 "kind": "array"
14848 }
14849 }
14850 ]
14851 }
14852 }
14853 },
14854 {
14855 "abstract": true,
14856 "docs": {
14857 "custom": {
14858 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration"
14859 },
14860 "stability": "external",
14861 "summary": "The network configuration for the task set."
14862 },
14863 "immutable": true,
14864 "locationInModule": {
14865 "filename": "lib/ecs.generated.ts",
14866 "line": 6777
14867 },
14868 "name": "networkConfiguration",
14869 "optional": true,
14870 "type": {
14871 "union": {
14872 "types": [
14873 {
14874 "fqn": "@aws-cdk/core.IResolvable"
14875 },
14876 {
14877 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.NetworkConfigurationProperty"
14878 }
14879 ]
14880 }
14881 }
14882 },
14883 {
14884 "abstract": true,
14885 "docs": {
14886 "custom": {
14887 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion"
14888 },
14889 "remarks": "A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used.",
14890 "stability": "external",
14891 "summary": "The platform version that the tasks in the task set uses."
14892 },
14893 "immutable": true,
14894 "locationInModule": {
14895 "filename": "lib/ecs.generated.ts",
14896 "line": 6784
14897 },
14898 "name": "platformVersion",
14899 "optional": true,
14900 "type": {
14901 "primitive": "string"
14902 }
14903 },
14904 {
14905 "abstract": true,
14906 "docs": {
14907 "custom": {
14908 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale"
14909 },
14910 "stability": "external",
14911 "summary": "A floating-point percentage of your desired number of tasks to place and keep running in the task set."
14912 },
14913 "immutable": true,
14914 "locationInModule": {
14915 "filename": "lib/ecs.generated.ts",
14916 "line": 6791
14917 },
14918 "name": "scale",
14919 "optional": true,
14920 "type": {
14921 "union": {
14922 "types": [
14923 {
14924 "fqn": "@aws-cdk/core.IResolvable"
14925 },
14926 {
14927 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ScaleProperty"
14928 }
14929 ]
14930 }
14931 }
14932 },
14933 {
14934 "abstract": true,
14935 "docs": {
14936 "custom": {
14937 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries"
14938 },
14939 "remarks": "For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .",
14940 "stability": "external",
14941 "summary": "The details of the service discovery registries to assign to this task set."
14942 },
14943 "immutable": true,
14944 "locationInModule": {
14945 "filename": "lib/ecs.generated.ts",
14946 "line": 6798
14947 },
14948 "name": "serviceRegistries",
14949 "optional": true,
14950 "type": {
14951 "union": {
14952 "types": [
14953 {
14954 "fqn": "@aws-cdk/core.IResolvable"
14955 },
14956 {
14957 "collection": {
14958 "elementtype": {
14959 "union": {
14960 "types": [
14961 {
14962 "fqn": "@aws-cdk/core.IResolvable"
14963 },
14964 {
14965 "fqn": "@aws-cdk/aws-ecs.CfnTaskSet.ServiceRegistryProperty"
14966 }
14967 ]
14968 }
14969 },
14970 "kind": "array"
14971 }
14972 }
14973 ]
14974 }
14975 }
14976 }
14977 ],
14978 "symbolId": "lib/ecs.generated:CfnTaskSetProps"
14979 },
14980 "@aws-cdk/aws-ecs.CloudMapNamespaceOptions": {
14981 "assembly": "@aws-cdk/aws-ecs",
14982 "datatype": true,
14983 "docs": {
14984 "stability": "stable",
14985 "summary": "The options for creating an AWS Cloud Map namespace.",
14986 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as servicediscovery from '@aws-cdk/aws-servicediscovery';\n\ndeclare const vpc: ec2.Vpc;\nconst cloudMapNamespaceOptions: ecs.CloudMapNamespaceOptions = {\n name: 'name',\n\n // the properties below are optional\n type: servicediscovery.NamespaceType.HTTP,\n vpc: vpc,\n};",
14987 "custom": {
14988 "exampleMetadata": "fixture=_generated"
14989 }
14990 },
14991 "fqn": "@aws-cdk/aws-ecs.CloudMapNamespaceOptions",
14992 "kind": "interface",
14993 "locationInModule": {
14994 "filename": "lib/cluster.ts",
14995 "line": 877
14996 },
14997 "name": "CloudMapNamespaceOptions",
14998 "properties": [
14999 {
15000 "abstract": true,
15001 "docs": {
15002 "stability": "stable",
15003 "summary": "The name of the namespace, such as example.com."
15004 },
15005 "immutable": true,
15006 "locationInModule": {
15007 "filename": "lib/cluster.ts",
15008 "line": 881
15009 },
15010 "name": "name",
15011 "type": {
15012 "primitive": "string"
15013 }
15014 },
15015 {
15016 "abstract": true,
15017 "docs": {
15018 "default": "PrivateDns",
15019 "stability": "stable",
15020 "summary": "The type of CloudMap Namespace to create."
15021 },
15022 "immutable": true,
15023 "locationInModule": {
15024 "filename": "lib/cluster.ts",
15025 "line": 888
15026 },
15027 "name": "type",
15028 "optional": true,
15029 "type": {
15030 "fqn": "@aws-cdk/aws-servicediscovery.NamespaceType"
15031 }
15032 },
15033 {
15034 "abstract": true,
15035 "docs": {
15036 "default": "VPC of the cluster for Private DNS Namespace, otherwise none",
15037 "remarks": "This property is required for private DNS namespaces.",
15038 "stability": "stable",
15039 "summary": "The VPC to associate the namespace with."
15040 },
15041 "immutable": true,
15042 "locationInModule": {
15043 "filename": "lib/cluster.ts",
15044 "line": 895
15045 },
15046 "name": "vpc",
15047 "optional": true,
15048 "type": {
15049 "fqn": "@aws-cdk/aws-ec2.IVpc"
15050 }
15051 }
15052 ],
15053 "symbolId": "lib/cluster:CloudMapNamespaceOptions"
15054 },
15055 "@aws-cdk/aws-ecs.CloudMapOptions": {
15056 "assembly": "@aws-cdk/aws-ecs",
15057 "datatype": true,
15058 "docs": {
15059 "custom": {
15060 "exampleMetadata": "infused"
15061 },
15062 "example": "declare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\nconst service = new ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create A records - useful for AWSVPC network mode.\n dnsRecordType: cloudmap.DnsRecordType.A,\n },\n});",
15063 "stability": "stable",
15064 "summary": "The options to enabling AWS Cloud Map for an Amazon ECS service."
15065 },
15066 "fqn": "@aws-cdk/aws-ecs.CloudMapOptions",
15067 "kind": "interface",
15068 "locationInModule": {
15069 "filename": "lib/base/base-service.ts",
15070 "line": 967
15071 },
15072 "name": "CloudMapOptions",
15073 "properties": [
15074 {
15075 "abstract": true,
15076 "docs": {
15077 "default": "- the defaultCloudMapNamespace associated to the cluster",
15078 "stability": "stable",
15079 "summary": "The service discovery namespace for the Cloud Map service to attach to the ECS service."
15080 },
15081 "immutable": true,
15082 "locationInModule": {
15083 "filename": "lib/base/base-service.ts",
15084 "line": 980
15085 },
15086 "name": "cloudMapNamespace",
15087 "optional": true,
15088 "type": {
15089 "fqn": "@aws-cdk/aws-servicediscovery.INamespace"
15090 }
15091 },
15092 {
15093 "abstract": true,
15094 "docs": {
15095 "default": "- the task definition's default container",
15096 "stability": "stable",
15097 "summary": "The container to point to for a SRV record."
15098 },
15099 "immutable": true,
15100 "locationInModule": {
15101 "filename": "lib/base/base-service.ts",
15102 "line": 1008
15103 },
15104 "name": "container",
15105 "optional": true,
15106 "type": {
15107 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
15108 }
15109 },
15110 {
15111 "abstract": true,
15112 "docs": {
15113 "default": "- the default port of the task definition's default container",
15114 "stability": "stable",
15115 "summary": "The port to point to for a SRV record."
15116 },
15117 "immutable": true,
15118 "locationInModule": {
15119 "filename": "lib/base/base-service.ts",
15120 "line": 1014
15121 },
15122 "name": "containerPort",
15123 "optional": true,
15124 "type": {
15125 "primitive": "number"
15126 }
15127 },
15128 {
15129 "abstract": true,
15130 "docs": {
15131 "default": "- DnsRecordType.A if TaskDefinition.networkMode = AWS_VPC, otherwise DnsRecordType.SRV",
15132 "remarks": "The supported record types are A or SRV.",
15133 "stability": "stable",
15134 "summary": "The DNS record type that you want AWS Cloud Map to create."
15135 },
15136 "immutable": true,
15137 "locationInModule": {
15138 "filename": "lib/base/base-service.ts",
15139 "line": 987
15140 },
15141 "name": "dnsRecordType",
15142 "optional": true,
15143 "type": {
15144 "fqn": "@aws-cdk/aws-servicediscovery.DnsRecordType"
15145 }
15146 },
15147 {
15148 "abstract": true,
15149 "docs": {
15150 "default": "Duration.minutes(1)",
15151 "stability": "stable",
15152 "summary": "The amount of time that you want DNS resolvers to cache the settings for this record."
15153 },
15154 "immutable": true,
15155 "locationInModule": {
15156 "filename": "lib/base/base-service.ts",
15157 "line": 994
15158 },
15159 "name": "dnsTtl",
15160 "optional": true,
15161 "type": {
15162 "fqn": "@aws-cdk/core.Duration"
15163 }
15164 },
15165 {
15166 "abstract": true,
15167 "docs": {
15168 "remarks": "NOTE: This is used for HealthCheckCustomConfig",
15169 "stability": "stable",
15170 "summary": "The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance."
15171 },
15172 "immutable": true,
15173 "locationInModule": {
15174 "filename": "lib/base/base-service.ts",
15175 "line": 1002
15176 },
15177 "name": "failureThreshold",
15178 "optional": true,
15179 "type": {
15180 "primitive": "number"
15181 }
15182 },
15183 {
15184 "abstract": true,
15185 "docs": {
15186 "default": "CloudFormation-generated name",
15187 "stability": "stable",
15188 "summary": "The name of the Cloud Map service to attach to the ECS service."
15189 },
15190 "immutable": true,
15191 "locationInModule": {
15192 "filename": "lib/base/base-service.ts",
15193 "line": 973
15194 },
15195 "name": "name",
15196 "optional": true,
15197 "type": {
15198 "primitive": "string"
15199 }
15200 }
15201 ],
15202 "symbolId": "lib/base/base-service:CloudMapOptions"
15203 },
15204 "@aws-cdk/aws-ecs.Cluster": {
15205 "assembly": "@aws-cdk/aws-ecs",
15206 "base": "@aws-cdk/core.Resource",
15207 "docs": {
15208 "custom": {
15209 "exampleMetadata": "infused"
15210 },
15211 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux2(),\n minCapacity: 0,\n maxCapacity: 100,\n});\n\nconst capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {\n autoScalingGroup,\n});\ncluster.addAsgCapacityProvider(capacityProvider);\n\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n memoryReservationMiB: 256,\n});\n\nnew ecs.Ec2Service(this, 'EC2Service', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: capacityProvider.capacityProviderName,\n weight: 1,\n },\n ],\n});",
15212 "stability": "stable",
15213 "summary": "A regional grouping of one or more container instances on which you can run tasks and services."
15214 },
15215 "fqn": "@aws-cdk/aws-ecs.Cluster",
15216 "initializer": {
15217 "docs": {
15218 "stability": "stable",
15219 "summary": "Constructs a new instance of the Cluster class."
15220 },
15221 "locationInModule": {
15222 "filename": "lib/cluster.ts",
15223 "line": 191
15224 },
15225 "parameters": [
15226 {
15227 "name": "scope",
15228 "type": {
15229 "fqn": "constructs.Construct"
15230 }
15231 },
15232 {
15233 "name": "id",
15234 "type": {
15235 "primitive": "string"
15236 }
15237 },
15238 {
15239 "name": "props",
15240 "optional": true,
15241 "type": {
15242 "fqn": "@aws-cdk/aws-ecs.ClusterProps"
15243 }
15244 }
15245 ]
15246 },
15247 "interfaces": [
15248 "@aws-cdk/aws-ecs.ICluster"
15249 ],
15250 "kind": "class",
15251 "locationInModule": {
15252 "filename": "lib/cluster.ts",
15253 "line": 100
15254 },
15255 "methods": [
15256 {
15257 "docs": {
15258 "remarks": "This does not provide access to the vpc, hasEc2Capacity, or connections -\nuse the `fromClusterAttributes` method to access those properties.",
15259 "stability": "stable",
15260 "summary": "Import an existing cluster to the stack from the cluster ARN."
15261 },
15262 "locationInModule": {
15263 "filename": "lib/cluster.ts",
15264 "line": 113
15265 },
15266 "name": "fromClusterArn",
15267 "parameters": [
15268 {
15269 "name": "scope",
15270 "type": {
15271 "fqn": "constructs.Construct"
15272 }
15273 },
15274 {
15275 "name": "id",
15276 "type": {
15277 "primitive": "string"
15278 }
15279 },
15280 {
15281 "name": "clusterArn",
15282 "type": {
15283 "primitive": "string"
15284 }
15285 }
15286 ],
15287 "returns": {
15288 "type": {
15289 "fqn": "@aws-cdk/aws-ecs.ICluster"
15290 }
15291 },
15292 "static": true
15293 },
15294 {
15295 "docs": {
15296 "stability": "stable",
15297 "summary": "Import an existing cluster to the stack from its attributes."
15298 },
15299 "locationInModule": {
15300 "filename": "lib/cluster.ts",
15301 "line": 104
15302 },
15303 "name": "fromClusterAttributes",
15304 "parameters": [
15305 {
15306 "name": "scope",
15307 "type": {
15308 "fqn": "constructs.Construct"
15309 }
15310 },
15311 {
15312 "name": "id",
15313 "type": {
15314 "primitive": "string"
15315 }
15316 },
15317 {
15318 "name": "attrs",
15319 "type": {
15320 "fqn": "@aws-cdk/aws-ecs.ClusterAttributes"
15321 }
15322 }
15323 ],
15324 "returns": {
15325 "type": {
15326 "fqn": "@aws-cdk/aws-ecs.ICluster"
15327 }
15328 },
15329 "static": true
15330 },
15331 {
15332 "docs": {
15333 "stability": "stable",
15334 "summary": "This method adds an Auto Scaling Group Capacity Provider to a cluster."
15335 },
15336 "locationInModule": {
15337 "filename": "lib/cluster.ts",
15338 "line": 362
15339 },
15340 "name": "addAsgCapacityProvider",
15341 "parameters": [
15342 {
15343 "docs": {
15344 "summary": "the capacity provider to add to this cluster."
15345 },
15346 "name": "provider",
15347 "type": {
15348 "fqn": "@aws-cdk/aws-ecs.AsgCapacityProvider"
15349 }
15350 },
15351 {
15352 "name": "options",
15353 "optional": true,
15354 "type": {
15355 "fqn": "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions"
15356 }
15357 }
15358 ]
15359 },
15360 {
15361 "docs": {
15362 "deprecated": "Use {@link Cluster.addAsgCapacityProvider} instead.",
15363 "stability": "deprecated",
15364 "summary": "This method adds compute capacity to a cluster using the specified AutoScalingGroup."
15365 },
15366 "locationInModule": {
15367 "filename": "lib/cluster.ts",
15368 "line": 386
15369 },
15370 "name": "addAutoScalingGroup",
15371 "parameters": [
15372 {
15373 "docs": {
15374 "remarks": "[disable-awslint:ref-via-interface] is needed in order to install the ECS\nagent by updating the ASGs user data.",
15375 "summary": "the ASG to add to this cluster."
15376 },
15377 "name": "autoScalingGroup",
15378 "type": {
15379 "fqn": "@aws-cdk/aws-autoscaling.AutoScalingGroup"
15380 }
15381 },
15382 {
15383 "name": "options",
15384 "optional": true,
15385 "type": {
15386 "fqn": "@aws-cdk/aws-ecs.AddAutoScalingGroupCapacityOptions"
15387 }
15388 }
15389 ]
15390 },
15391 {
15392 "docs": {
15393 "remarks": "This method adds compute capacity to a cluster by creating an AutoScalingGroup with the specified options.\n\nReturns the AutoScalingGroup so you can add autoscaling settings to it.",
15394 "stability": "stable",
15395 "summary": "It is highly recommended to use {@link Cluster.addAsgCapacityProvider} instead of this method."
15396 },
15397 "locationInModule": {
15398 "filename": "lib/cluster.ts",
15399 "line": 331
15400 },
15401 "name": "addCapacity",
15402 "parameters": [
15403 {
15404 "name": "id",
15405 "type": {
15406 "primitive": "string"
15407 }
15408 },
15409 {
15410 "name": "options",
15411 "type": {
15412 "fqn": "@aws-cdk/aws-ecs.AddCapacityOptions"
15413 }
15414 }
15415 ],
15416 "returns": {
15417 "type": {
15418 "fqn": "@aws-cdk/aws-autoscaling.AutoScalingGroup"
15419 }
15420 }
15421 },
15422 {
15423 "docs": {
15424 "deprecated": "Use {@link enableFargateCapacityProviders} instead.",
15425 "see": "{@link addAsgCapacityProvider} to add an Auto Scaling Group capacity provider to the cluster.",
15426 "stability": "deprecated",
15427 "summary": "This method enables the Fargate or Fargate Spot capacity providers on the cluster."
15428 },
15429 "locationInModule": {
15430 "filename": "lib/cluster.ts",
15431 "line": 492
15432 },
15433 "name": "addCapacityProvider",
15434 "parameters": [
15435 {
15436 "docs": {
15437 "summary": "the capacity provider to add to this cluster."
15438 },
15439 "name": "provider",
15440 "type": {
15441 "primitive": "string"
15442 }
15443 }
15444 ]
15445 },
15446 {
15447 "docs": {
15448 "remarks": "NOTE: HttpNamespaces are not supported, as ECS always requires a DNSConfig when registering an instance to a Cloud\nMap service.",
15449 "stability": "stable",
15450 "summary": "Add an AWS Cloud Map DNS namespace for this cluster."
15451 },
15452 "locationInModule": {
15453 "filename": "lib/cluster.ts",
15454 "line": 294
15455 },
15456 "name": "addDefaultCloudMapNamespace",
15457 "parameters": [
15458 {
15459 "name": "options",
15460 "type": {
15461 "fqn": "@aws-cdk/aws-ecs.CloudMapNamespaceOptions"
15462 }
15463 }
15464 ],
15465 "returns": {
15466 "type": {
15467 "fqn": "@aws-cdk/aws-servicediscovery.INamespace"
15468 }
15469 }
15470 },
15471 {
15472 "docs": {
15473 "stability": "stable",
15474 "summary": "Enable the Fargate capacity providers for this cluster."
15475 },
15476 "locationInModule": {
15477 "filename": "lib/cluster.ts",
15478 "line": 254
15479 },
15480 "name": "enableFargateCapacityProviders"
15481 },
15482 {
15483 "docs": {
15484 "stability": "stable",
15485 "summary": "This method returns the specifed CloudWatch metric for this cluster."
15486 },
15487 "locationInModule": {
15488 "filename": "lib/cluster.ts",
15489 "line": 589
15490 },
15491 "name": "metric",
15492 "parameters": [
15493 {
15494 "name": "metricName",
15495 "type": {
15496 "primitive": "string"
15497 }
15498 },
15499 {
15500 "name": "props",
15501 "optional": true,
15502 "type": {
15503 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
15504 }
15505 }
15506 ],
15507 "returns": {
15508 "type": {
15509 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
15510 }
15511 }
15512 },
15513 {
15514 "docs": {
15515 "default": "average over 5 minutes",
15516 "stability": "stable",
15517 "summary": "This method returns the CloudWatch metric for this clusters CPU reservation."
15518 },
15519 "locationInModule": {
15520 "filename": "lib/cluster.ts",
15521 "line": 555
15522 },
15523 "name": "metricCpuReservation",
15524 "parameters": [
15525 {
15526 "name": "props",
15527 "optional": true,
15528 "type": {
15529 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
15530 }
15531 }
15532 ],
15533 "returns": {
15534 "type": {
15535 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
15536 }
15537 }
15538 },
15539 {
15540 "docs": {
15541 "default": "average over 5 minutes",
15542 "stability": "stable",
15543 "summary": "This method returns the CloudWatch metric for this clusters CPU utilization."
15544 },
15545 "locationInModule": {
15546 "filename": "lib/cluster.ts",
15547 "line": 564
15548 },
15549 "name": "metricCpuUtilization",
15550 "parameters": [
15551 {
15552 "name": "props",
15553 "optional": true,
15554 "type": {
15555 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
15556 }
15557 }
15558 ],
15559 "returns": {
15560 "type": {
15561 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
15562 }
15563 }
15564 },
15565 {
15566 "docs": {
15567 "default": "average over 5 minutes",
15568 "stability": "stable",
15569 "summary": "This method returns the CloudWatch metric for this clusters memory reservation."
15570 },
15571 "locationInModule": {
15572 "filename": "lib/cluster.ts",
15573 "line": 573
15574 },
15575 "name": "metricMemoryReservation",
15576 "parameters": [
15577 {
15578 "name": "props",
15579 "optional": true,
15580 "type": {
15581 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
15582 }
15583 }
15584 ],
15585 "returns": {
15586 "type": {
15587 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
15588 }
15589 }
15590 },
15591 {
15592 "docs": {
15593 "default": "average over 5 minutes",
15594 "stability": "stable",
15595 "summary": "This method returns the CloudWatch metric for this clusters memory utilization."
15596 },
15597 "locationInModule": {
15598 "filename": "lib/cluster.ts",
15599 "line": 582
15600 },
15601 "name": "metricMemoryUtilization",
15602 "parameters": [
15603 {
15604 "name": "props",
15605 "optional": true,
15606 "type": {
15607 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
15608 }
15609 }
15610 ],
15611 "returns": {
15612 "type": {
15613 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
15614 }
15615 }
15616 }
15617 ],
15618 "name": "Cluster",
15619 "properties": [
15620 {
15621 "docs": {
15622 "stability": "stable",
15623 "summary": "The Amazon Resource Name (ARN) that identifies the cluster."
15624 },
15625 "immutable": true,
15626 "locationInModule": {
15627 "filename": "lib/cluster.ts",
15628 "line": 156
15629 },
15630 "name": "clusterArn",
15631 "overrides": "@aws-cdk/aws-ecs.ICluster",
15632 "type": {
15633 "primitive": "string"
15634 }
15635 },
15636 {
15637 "docs": {
15638 "stability": "stable",
15639 "summary": "The name of the cluster."
15640 },
15641 "immutable": true,
15642 "locationInModule": {
15643 "filename": "lib/cluster.ts",
15644 "line": 161
15645 },
15646 "name": "clusterName",
15647 "overrides": "@aws-cdk/aws-ecs.ICluster",
15648 "type": {
15649 "primitive": "string"
15650 }
15651 },
15652 {
15653 "docs": {
15654 "stability": "stable",
15655 "summary": "Manage the allowed network connections for the cluster with Security Groups."
15656 },
15657 "immutable": true,
15658 "locationInModule": {
15659 "filename": "lib/cluster.ts",
15660 "line": 146
15661 },
15662 "name": "connections",
15663 "overrides": "@aws-cdk/aws-ecs.ICluster",
15664 "type": {
15665 "fqn": "@aws-cdk/aws-ec2.Connections"
15666 }
15667 },
15668 {
15669 "docs": {
15670 "stability": "stable",
15671 "summary": "Whether the cluster has EC2 capacity associated with it."
15672 },
15673 "immutable": true,
15674 "locationInModule": {
15675 "filename": "lib/cluster.ts",
15676 "line": 539
15677 },
15678 "name": "hasEc2Capacity",
15679 "overrides": "@aws-cdk/aws-ecs.ICluster",
15680 "type": {
15681 "primitive": "boolean"
15682 }
15683 },
15684 {
15685 "docs": {
15686 "stability": "stable",
15687 "summary": "The VPC associated with the cluster."
15688 },
15689 "immutable": true,
15690 "locationInModule": {
15691 "filename": "lib/cluster.ts",
15692 "line": 151
15693 },
15694 "name": "vpc",
15695 "overrides": "@aws-cdk/aws-ecs.ICluster",
15696 "type": {
15697 "fqn": "@aws-cdk/aws-ec2.IVpc"
15698 }
15699 },
15700 {
15701 "docs": {
15702 "stability": "stable",
15703 "summary": "Getter for autoscaling group added to cluster."
15704 },
15705 "immutable": true,
15706 "locationInModule": {
15707 "filename": "lib/cluster.ts",
15708 "line": 532
15709 },
15710 "name": "autoscalingGroup",
15711 "optional": true,
15712 "overrides": "@aws-cdk/aws-ecs.ICluster",
15713 "type": {
15714 "fqn": "@aws-cdk/aws-autoscaling.IAutoScalingGroup"
15715 }
15716 },
15717 {
15718 "docs": {
15719 "stability": "stable",
15720 "summary": "Getter for namespace added to cluster."
15721 },
15722 "immutable": true,
15723 "locationInModule": {
15724 "filename": "lib/cluster.ts",
15725 "line": 320
15726 },
15727 "name": "defaultCloudMapNamespace",
15728 "optional": true,
15729 "overrides": "@aws-cdk/aws-ecs.ICluster",
15730 "type": {
15731 "fqn": "@aws-cdk/aws-servicediscovery.INamespace"
15732 }
15733 },
15734 {
15735 "docs": {
15736 "stability": "stable",
15737 "summary": "Getter for execute command configuration associated with the cluster."
15738 },
15739 "immutable": true,
15740 "locationInModule": {
15741 "filename": "lib/cluster.ts",
15742 "line": 546
15743 },
15744 "name": "executeCommandConfiguration",
15745 "optional": true,
15746 "overrides": "@aws-cdk/aws-ecs.ICluster",
15747 "type": {
15748 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandConfiguration"
15749 }
15750 }
15751 ],
15752 "symbolId": "lib/cluster:Cluster"
15753 },
15754 "@aws-cdk/aws-ecs.ClusterAttributes": {
15755 "assembly": "@aws-cdk/aws-ecs",
15756 "datatype": true,
15757 "docs": {
15758 "stability": "stable",
15759 "summary": "The properties to import from the ECS cluster.",
15760 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as autoscaling from '@aws-cdk/aws-autoscaling';\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as servicediscovery from '@aws-cdk/aws-servicediscovery';\n\ndeclare const autoScalingGroup: autoscaling.AutoScalingGroup;\ndeclare const bucket: s3.Bucket;\ndeclare const key: kms.Key;\ndeclare const logGroup: logs.LogGroup;\ndeclare const namespace: servicediscovery.INamespace;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const vpc: ec2.Vpc;\nconst clusterAttributes: ecs.ClusterAttributes = {\n clusterName: 'clusterName',\n securityGroups: [securityGroup],\n vpc: vpc,\n\n // the properties below are optional\n autoscalingGroup: autoScalingGroup,\n clusterArn: 'clusterArn',\n defaultCloudMapNamespace: namespace,\n executeCommandConfiguration: {\n kmsKey: key,\n logConfiguration: {\n cloudWatchEncryptionEnabled: false,\n cloudWatchLogGroup: logGroup,\n s3Bucket: bucket,\n s3EncryptionEnabled: false,\n s3KeyPrefix: 's3KeyPrefix',\n },\n logging: ecs.ExecuteCommandLogging.NONE,\n },\n hasEc2Capacity: false,\n};",
15761 "custom": {
15762 "exampleMetadata": "fixture=_generated"
15763 }
15764 },
15765 "fqn": "@aws-cdk/aws-ecs.ClusterAttributes",
15766 "kind": "interface",
15767 "locationInModule": {
15768 "filename": "lib/cluster.ts",
15769 "line": 658
15770 },
15771 "name": "ClusterAttributes",
15772 "properties": [
15773 {
15774 "abstract": true,
15775 "docs": {
15776 "stability": "stable",
15777 "summary": "The name of the cluster."
15778 },
15779 "immutable": true,
15780 "locationInModule": {
15781 "filename": "lib/cluster.ts",
15782 "line": 662
15783 },
15784 "name": "clusterName",
15785 "type": {
15786 "primitive": "string"
15787 }
15788 },
15789 {
15790 "abstract": true,
15791 "docs": {
15792 "stability": "stable",
15793 "summary": "The security groups associated with the container instances registered to the cluster."
15794 },
15795 "immutable": true,
15796 "locationInModule": {
15797 "filename": "lib/cluster.ts",
15798 "line": 679
15799 },
15800 "name": "securityGroups",
15801 "type": {
15802 "collection": {
15803 "elementtype": {
15804 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
15805 },
15806 "kind": "array"
15807 }
15808 }
15809 },
15810 {
15811 "abstract": true,
15812 "docs": {
15813 "stability": "stable",
15814 "summary": "The VPC associated with the cluster."
15815 },
15816 "immutable": true,
15817 "locationInModule": {
15818 "filename": "lib/cluster.ts",
15819 "line": 674
15820 },
15821 "name": "vpc",
15822 "type": {
15823 "fqn": "@aws-cdk/aws-ec2.IVpc"
15824 }
15825 },
15826 {
15827 "abstract": true,
15828 "docs": {
15829 "default": "- No default autoscaling group",
15830 "stability": "stable",
15831 "summary": "Autoscaling group added to the cluster if capacity is added."
15832 },
15833 "immutable": true,
15834 "locationInModule": {
15835 "filename": "lib/cluster.ts",
15836 "line": 700
15837 },
15838 "name": "autoscalingGroup",
15839 "optional": true,
15840 "type": {
15841 "fqn": "@aws-cdk/aws-autoscaling.IAutoScalingGroup"
15842 }
15843 },
15844 {
15845 "abstract": true,
15846 "docs": {
15847 "default": "Derived from clusterName",
15848 "stability": "stable",
15849 "summary": "The Amazon Resource Name (ARN) that identifies the cluster."
15850 },
15851 "immutable": true,
15852 "locationInModule": {
15853 "filename": "lib/cluster.ts",
15854 "line": 669
15855 },
15856 "name": "clusterArn",
15857 "optional": true,
15858 "type": {
15859 "primitive": "string"
15860 }
15861 },
15862 {
15863 "abstract": true,
15864 "docs": {
15865 "default": "- No default namespace",
15866 "stability": "stable",
15867 "summary": "The AWS Cloud Map namespace to associate with the cluster."
15868 },
15869 "immutable": true,
15870 "locationInModule": {
15871 "filename": "lib/cluster.ts",
15872 "line": 693
15873 },
15874 "name": "defaultCloudMapNamespace",
15875 "optional": true,
15876 "type": {
15877 "fqn": "@aws-cdk/aws-servicediscovery.INamespace"
15878 }
15879 },
15880 {
15881 "abstract": true,
15882 "docs": {
15883 "default": "- none.",
15884 "stability": "stable",
15885 "summary": "The execute command configuration for the cluster."
15886 },
15887 "immutable": true,
15888 "locationInModule": {
15889 "filename": "lib/cluster.ts",
15890 "line": 707
15891 },
15892 "name": "executeCommandConfiguration",
15893 "optional": true,
15894 "type": {
15895 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandConfiguration"
15896 }
15897 },
15898 {
15899 "abstract": true,
15900 "docs": {
15901 "default": "true",
15902 "stability": "stable",
15903 "summary": "Specifies whether the cluster has EC2 instance capacity."
15904 },
15905 "immutable": true,
15906 "locationInModule": {
15907 "filename": "lib/cluster.ts",
15908 "line": 686
15909 },
15910 "name": "hasEc2Capacity",
15911 "optional": true,
15912 "type": {
15913 "primitive": "boolean"
15914 }
15915 }
15916 ],
15917 "symbolId": "lib/cluster:ClusterAttributes"
15918 },
15919 "@aws-cdk/aws-ecs.ClusterProps": {
15920 "assembly": "@aws-cdk/aws-ecs",
15921 "datatype": true,
15922 "docs": {
15923 "custom": {
15924 "exampleMetadata": "infused"
15925 },
15926 "example": "const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {\n isDefault: true,\n});\n\nconst cluster = new ecs.Cluster(this, 'FargateCluster', { vpc });\n\nconst taskDefinition = new ecs.TaskDefinition(this, 'TD', {\n memoryMiB: '512',\n cpu: '256',\n compatibility: ecs.Compatibility.FARGATE,\n});\n\nconst containerDefinition = taskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('foo/bar'),\n memoryLimitMiB: 256,\n});\n\nconst runTask = new tasks.EcsRunTask(this, 'RunFargate', {\n integrationPattern: sfn.IntegrationPattern.RUN_JOB,\n cluster,\n taskDefinition,\n assignPublicIp: true,\n containerOverrides: [{\n containerDefinition,\n environment: [{ name: 'SOME_KEY', value: sfn.JsonPath.stringAt('$.SomeKey') }],\n }],\n launchTarget: new tasks.EcsFargateLaunchTarget(),\n});",
15927 "stability": "stable",
15928 "summary": "The properties used to define an ECS cluster."
15929 },
15930 "fqn": "@aws-cdk/aws-ecs.ClusterProps",
15931 "kind": "interface",
15932 "locationInModule": {
15933 "filename": "lib/cluster.ts",
15934 "line": 23
15935 },
15936 "name": "ClusterProps",
15937 "properties": [
15938 {
15939 "abstract": true,
15940 "docs": {
15941 "default": "- no EC2 capacity will be added, you can use `addCapacity` to add capacity later.",
15942 "stability": "stable",
15943 "summary": "The ec2 capacity to add to the cluster."
15944 },
15945 "immutable": true,
15946 "locationInModule": {
15947 "filename": "lib/cluster.ts",
15948 "line": 51
15949 },
15950 "name": "capacity",
15951 "optional": true,
15952 "type": {
15953 "fqn": "@aws-cdk/aws-ecs.AddCapacityOptions"
15954 }
15955 },
15956 {
15957 "abstract": true,
15958 "docs": {
15959 "default": "- None. Currently only FARGATE and FARGATE_SPOT are supported.",
15960 "deprecated": "Use {@link ClusterProps.enableFargateCapacityProviders} instead.",
15961 "stability": "deprecated",
15962 "summary": "The capacity providers to add to the cluster."
15963 },
15964 "immutable": true,
15965 "locationInModule": {
15966 "filename": "lib/cluster.ts",
15967 "line": 59
15968 },
15969 "name": "capacityProviders",
15970 "optional": true,
15971 "type": {
15972 "collection": {
15973 "elementtype": {
15974 "primitive": "string"
15975 },
15976 "kind": "array"
15977 }
15978 }
15979 },
15980 {
15981 "abstract": true,
15982 "docs": {
15983 "default": "CloudFormation-generated name",
15984 "stability": "stable",
15985 "summary": "The name for the cluster."
15986 },
15987 "immutable": true,
15988 "locationInModule": {
15989 "filename": "lib/cluster.ts",
15990 "line": 29
15991 },
15992 "name": "clusterName",
15993 "optional": true,
15994 "type": {
15995 "primitive": "string"
15996 }
15997 },
15998 {
15999 "abstract": true,
16000 "docs": {
16001 "default": "- Container Insights will be disabled for this cluser.",
16002 "stability": "stable",
16003 "summary": "If true CloudWatch Container Insights will be enabled for the cluster."
16004 },
16005 "immutable": true,
16006 "locationInModule": {
16007 "filename": "lib/cluster.ts",
16008 "line": 73
16009 },
16010 "name": "containerInsights",
16011 "optional": true,
16012 "type": {
16013 "primitive": "boolean"
16014 }
16015 },
16016 {
16017 "abstract": true,
16018 "docs": {
16019 "default": "- no service discovery namespace created, you can use `addDefaultCloudMapNamespace` to add a\ndefault service discovery namespace later.",
16020 "stability": "stable",
16021 "summary": "The service discovery namespace created in this cluster."
16022 },
16023 "immutable": true,
16024 "locationInModule": {
16025 "filename": "lib/cluster.ts",
16026 "line": 44
16027 },
16028 "name": "defaultCloudMapNamespace",
16029 "optional": true,
16030 "type": {
16031 "fqn": "@aws-cdk/aws-ecs.CloudMapNamespaceOptions"
16032 }
16033 },
16034 {
16035 "abstract": true,
16036 "docs": {
16037 "default": "false",
16038 "stability": "stable",
16039 "summary": "Whether to enable Fargate Capacity Providers."
16040 },
16041 "immutable": true,
16042 "locationInModule": {
16043 "filename": "lib/cluster.ts",
16044 "line": 66
16045 },
16046 "name": "enableFargateCapacityProviders",
16047 "optional": true,
16048 "type": {
16049 "primitive": "boolean"
16050 }
16051 },
16052 {
16053 "abstract": true,
16054 "docs": {
16055 "default": "- no configuration will be provided.",
16056 "stability": "stable",
16057 "summary": "The execute command configuration for the cluster."
16058 },
16059 "immutable": true,
16060 "locationInModule": {
16061 "filename": "lib/cluster.ts",
16062 "line": 80
16063 },
16064 "name": "executeCommandConfiguration",
16065 "optional": true,
16066 "type": {
16067 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandConfiguration"
16068 }
16069 },
16070 {
16071 "abstract": true,
16072 "docs": {
16073 "default": "- creates a new VPC with two AZs",
16074 "stability": "stable",
16075 "summary": "The VPC where your ECS instances will be running or your ENIs will be deployed."
16076 },
16077 "immutable": true,
16078 "locationInModule": {
16079 "filename": "lib/cluster.ts",
16080 "line": 36
16081 },
16082 "name": "vpc",
16083 "optional": true,
16084 "type": {
16085 "fqn": "@aws-cdk/aws-ec2.IVpc"
16086 }
16087 }
16088 ],
16089 "symbolId": "lib/cluster:ClusterProps"
16090 },
16091 "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes": {
16092 "assembly": "@aws-cdk/aws-ecs",
16093 "datatype": true,
16094 "docs": {
16095 "stability": "stable",
16096 "summary": "The common task definition attributes used across all types of task definitions.",
16097 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst commonTaskDefinitionAttributes: ecs.CommonTaskDefinitionAttributes = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n networkMode: ecs.NetworkMode.NONE,\n taskRole: role,\n};",
16098 "custom": {
16099 "exampleMetadata": "fixture=_generated"
16100 }
16101 },
16102 "fqn": "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes",
16103 "kind": "interface",
16104 "locationInModule": {
16105 "filename": "lib/base/task-definition.ts",
16106 "line": 226
16107 },
16108 "name": "CommonTaskDefinitionAttributes",
16109 "properties": [
16110 {
16111 "abstract": true,
16112 "docs": {
16113 "stability": "stable",
16114 "summary": "The arn of the task definition."
16115 },
16116 "immutable": true,
16117 "locationInModule": {
16118 "filename": "lib/base/task-definition.ts",
16119 "line": 230
16120 },
16121 "name": "taskDefinitionArn",
16122 "type": {
16123 "primitive": "string"
16124 }
16125 },
16126 {
16127 "abstract": true,
16128 "docs": {
16129 "default": "Network mode cannot be provided to the imported task.",
16130 "stability": "stable",
16131 "summary": "The networking mode to use for the containers in the task."
16132 },
16133 "immutable": true,
16134 "locationInModule": {
16135 "filename": "lib/base/task-definition.ts",
16136 "line": 237
16137 },
16138 "name": "networkMode",
16139 "optional": true,
16140 "type": {
16141 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
16142 }
16143 },
16144 {
16145 "abstract": true,
16146 "docs": {
16147 "default": "Permissions cannot be granted to the imported task.",
16148 "stability": "stable",
16149 "summary": "The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf."
16150 },
16151 "immutable": true,
16152 "locationInModule": {
16153 "filename": "lib/base/task-definition.ts",
16154 "line": 244
16155 },
16156 "name": "taskRole",
16157 "optional": true,
16158 "type": {
16159 "fqn": "@aws-cdk/aws-iam.IRole"
16160 }
16161 }
16162 ],
16163 "symbolId": "lib/base/task-definition:CommonTaskDefinitionAttributes"
16164 },
16165 "@aws-cdk/aws-ecs.CommonTaskDefinitionProps": {
16166 "assembly": "@aws-cdk/aws-ecs",
16167 "datatype": true,
16168 "docs": {
16169 "remarks": "For more information, see\n[Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html).",
16170 "stability": "stable",
16171 "summary": "The common properties for all task definitions.",
16172 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const proxyConfiguration: ecs.ProxyConfiguration;\ndeclare const role: iam.Role;\nconst commonTaskDefinitionProps: ecs.CommonTaskDefinitionProps = {\n executionRole: role,\n family: 'family',\n proxyConfiguration: proxyConfiguration,\n taskRole: role,\n volumes: [{\n name: 'name',\n\n // the properties below are optional\n dockerVolumeConfiguration: {\n driver: 'driver',\n scope: ecs.Scope.TASK,\n\n // the properties below are optional\n autoprovision: false,\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n },\n efsVolumeConfiguration: {\n fileSystemId: 'fileSystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n },\n host: {\n sourcePath: 'sourcePath',\n },\n }],\n};",
16173 "custom": {
16174 "exampleMetadata": "fixture=_generated"
16175 }
16176 },
16177 "fqn": "@aws-cdk/aws-ecs.CommonTaskDefinitionProps",
16178 "kind": "interface",
16179 "locationInModule": {
16180 "filename": "lib/base/task-definition.ts",
16181 "line": 65
16182 },
16183 "name": "CommonTaskDefinitionProps",
16184 "properties": [
16185 {
16186 "abstract": true,
16187 "docs": {
16188 "default": "- An execution role will be automatically created if you use ECR images in your task definition.",
16189 "remarks": "The role will be used to retrieve container images from ECR and create CloudWatch log groups.",
16190 "stability": "stable",
16191 "summary": "The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf."
16192 },
16193 "immutable": true,
16194 "locationInModule": {
16195 "filename": "lib/base/task-definition.ts",
16196 "line": 80
16197 },
16198 "name": "executionRole",
16199 "optional": true,
16200 "type": {
16201 "fqn": "@aws-cdk/aws-iam.IRole"
16202 }
16203 },
16204 {
16205 "abstract": true,
16206 "docs": {
16207 "default": "- Automatically generated name.",
16208 "remarks": "A family groups multiple versions of a task definition.",
16209 "stability": "stable",
16210 "summary": "The name of a family that this task definition is registered to."
16211 },
16212 "immutable": true,
16213 "locationInModule": {
16214 "filename": "lib/base/task-definition.ts",
16215 "line": 71
16216 },
16217 "name": "family",
16218 "optional": true,
16219 "type": {
16220 "primitive": "string"
16221 }
16222 },
16223 {
16224 "abstract": true,
16225 "docs": {
16226 "default": "- No proxy configuration.",
16227 "stability": "stable",
16228 "summary": "The configuration details for the App Mesh proxy."
16229 },
16230 "immutable": true,
16231 "locationInModule": {
16232 "filename": "lib/base/task-definition.ts",
16233 "line": 94
16234 },
16235 "name": "proxyConfiguration",
16236 "optional": true,
16237 "type": {
16238 "fqn": "@aws-cdk/aws-ecs.ProxyConfiguration"
16239 }
16240 },
16241 {
16242 "abstract": true,
16243 "docs": {
16244 "default": "- A task role is automatically created for you.",
16245 "stability": "stable",
16246 "summary": "The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf."
16247 },
16248 "immutable": true,
16249 "locationInModule": {
16250 "filename": "lib/base/task-definition.ts",
16251 "line": 87
16252 },
16253 "name": "taskRole",
16254 "optional": true,
16255 "type": {
16256 "fqn": "@aws-cdk/aws-iam.IRole"
16257 }
16258 },
16259 {
16260 "abstract": true,
16261 "docs": {
16262 "default": "- No volumes are passed to the Docker daemon on a container instance.",
16263 "remarks": "For more information, see\n[Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes).",
16264 "stability": "stable",
16265 "summary": "The list of volume definitions for the task."
16266 },
16267 "immutable": true,
16268 "locationInModule": {
16269 "filename": "lib/base/task-definition.ts",
16270 "line": 102
16271 },
16272 "name": "volumes",
16273 "optional": true,
16274 "type": {
16275 "collection": {
16276 "elementtype": {
16277 "fqn": "@aws-cdk/aws-ecs.Volume"
16278 },
16279 "kind": "array"
16280 }
16281 }
16282 }
16283 ],
16284 "symbolId": "lib/base/task-definition:CommonTaskDefinitionProps"
16285 },
16286 "@aws-cdk/aws-ecs.Compatibility": {
16287 "assembly": "@aws-cdk/aws-ecs",
16288 "docs": {
16289 "custom": {
16290 "exampleMetadata": "infused"
16291 },
16292 "example": "const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {\n isDefault: true,\n});\n\nconst cluster = new ecs.Cluster(this, 'Ec2Cluster', { vpc });\ncluster.addCapacity('DefaultAutoScalingGroup', {\n instanceType: new ec2.InstanceType('t2.micro'),\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },\n});\n\nconst taskDefinition = new ecs.TaskDefinition(this, 'TD', {\n compatibility: ecs.Compatibility.EC2,\n});\n\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('foo/bar'),\n memoryLimitMiB: 256,\n});\n\nconst runTask = new tasks.EcsRunTask(this, 'Run', {\n integrationPattern: sfn.IntegrationPattern.RUN_JOB,\n cluster,\n taskDefinition,\n launchTarget: new tasks.EcsEc2LaunchTarget({\n placementStrategies: [\n ecs.PlacementStrategy.spreadAcrossInstances(),\n ecs.PlacementStrategy.packedByCpu(),\n ecs.PlacementStrategy.randomly(),\n ],\n placementConstraints: [\n ecs.PlacementConstraint.memberOf('blieptuut'),\n ],\n }),\n});",
16293 "stability": "stable",
16294 "summary": "The task launch type compatibility requirement."
16295 },
16296 "fqn": "@aws-cdk/aws-ecs.Compatibility",
16297 "kind": "enum",
16298 "locationInModule": {
16299 "filename": "lib/base/task-definition.ts",
16300 "line": 1070
16301 },
16302 "members": [
16303 {
16304 "docs": {
16305 "stability": "stable",
16306 "summary": "The task should specify the EC2 launch type."
16307 },
16308 "name": "EC2"
16309 },
16310 {
16311 "docs": {
16312 "stability": "stable",
16313 "summary": "The task should specify the Fargate launch type."
16314 },
16315 "name": "FARGATE"
16316 },
16317 {
16318 "docs": {
16319 "stability": "stable",
16320 "summary": "The task can specify either the EC2 or Fargate launch types."
16321 },
16322 "name": "EC2_AND_FARGATE"
16323 },
16324 {
16325 "docs": {
16326 "stability": "stable",
16327 "summary": "The task should specify the External launch type."
16328 },
16329 "name": "EXTERNAL"
16330 }
16331 ],
16332 "name": "Compatibility",
16333 "symbolId": "lib/base/task-definition:Compatibility"
16334 },
16335 "@aws-cdk/aws-ecs.ContainerDefinition": {
16336 "assembly": "@aws-cdk/aws-ecs",
16337 "base": "@aws-cdk/core.Construct",
16338 "docs": {
16339 "custom": {
16340 "exampleMetadata": "infused"
16341 },
16342 "example": "declare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\n// Add a container to the task definition\nconst specificContainer = taskDefinition.addContainer('Container', {\n image: ecs.ContainerImage.fromRegistry('/aws/aws-example-app'),\n memoryLimitMiB: 2048,\n});\n\n// Add a port mapping\nspecificContainer.addPortMappings({\n containerPort: 7600,\n protocol: ecs.Protocol.TCP,\n});\n\nnew ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create SRV records - useful for bridge networking\n dnsRecordType: cloudmap.DnsRecordType.SRV,\n // Targets port TCP port 7600 `specificContainer`\n container: specificContainer,\n containerPort: 7600,\n },\n});",
16343 "stability": "stable",
16344 "summary": "A container definition is used in a task definition to describe the containers that are launched as part of a task."
16345 },
16346 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition",
16347 "initializer": {
16348 "docs": {
16349 "stability": "stable",
16350 "summary": "Constructs a new instance of the ContainerDefinition class."
16351 },
16352 "locationInModule": {
16353 "filename": "lib/container-definition.ts",
16354 "line": 472
16355 },
16356 "parameters": [
16357 {
16358 "name": "scope",
16359 "type": {
16360 "fqn": "constructs.Construct"
16361 }
16362 },
16363 {
16364 "name": "id",
16365 "type": {
16366 "primitive": "string"
16367 }
16368 },
16369 {
16370 "name": "props",
16371 "type": {
16372 "fqn": "@aws-cdk/aws-ecs.ContainerDefinitionProps"
16373 }
16374 }
16375 ]
16376 },
16377 "kind": "class",
16378 "locationInModule": {
16379 "filename": "lib/container-definition.ts",
16380 "line": 373
16381 },
16382 "methods": [
16383 {
16384 "docs": {
16385 "stability": "stable",
16386 "summary": "This method adds one or more container dependencies to the container."
16387 },
16388 "locationInModule": {
16389 "filename": "lib/container-definition.ts",
16390 "line": 633
16391 },
16392 "name": "addContainerDependencies",
16393 "parameters": [
16394 {
16395 "name": "containerDependencies",
16396 "type": {
16397 "fqn": "@aws-cdk/aws-ecs.ContainerDependency"
16398 },
16399 "variadic": true
16400 }
16401 ],
16402 "variadic": true
16403 },
16404 {
16405 "docs": {
16406 "stability": "stable",
16407 "summary": "This method adds an environment variable to the container."
16408 },
16409 "locationInModule": {
16410 "filename": "lib/container-definition.ts",
16411 "line": 605
16412 },
16413 "name": "addEnvironment",
16414 "parameters": [
16415 {
16416 "name": "name",
16417 "type": {
16418 "primitive": "string"
16419 }
16420 },
16421 {
16422 "name": "value",
16423 "type": {
16424 "primitive": "string"
16425 }
16426 }
16427 ]
16428 },
16429 {
16430 "docs": {
16431 "stability": "stable",
16432 "summary": "This method adds one or more resources to the container."
16433 },
16434 "locationInModule": {
16435 "filename": "lib/container-definition.ts",
16436 "line": 612
16437 },
16438 "name": "addInferenceAcceleratorResource",
16439 "parameters": [
16440 {
16441 "name": "inferenceAcceleratorResources",
16442 "type": {
16443 "primitive": "string"
16444 },
16445 "variadic": true
16446 }
16447 ],
16448 "variadic": true
16449 },
16450 {
16451 "docs": {
16452 "remarks": "This parameter is only supported if the task definition is using the bridge network mode.\nWarning: The --link flag is a legacy feature of Docker. It may eventually be removed.",
16453 "stability": "stable",
16454 "summary": "This method adds a link which allows containers to communicate with each other without the need for port mappings."
16455 },
16456 "locationInModule": {
16457 "filename": "lib/container-definition.ts",
16458 "line": 537
16459 },
16460 "name": "addLink",
16461 "parameters": [
16462 {
16463 "name": "container",
16464 "type": {
16465 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
16466 }
16467 },
16468 {
16469 "name": "alias",
16470 "optional": true,
16471 "type": {
16472 "primitive": "string"
16473 }
16474 }
16475 ]
16476 },
16477 {
16478 "docs": {
16479 "stability": "stable",
16480 "summary": "This method adds one or more mount points for data volumes to the container."
16481 },
16482 "locationInModule": {
16483 "filename": "lib/container-definition.ts",
16484 "line": 551
16485 },
16486 "name": "addMountPoints",
16487 "parameters": [
16488 {
16489 "name": "mountPoints",
16490 "type": {
16491 "fqn": "@aws-cdk/aws-ecs.MountPoint"
16492 },
16493 "variadic": true
16494 }
16495 ],
16496 "variadic": true
16497 },
16498 {
16499 "docs": {
16500 "stability": "stable",
16501 "summary": "This method adds one or more port mappings to the container."
16502 },
16503 "locationInModule": {
16504 "filename": "lib/container-definition.ts",
16505 "line": 581
16506 },
16507 "name": "addPortMappings",
16508 "parameters": [
16509 {
16510 "name": "portMappings",
16511 "type": {
16512 "fqn": "@aws-cdk/aws-ecs.PortMapping"
16513 },
16514 "variadic": true
16515 }
16516 ],
16517 "variadic": true
16518 },
16519 {
16520 "docs": {
16521 "remarks": "This adds the correct container mountPoint and task definition volume.",
16522 "stability": "stable",
16523 "summary": "This method mounts temporary disk space to the container."
16524 },
16525 "locationInModule": {
16526 "filename": "lib/container-definition.ts",
16527 "line": 560
16528 },
16529 "name": "addScratch",
16530 "parameters": [
16531 {
16532 "name": "scratch",
16533 "type": {
16534 "fqn": "@aws-cdk/aws-ecs.ScratchSpace"
16535 }
16536 }
16537 ]
16538 },
16539 {
16540 "docs": {
16541 "stability": "stable",
16542 "summary": "This method adds the specified statement to the IAM task execution policy in the task definition."
16543 },
16544 "locationInModule": {
16545 "filename": "lib/container-definition.ts",
16546 "line": 647
16547 },
16548 "name": "addToExecutionPolicy",
16549 "parameters": [
16550 {
16551 "name": "statement",
16552 "type": {
16553 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
16554 }
16555 }
16556 ]
16557 },
16558 {
16559 "docs": {
16560 "stability": "stable",
16561 "summary": "This method adds one or more ulimits to the container."
16562 },
16563 "locationInModule": {
16564 "filename": "lib/container-definition.ts",
16565 "line": 626
16566 },
16567 "name": "addUlimits",
16568 "parameters": [
16569 {
16570 "name": "ulimits",
16571 "type": {
16572 "fqn": "@aws-cdk/aws-ecs.Ulimit"
16573 },
16574 "variadic": true
16575 }
16576 ],
16577 "variadic": true
16578 },
16579 {
16580 "docs": {
16581 "stability": "stable",
16582 "summary": "This method adds one or more volumes to the container."
16583 },
16584 "locationInModule": {
16585 "filename": "lib/container-definition.ts",
16586 "line": 640
16587 },
16588 "name": "addVolumesFrom",
16589 "parameters": [
16590 {
16591 "name": "volumesFrom",
16592 "type": {
16593 "fqn": "@aws-cdk/aws-ecs.VolumeFrom"
16594 },
16595 "variadic": true
16596 }
16597 ],
16598 "variadic": true
16599 },
16600 {
16601 "docs": {
16602 "stability": "stable",
16603 "summary": "Returns the host port for the requested container port if it exists."
16604 },
16605 "locationInModule": {
16606 "filename": "lib/container-definition.ts",
16607 "line": 654
16608 },
16609 "name": "findPortMapping",
16610 "parameters": [
16611 {
16612 "name": "containerPort",
16613 "type": {
16614 "primitive": "number"
16615 }
16616 },
16617 {
16618 "name": "protocol",
16619 "type": {
16620 "fqn": "@aws-cdk/aws-ecs.Protocol"
16621 }
16622 }
16623 ],
16624 "returns": {
16625 "optional": true,
16626 "type": {
16627 "fqn": "@aws-cdk/aws-ecs.PortMapping"
16628 }
16629 }
16630 },
16631 {
16632 "docs": {
16633 "stability": "stable",
16634 "summary": "Render this container definition to a CloudFormation object."
16635 },
16636 "locationInModule": {
16637 "filename": "lib/container-definition.ts",
16638 "line": 702
16639 },
16640 "name": "renderContainerDefinition",
16641 "parameters": [
16642 {
16643 "docs": {
16644 "summary": "[disable-awslint:ref-via-interface] (unused but kept to avoid breaking change)."
16645 },
16646 "name": "_taskDefinition",
16647 "optional": true,
16648 "type": {
16649 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
16650 }
16651 }
16652 ],
16653 "returns": {
16654 "type": {
16655 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty"
16656 }
16657 }
16658 }
16659 ],
16660 "name": "ContainerDefinition",
16661 "properties": [
16662 {
16663 "docs": {
16664 "stability": "stable",
16665 "summary": "An array dependencies defined for container startup and shutdown."
16666 },
16667 "immutable": true,
16668 "locationInModule": {
16669 "filename": "lib/container-definition.ts",
16670 "line": 403
16671 },
16672 "name": "containerDependencies",
16673 "type": {
16674 "collection": {
16675 "elementtype": {
16676 "fqn": "@aws-cdk/aws-ecs.ContainerDependency"
16677 },
16678 "kind": "array"
16679 }
16680 }
16681 },
16682 {
16683 "docs": {
16684 "stability": "stable",
16685 "summary": "The name of this container."
16686 },
16687 "immutable": true,
16688 "locationInModule": {
16689 "filename": "lib/container-definition.ts",
16690 "line": 420
16691 },
16692 "name": "containerName",
16693 "type": {
16694 "primitive": "string"
16695 }
16696 },
16697 {
16698 "docs": {
16699 "stability": "stable",
16700 "summary": "The port the container will listen on."
16701 },
16702 "immutable": true,
16703 "locationInModule": {
16704 "filename": "lib/container-definition.ts",
16705 "line": 689
16706 },
16707 "name": "containerPort",
16708 "type": {
16709 "primitive": "number"
16710 }
16711 },
16712 {
16713 "docs": {
16714 "remarks": "If the essential parameter of a container is marked as true, and that container\nfails or stops for any reason, all other containers that are part of the task are\nstopped. If the essential parameter of a container is marked as false, then its\nfailure does not affect the rest of the containers in a task.\n\nIf this parameter is omitted, a container is assumed to be essential.",
16715 "stability": "stable",
16716 "summary": "Specifies whether the container will be marked essential."
16717 },
16718 "immutable": true,
16719 "locationInModule": {
16720 "filename": "lib/container-definition.ts",
16721 "line": 415
16722 },
16723 "name": "essential",
16724 "type": {
16725 "primitive": "boolean"
16726 }
16727 },
16728 {
16729 "docs": {
16730 "stability": "stable",
16731 "summary": "The name of the image referenced by this container."
16732 },
16733 "immutable": true,
16734 "locationInModule": {
16735 "filename": "lib/container-definition.ts",
16736 "line": 451
16737 },
16738 "name": "imageName",
16739 "type": {
16740 "primitive": "string"
16741 }
16742 },
16743 {
16744 "docs": {
16745 "remarks": "This property is only used for tasks that use the awsvpc network mode.",
16746 "stability": "stable",
16747 "summary": "The inbound rules associated with the security group the task or service will use."
16748 },
16749 "immutable": true,
16750 "locationInModule": {
16751 "filename": "lib/container-definition.ts",
16752 "line": 670
16753 },
16754 "name": "ingressPort",
16755 "type": {
16756 "primitive": "number"
16757 }
16758 },
16759 {
16760 "docs": {
16761 "stability": "stable",
16762 "summary": "Whether there was at least one memory limit specified in this definition."
16763 },
16764 "immutable": true,
16765 "locationInModule": {
16766 "filename": "lib/container-definition.ts",
16767 "line": 425
16768 },
16769 "name": "memoryLimitSpecified",
16770 "type": {
16771 "primitive": "boolean"
16772 }
16773 },
16774 {
16775 "docs": {
16776 "stability": "stable",
16777 "summary": "The mount points for data volumes in your container."
16778 },
16779 "immutable": true,
16780 "locationInModule": {
16781 "filename": "lib/container-definition.ts",
16782 "line": 382
16783 },
16784 "name": "mountPoints",
16785 "type": {
16786 "collection": {
16787 "elementtype": {
16788 "fqn": "@aws-cdk/aws-ecs.MountPoint"
16789 },
16790 "kind": "array"
16791 }
16792 }
16793 },
16794 {
16795 "docs": {
16796 "remarks": "Port mappings allow containers to access ports\non the host container instance to send or receive traffic.",
16797 "stability": "stable",
16798 "summary": "The list of port mappings for the container."
16799 },
16800 "immutable": true,
16801 "locationInModule": {
16802 "filename": "lib/container-definition.ts",
16803 "line": 388
16804 },
16805 "name": "portMappings",
16806 "type": {
16807 "collection": {
16808 "elementtype": {
16809 "fqn": "@aws-cdk/aws-ecs.PortMapping"
16810 },
16811 "kind": "array"
16812 }
16813 }
16814 },
16815 {
16816 "docs": {
16817 "stability": "stable",
16818 "summary": "The name of the task definition that includes this container definition."
16819 },
16820 "immutable": true,
16821 "locationInModule": {
16822 "filename": "lib/container-definition.ts",
16823 "line": 430
16824 },
16825 "name": "taskDefinition",
16826 "type": {
16827 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
16828 }
16829 },
16830 {
16831 "docs": {
16832 "stability": "stable",
16833 "summary": "An array of ulimits to set in the container."
16834 },
16835 "immutable": true,
16836 "locationInModule": {
16837 "filename": "lib/container-definition.ts",
16838 "line": 398
16839 },
16840 "name": "ulimits",
16841 "type": {
16842 "collection": {
16843 "elementtype": {
16844 "fqn": "@aws-cdk/aws-ecs.Ulimit"
16845 },
16846 "kind": "array"
16847 }
16848 }
16849 },
16850 {
16851 "docs": {
16852 "stability": "stable",
16853 "summary": "The data volumes to mount from another container in the same task definition."
16854 },
16855 "immutable": true,
16856 "locationInModule": {
16857 "filename": "lib/container-definition.ts",
16858 "line": 393
16859 },
16860 "name": "volumesFrom",
16861 "type": {
16862 "collection": {
16863 "elementtype": {
16864 "fqn": "@aws-cdk/aws-ecs.VolumeFrom"
16865 },
16866 "kind": "array"
16867 }
16868 }
16869 },
16870 {
16871 "docs": {
16872 "stability": "stable",
16873 "summary": "The environment files for this container."
16874 },
16875 "immutable": true,
16876 "locationInModule": {
16877 "filename": "lib/container-definition.ts",
16878 "line": 435
16879 },
16880 "name": "environmentFiles",
16881 "optional": true,
16882 "type": {
16883 "collection": {
16884 "elementtype": {
16885 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileConfig"
16886 },
16887 "kind": "array"
16888 }
16889 }
16890 },
16891 {
16892 "docs": {
16893 "stability": "stable",
16894 "summary": "The Linux-specific modifications that are applied to the container, such as Linux kernel capabilities."
16895 },
16896 "immutable": true,
16897 "locationInModule": {
16898 "filename": "lib/container-definition.ts",
16899 "line": 377
16900 },
16901 "name": "linuxParameters",
16902 "optional": true,
16903 "type": {
16904 "fqn": "@aws-cdk/aws-ecs.LinuxParameters"
16905 }
16906 },
16907 {
16908 "docs": {
16909 "stability": "stable",
16910 "summary": "The log configuration specification for the container."
16911 },
16912 "immutable": true,
16913 "locationInModule": {
16914 "filename": "lib/container-definition.ts",
16915 "line": 440
16916 },
16917 "name": "logDriverConfig",
16918 "optional": true,
16919 "type": {
16920 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
16921 }
16922 },
16923 {
16924 "docs": {
16925 "stability": "stable",
16926 "summary": "Whether this container definition references a specific JSON field of a secret stored in Secrets Manager."
16927 },
16928 "immutable": true,
16929 "locationInModule": {
16930 "filename": "lib/container-definition.ts",
16931 "line": 446
16932 },
16933 "name": "referencesSecretJsonField",
16934 "optional": true,
16935 "type": {
16936 "primitive": "boolean"
16937 }
16938 }
16939 ],
16940 "symbolId": "lib/container-definition:ContainerDefinition"
16941 },
16942 "@aws-cdk/aws-ecs.ContainerDefinitionOptions": {
16943 "assembly": "@aws-cdk/aws-ecs",
16944 "datatype": true,
16945 "docs": {
16946 "custom": {
16947 "exampleMetadata": "infused"
16948 },
16949 "example": "declare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\n// Add a container to the task definition\nconst specificContainer = taskDefinition.addContainer('Container', {\n image: ecs.ContainerImage.fromRegistry('/aws/aws-example-app'),\n memoryLimitMiB: 2048,\n});\n\n// Add a port mapping\nspecificContainer.addPortMappings({\n containerPort: 7600,\n protocol: ecs.Protocol.TCP,\n});\n\nnew ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create SRV records - useful for bridge networking\n dnsRecordType: cloudmap.DnsRecordType.SRV,\n // Targets port TCP port 7600 `specificContainer`\n container: specificContainer,\n containerPort: 7600,\n },\n});",
16950 "stability": "stable"
16951 },
16952 "fqn": "@aws-cdk/aws-ecs.ContainerDefinitionOptions",
16953 "kind": "interface",
16954 "locationInModule": {
16955 "filename": "lib/container-definition.ts",
16956 "line": 106
16957 },
16958 "name": "ContainerDefinitionOptions",
16959 "properties": [
16960 {
16961 "abstract": true,
16962 "docs": {
16963 "remarks": "This string is passed directly to the Docker daemon.\nImages in the Docker Hub registry are available by default.\nOther repositories are specified with either repository-url/image:tag or repository-url/image@digest.\nTODO: Update these to specify using classes of IContainerImage",
16964 "stability": "stable",
16965 "summary": "The image used to start a container."
16966 },
16967 "immutable": true,
16968 "locationInModule": {
16969 "filename": "lib/container-definition.ts",
16970 "line": 115
16971 },
16972 "name": "image",
16973 "type": {
16974 "fqn": "@aws-cdk/aws-ecs.ContainerImage"
16975 }
16976 },
16977 {
16978 "abstract": true,
16979 "docs": {
16980 "default": "- CMD value built into container image.",
16981 "remarks": "If you provide a shell command as a single string, you have to quote command-line arguments.",
16982 "stability": "stable",
16983 "summary": "The command that is passed to the container."
16984 },
16985 "immutable": true,
16986 "locationInModule": {
16987 "filename": "lib/container-definition.ts",
16988 "line": 131
16989 },
16990 "name": "command",
16991 "optional": true,
16992 "type": {
16993 "collection": {
16994 "elementtype": {
16995 "primitive": "string"
16996 },
16997 "kind": "array"
16998 }
16999 }
17000 },
17001 {
17002 "abstract": true,
17003 "docs": {
17004 "default": "- id of node associated with ContainerDefinition.",
17005 "stability": "stable",
17006 "summary": "The name of the container."
17007 },
17008 "immutable": true,
17009 "locationInModule": {
17010 "filename": "lib/container-definition.ts",
17011 "line": 122
17012 },
17013 "name": "containerName",
17014 "optional": true,
17015 "type": {
17016 "primitive": "string"
17017 }
17018 },
17019 {
17020 "abstract": true,
17021 "docs": {
17022 "default": "- No minimum CPU units reserved.",
17023 "stability": "stable",
17024 "summary": "The minimum number of CPU units to reserve for the container."
17025 },
17026 "immutable": true,
17027 "locationInModule": {
17028 "filename": "lib/container-definition.ts",
17029 "line": 138
17030 },
17031 "name": "cpu",
17032 "optional": true,
17033 "type": {
17034 "primitive": "number"
17035 }
17036 },
17037 {
17038 "abstract": true,
17039 "docs": {
17040 "default": "false",
17041 "remarks": "When this parameter is true, networking is disabled within the container.",
17042 "stability": "stable",
17043 "summary": "Specifies whether networking is disabled within the container."
17044 },
17045 "immutable": true,
17046 "locationInModule": {
17047 "filename": "lib/container-definition.ts",
17048 "line": 147
17049 },
17050 "name": "disableNetworking",
17051 "optional": true,
17052 "type": {
17053 "primitive": "boolean"
17054 }
17055 },
17056 {
17057 "abstract": true,
17058 "docs": {
17059 "default": "- No search domains.",
17060 "stability": "stable",
17061 "summary": "A list of DNS search domains that are presented to the container."
17062 },
17063 "immutable": true,
17064 "locationInModule": {
17065 "filename": "lib/container-definition.ts",
17066 "line": 154
17067 },
17068 "name": "dnsSearchDomains",
17069 "optional": true,
17070 "type": {
17071 "collection": {
17072 "elementtype": {
17073 "primitive": "string"
17074 },
17075 "kind": "array"
17076 }
17077 }
17078 },
17079 {
17080 "abstract": true,
17081 "docs": {
17082 "default": "- Default DNS servers.",
17083 "stability": "stable",
17084 "summary": "A list of DNS servers that are presented to the container."
17085 },
17086 "immutable": true,
17087 "locationInModule": {
17088 "filename": "lib/container-definition.ts",
17089 "line": 161
17090 },
17091 "name": "dnsServers",
17092 "optional": true,
17093 "type": {
17094 "collection": {
17095 "elementtype": {
17096 "primitive": "string"
17097 },
17098 "kind": "array"
17099 }
17100 }
17101 },
17102 {
17103 "abstract": true,
17104 "docs": {
17105 "default": "- No labels.",
17106 "stability": "stable",
17107 "summary": "A key/value map of labels to add to the container."
17108 },
17109 "immutable": true,
17110 "locationInModule": {
17111 "filename": "lib/container-definition.ts",
17112 "line": 168
17113 },
17114 "name": "dockerLabels",
17115 "optional": true,
17116 "type": {
17117 "collection": {
17118 "elementtype": {
17119 "primitive": "string"
17120 },
17121 "kind": "map"
17122 }
17123 }
17124 },
17125 {
17126 "abstract": true,
17127 "docs": {
17128 "default": "- No security labels.",
17129 "stability": "stable",
17130 "summary": "A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems."
17131 },
17132 "immutable": true,
17133 "locationInModule": {
17134 "filename": "lib/container-definition.ts",
17135 "line": 175
17136 },
17137 "name": "dockerSecurityOptions",
17138 "optional": true,
17139 "type": {
17140 "collection": {
17141 "elementtype": {
17142 "primitive": "string"
17143 },
17144 "kind": "array"
17145 }
17146 }
17147 },
17148 {
17149 "abstract": true,
17150 "docs": {
17151 "default": "- Entry point configured in container.",
17152 "see": "https://docs.docker.com/engine/reference/builder/#entrypoint",
17153 "stability": "stable",
17154 "summary": "The ENTRYPOINT value to pass to the container."
17155 },
17156 "immutable": true,
17157 "locationInModule": {
17158 "filename": "lib/container-definition.ts",
17159 "line": 184
17160 },
17161 "name": "entryPoint",
17162 "optional": true,
17163 "type": {
17164 "collection": {
17165 "elementtype": {
17166 "primitive": "string"
17167 },
17168 "kind": "array"
17169 }
17170 }
17171 },
17172 {
17173 "abstract": true,
17174 "docs": {
17175 "default": "- No environment variables.",
17176 "stability": "stable",
17177 "summary": "The environment variables to pass to the container."
17178 },
17179 "immutable": true,
17180 "locationInModule": {
17181 "filename": "lib/container-definition.ts",
17182 "line": 191
17183 },
17184 "name": "environment",
17185 "optional": true,
17186 "type": {
17187 "collection": {
17188 "elementtype": {
17189 "primitive": "string"
17190 },
17191 "kind": "map"
17192 }
17193 }
17194 },
17195 {
17196 "abstract": true,
17197 "docs": {
17198 "default": "- No environment files.",
17199 "see": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html",
17200 "stability": "stable",
17201 "summary": "The environment files to pass to the container."
17202 },
17203 "immutable": true,
17204 "locationInModule": {
17205 "filename": "lib/container-definition.ts",
17206 "line": 200
17207 },
17208 "name": "environmentFiles",
17209 "optional": true,
17210 "type": {
17211 "collection": {
17212 "elementtype": {
17213 "fqn": "@aws-cdk/aws-ecs.EnvironmentFile"
17214 },
17215 "kind": "array"
17216 }
17217 }
17218 },
17219 {
17220 "abstract": true,
17221 "docs": {
17222 "default": "true",
17223 "remarks": "If the essential parameter of a container is marked as true, and that container fails\nor stops for any reason, all other containers that are part of the task are stopped.\nIf the essential parameter of a container is marked as false, then its failure does not\naffect the rest of the containers in a task. All tasks must have at least one essential container.\n\nIf this parameter is omitted, a container is assumed to be essential.",
17224 "stability": "stable",
17225 "summary": "Specifies whether the container is marked essential."
17226 },
17227 "immutable": true,
17228 "locationInModule": {
17229 "filename": "lib/container-definition.ts",
17230 "line": 235
17231 },
17232 "name": "essential",
17233 "optional": true,
17234 "type": {
17235 "primitive": "boolean"
17236 }
17237 },
17238 {
17239 "abstract": true,
17240 "docs": {
17241 "default": "- No extra hosts.",
17242 "stability": "stable",
17243 "summary": "A list of hostnames and IP address mappings to append to the /etc/hosts file on the container."
17244 },
17245 "immutable": true,
17246 "locationInModule": {
17247 "filename": "lib/container-definition.ts",
17248 "line": 242
17249 },
17250 "name": "extraHosts",
17251 "optional": true,
17252 "type": {
17253 "collection": {
17254 "elementtype": {
17255 "primitive": "string"
17256 },
17257 "kind": "map"
17258 }
17259 }
17260 },
17261 {
17262 "abstract": true,
17263 "docs": {
17264 "default": "- No GPUs assigned.",
17265 "stability": "stable",
17266 "summary": "The number of GPUs assigned to the container."
17267 },
17268 "immutable": true,
17269 "locationInModule": {
17270 "filename": "lib/container-definition.ts",
17271 "line": 334
17272 },
17273 "name": "gpuCount",
17274 "optional": true,
17275 "type": {
17276 "primitive": "number"
17277 }
17278 },
17279 {
17280 "abstract": true,
17281 "docs": {
17282 "default": "- Health check configuration from container.",
17283 "stability": "stable",
17284 "summary": "The health check command and associated configuration parameters for the container."
17285 },
17286 "immutable": true,
17287 "locationInModule": {
17288 "filename": "lib/container-definition.ts",
17289 "line": 249
17290 },
17291 "name": "healthCheck",
17292 "optional": true,
17293 "type": {
17294 "fqn": "@aws-cdk/aws-ecs.HealthCheck"
17295 }
17296 },
17297 {
17298 "abstract": true,
17299 "docs": {
17300 "default": "- Automatic hostname.",
17301 "stability": "stable",
17302 "summary": "The hostname to use for your container."
17303 },
17304 "immutable": true,
17305 "locationInModule": {
17306 "filename": "lib/container-definition.ts",
17307 "line": 256
17308 },
17309 "name": "hostname",
17310 "optional": true,
17311 "type": {
17312 "primitive": "string"
17313 }
17314 },
17315 {
17316 "abstract": true,
17317 "docs": {
17318 "default": "- No inference accelerators assigned.",
17319 "stability": "stable",
17320 "summary": "The inference accelerators referenced by the container."
17321 },
17322 "immutable": true,
17323 "locationInModule": {
17324 "filename": "lib/container-definition.ts",
17325 "line": 346
17326 },
17327 "name": "inferenceAcceleratorResources",
17328 "optional": true,
17329 "type": {
17330 "collection": {
17331 "elementtype": {
17332 "primitive": "string"
17333 },
17334 "kind": "array"
17335 }
17336 }
17337 },
17338 {
17339 "abstract": true,
17340 "docs": {
17341 "default": "- No Linux parameters.",
17342 "remarks": "For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).",
17343 "stability": "stable",
17344 "summary": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities."
17345 },
17346 "immutable": true,
17347 "locationInModule": {
17348 "filename": "lib/container-definition.ts",
17349 "line": 327
17350 },
17351 "name": "linuxParameters",
17352 "optional": true,
17353 "type": {
17354 "fqn": "@aws-cdk/aws-ecs.LinuxParameters"
17355 }
17356 },
17357 {
17358 "abstract": true,
17359 "docs": {
17360 "default": "- Containers use the same logging driver that the Docker daemon uses.",
17361 "stability": "stable",
17362 "summary": "The log configuration specification for the container."
17363 },
17364 "immutable": true,
17365 "locationInModule": {
17366 "filename": "lib/container-definition.ts",
17367 "line": 319
17368 },
17369 "name": "logging",
17370 "optional": true,
17371 "type": {
17372 "fqn": "@aws-cdk/aws-ecs.LogDriver"
17373 }
17374 },
17375 {
17376 "abstract": true,
17377 "docs": {
17378 "default": "- No memory limit.",
17379 "remarks": "If your container attempts to exceed the allocated memory, the container\nis terminated.\n\nAt least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.",
17380 "stability": "stable",
17381 "summary": "The amount (in MiB) of memory to present to the container."
17382 },
17383 "immutable": true,
17384 "locationInModule": {
17385 "filename": "lib/container-definition.ts",
17386 "line": 268
17387 },
17388 "name": "memoryLimitMiB",
17389 "optional": true,
17390 "type": {
17391 "primitive": "number"
17392 }
17393 },
17394 {
17395 "abstract": true,
17396 "docs": {
17397 "default": "- No memory reserved.",
17398 "remarks": "When system memory is under heavy contention, Docker attempts to keep the\ncontainer memory to this soft limit. However, your container can consume more\nmemory when it needs to, up to either the hard limit specified with the memory\nparameter (if applicable), or all of the available memory on the container\ninstance, whichever comes first.\n\nAt least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.",
17399 "stability": "stable",
17400 "summary": "The soft limit (in MiB) of memory to reserve for the container."
17401 },
17402 "immutable": true,
17403 "locationInModule": {
17404 "filename": "lib/container-definition.ts",
17405 "line": 283
17406 },
17407 "name": "memoryReservationMiB",
17408 "optional": true,
17409 "type": {
17410 "primitive": "number"
17411 }
17412 },
17413 {
17414 "abstract": true,
17415 "docs": {
17416 "default": "- No ports are mapped.",
17417 "stability": "stable",
17418 "summary": "The port mappings to add to the container definition."
17419 },
17420 "immutable": true,
17421 "locationInModule": {
17422 "filename": "lib/container-definition.ts",
17423 "line": 340
17424 },
17425 "name": "portMappings",
17426 "optional": true,
17427 "type": {
17428 "collection": {
17429 "elementtype": {
17430 "fqn": "@aws-cdk/aws-ecs.PortMapping"
17431 },
17432 "kind": "array"
17433 }
17434 }
17435 },
17436 {
17437 "abstract": true,
17438 "docs": {
17439 "default": "false",
17440 "remarks": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).",
17441 "stability": "stable",
17442 "summary": "Specifies whether the container is marked as privileged."
17443 },
17444 "immutable": true,
17445 "locationInModule": {
17446 "filename": "lib/container-definition.ts",
17447 "line": 291
17448 },
17449 "name": "privileged",
17450 "optional": true,
17451 "type": {
17452 "primitive": "boolean"
17453 }
17454 },
17455 {
17456 "abstract": true,
17457 "docs": {
17458 "default": "false",
17459 "stability": "stable",
17460 "summary": "When this parameter is true, the container is given read-only access to its root file system."
17461 },
17462 "immutable": true,
17463 "locationInModule": {
17464 "filename": "lib/container-definition.ts",
17465 "line": 298
17466 },
17467 "name": "readonlyRootFilesystem",
17468 "optional": true,
17469 "type": {
17470 "primitive": "boolean"
17471 }
17472 },
17473 {
17474 "abstract": true,
17475 "docs": {
17476 "default": "- No secret environment variables.",
17477 "stability": "stable",
17478 "summary": "The secret environment variables to pass to the container."
17479 },
17480 "immutable": true,
17481 "locationInModule": {
17482 "filename": "lib/container-definition.ts",
17483 "line": 207
17484 },
17485 "name": "secrets",
17486 "optional": true,
17487 "type": {
17488 "collection": {
17489 "elementtype": {
17490 "fqn": "@aws-cdk/aws-ecs.Secret"
17491 },
17492 "kind": "map"
17493 }
17494 }
17495 },
17496 {
17497 "abstract": true,
17498 "docs": {
17499 "default": "- none",
17500 "stability": "stable",
17501 "summary": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container."
17502 },
17503 "immutable": true,
17504 "locationInModule": {
17505 "filename": "lib/container-definition.ts",
17506 "line": 214
17507 },
17508 "name": "startTimeout",
17509 "optional": true,
17510 "type": {
17511 "fqn": "@aws-cdk/core.Duration"
17512 }
17513 },
17514 {
17515 "abstract": true,
17516 "docs": {
17517 "default": "- none",
17518 "stability": "stable",
17519 "summary": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own."
17520 },
17521 "immutable": true,
17522 "locationInModule": {
17523 "filename": "lib/container-definition.ts",
17524 "line": 221
17525 },
17526 "name": "stopTimeout",
17527 "optional": true,
17528 "type": {
17529 "fqn": "@aws-cdk/core.Duration"
17530 }
17531 },
17532 {
17533 "abstract": true,
17534 "docs": {
17535 "default": "- No system controls are set.",
17536 "see": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols",
17537 "stability": "stable",
17538 "summary": "A list of namespaced kernel parameters to set in the container."
17539 },
17540 "immutable": true,
17541 "locationInModule": {
17542 "filename": "lib/container-definition.ts",
17543 "line": 355
17544 },
17545 "name": "systemControls",
17546 "optional": true,
17547 "type": {
17548 "collection": {
17549 "elementtype": {
17550 "fqn": "@aws-cdk/aws-ecs.SystemControl"
17551 },
17552 "kind": "array"
17553 }
17554 }
17555 },
17556 {
17557 "abstract": true,
17558 "docs": {
17559 "default": "root",
17560 "stability": "stable",
17561 "summary": "The user name to use inside the container."
17562 },
17563 "immutable": true,
17564 "locationInModule": {
17565 "filename": "lib/container-definition.ts",
17566 "line": 305
17567 },
17568 "name": "user",
17569 "optional": true,
17570 "type": {
17571 "primitive": "string"
17572 }
17573 },
17574 {
17575 "abstract": true,
17576 "docs": {
17577 "default": "/",
17578 "stability": "stable",
17579 "summary": "The working directory in which to run commands inside the container."
17580 },
17581 "immutable": true,
17582 "locationInModule": {
17583 "filename": "lib/container-definition.ts",
17584 "line": 312
17585 },
17586 "name": "workingDirectory",
17587 "optional": true,
17588 "type": {
17589 "primitive": "string"
17590 }
17591 }
17592 ],
17593 "symbolId": "lib/container-definition:ContainerDefinitionOptions"
17594 },
17595 "@aws-cdk/aws-ecs.ContainerDefinitionProps": {
17596 "assembly": "@aws-cdk/aws-ecs",
17597 "datatype": true,
17598 "docs": {
17599 "stability": "stable",
17600 "summary": "The properties in a container definition.",
17601 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const containerImage: ecs.ContainerImage;\ndeclare const environmentFile: ecs.EnvironmentFile;\ndeclare const linuxParameters: ecs.LinuxParameters;\ndeclare const logDriver: ecs.LogDriver;\ndeclare const secret: ecs.Secret;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst containerDefinitionProps: ecs.ContainerDefinitionProps = {\n image: containerImage,\n taskDefinition: taskDefinition,\n\n // the properties below are optional\n command: ['command'],\n containerName: 'containerName',\n cpu: 123,\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: {\n environmentKey: 'environment',\n },\n environmentFiles: [environmentFile],\n essential: false,\n extraHosts: {\n extraHostsKey: 'extraHosts',\n },\n gpuCount: 123,\n healthCheck: {\n command: ['command'],\n\n // the properties below are optional\n interval: cdk.Duration.minutes(30),\n retries: 123,\n startPeriod: cdk.Duration.minutes(30),\n timeout: cdk.Duration.minutes(30),\n },\n hostname: 'hostname',\n inferenceAcceleratorResources: ['inferenceAcceleratorResources'],\n linuxParameters: linuxParameters,\n logging: logDriver,\n memoryLimitMiB: 123,\n memoryReservationMiB: 123,\n portMappings: [{\n containerPort: 123,\n\n // the properties below are optional\n hostPort: 123,\n protocol: ecs.Protocol.TCP,\n }],\n privileged: false,\n readonlyRootFilesystem: false,\n secrets: {\n secretsKey: secret,\n },\n startTimeout: cdk.Duration.minutes(30),\n stopTimeout: cdk.Duration.minutes(30),\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n user: 'user',\n workingDirectory: 'workingDirectory',\n};",
17602 "custom": {
17603 "exampleMetadata": "fixture=_generated"
17604 }
17605 },
17606 "fqn": "@aws-cdk/aws-ecs.ContainerDefinitionProps",
17607 "interfaces": [
17608 "@aws-cdk/aws-ecs.ContainerDefinitionOptions"
17609 ],
17610 "kind": "interface",
17611 "locationInModule": {
17612 "filename": "lib/container-definition.ts",
17613 "line": 361
17614 },
17615 "name": "ContainerDefinitionProps",
17616 "properties": [
17617 {
17618 "abstract": true,
17619 "docs": {
17620 "remarks": "[disable-awslint:ref-via-interface]",
17621 "stability": "stable",
17622 "summary": "The name of the task definition that includes this container definition."
17623 },
17624 "immutable": true,
17625 "locationInModule": {
17626 "filename": "lib/container-definition.ts",
17627 "line": 367
17628 },
17629 "name": "taskDefinition",
17630 "type": {
17631 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
17632 }
17633 }
17634 ],
17635 "symbolId": "lib/container-definition:ContainerDefinitionProps"
17636 },
17637 "@aws-cdk/aws-ecs.ContainerDependency": {
17638 "assembly": "@aws-cdk/aws-ecs",
17639 "datatype": true,
17640 "docs": {
17641 "see": "https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDependency.html",
17642 "stability": "stable",
17643 "summary": "The details of a dependency on another container in the task definition.",
17644 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const containerDefinition: ecs.ContainerDefinition;\nconst containerDependency: ecs.ContainerDependency = {\n container: containerDefinition,\n\n // the properties below are optional\n condition: ecs.ContainerDependencyCondition.START,\n};",
17645 "custom": {
17646 "exampleMetadata": "fixture=_generated"
17647 }
17648 },
17649 "fqn": "@aws-cdk/aws-ecs.ContainerDependency",
17650 "kind": "interface",
17651 "locationInModule": {
17652 "filename": "lib/container-definition.ts",
17653 "line": 926
17654 },
17655 "name": "ContainerDependency",
17656 "properties": [
17657 {
17658 "abstract": true,
17659 "docs": {
17660 "stability": "stable",
17661 "summary": "The container to depend on."
17662 },
17663 "immutable": true,
17664 "locationInModule": {
17665 "filename": "lib/container-definition.ts",
17666 "line": 930
17667 },
17668 "name": "container",
17669 "type": {
17670 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
17671 }
17672 },
17673 {
17674 "abstract": true,
17675 "docs": {
17676 "default": "ContainerDependencyCondition.HEALTHY",
17677 "remarks": "Valid values are ContainerDependencyCondition.START, ContainerDependencyCondition.COMPLETE,\nContainerDependencyCondition.SUCCESS and ContainerDependencyCondition.HEALTHY.",
17678 "stability": "stable",
17679 "summary": "The state the container needs to be in to satisfy the dependency and proceed with startup."
17680 },
17681 "immutable": true,
17682 "locationInModule": {
17683 "filename": "lib/container-definition.ts",
17684 "line": 939
17685 },
17686 "name": "condition",
17687 "optional": true,
17688 "type": {
17689 "fqn": "@aws-cdk/aws-ecs.ContainerDependencyCondition"
17690 }
17691 }
17692 ],
17693 "symbolId": "lib/container-definition:ContainerDependency"
17694 },
17695 "@aws-cdk/aws-ecs.ContainerDependencyCondition": {
17696 "assembly": "@aws-cdk/aws-ecs",
17697 "docs": {
17698 "stability": "stable"
17699 },
17700 "fqn": "@aws-cdk/aws-ecs.ContainerDependencyCondition",
17701 "kind": "enum",
17702 "locationInModule": {
17703 "filename": "lib/container-definition.ts",
17704 "line": 942
17705 },
17706 "members": [
17707 {
17708 "docs": {
17709 "remarks": "It validates that a dependent container is started before permitting other containers to start.",
17710 "stability": "stable",
17711 "summary": "This condition emulates the behavior of links and volumes today."
17712 },
17713 "name": "START"
17714 },
17715 {
17716 "docs": {
17717 "remarks": "This can be useful for nonessential containers that run a script and then exit.",
17718 "stability": "stable",
17719 "summary": "This condition validates that a dependent container runs to completion (exits) before permitting other containers to start."
17720 },
17721 "name": "COMPLETE"
17722 },
17723 {
17724 "docs": {
17725 "stability": "stable",
17726 "summary": "This condition is the same as COMPLETE, but it also requires that the container exits with a zero status."
17727 },
17728 "name": "SUCCESS"
17729 },
17730 {
17731 "docs": {
17732 "remarks": "This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.",
17733 "stability": "stable",
17734 "summary": "This condition validates that the dependent container passes its Docker health check before permitting other containers to start."
17735 },
17736 "name": "HEALTHY"
17737 }
17738 ],
17739 "name": "ContainerDependencyCondition",
17740 "symbolId": "lib/container-definition:ContainerDependencyCondition"
17741 },
17742 "@aws-cdk/aws-ecs.ContainerImage": {
17743 "abstract": true,
17744 "assembly": "@aws-cdk/aws-ecs",
17745 "docs": {
17746 "custom": {
17747 "exampleMetadata": "infused"
17748 },
17749 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'FargateCPCluster', {\n vpc,\n enableFargateCapacityProviders: true,\n});\n\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef');\n\ntaskDefinition.addContainer('web', {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n});\n\nnew ecs.FargateService(this, 'FargateService', {\n cluster,\n taskDefinition,\n capacityProviderStrategies: [\n {\n capacityProvider: 'FARGATE_SPOT',\n weight: 2,\n },\n {\n capacityProvider: 'FARGATE',\n weight: 1,\n },\n ],\n});",
17750 "stability": "stable",
17751 "summary": "Constructs for types of container images."
17752 },
17753 "fqn": "@aws-cdk/aws-ecs.ContainerImage",
17754 "initializer": {
17755 "docs": {
17756 "stability": "stable"
17757 }
17758 },
17759 "kind": "class",
17760 "locationInModule": {
17761 "filename": "lib/container-image.ts",
17762 "line": 13
17763 },
17764 "methods": [
17765 {
17766 "docs": {
17767 "remarks": "If you already have a `DockerImageAsset` instance, you can use the\n`ContainerImage.fromDockerImageAsset` method instead.",
17768 "stability": "stable",
17769 "summary": "Reference an image that's constructed directly from sources on disk."
17770 },
17771 "locationInModule": {
17772 "filename": "lib/container-image.ts",
17773 "line": 36
17774 },
17775 "name": "fromAsset",
17776 "parameters": [
17777 {
17778 "docs": {
17779 "summary": "The directory containing the Dockerfile."
17780 },
17781 "name": "directory",
17782 "type": {
17783 "primitive": "string"
17784 }
17785 },
17786 {
17787 "name": "props",
17788 "optional": true,
17789 "type": {
17790 "fqn": "@aws-cdk/aws-ecs.AssetImageProps"
17791 }
17792 }
17793 ],
17794 "returns": {
17795 "type": {
17796 "fqn": "@aws-cdk/aws-ecs.AssetImage"
17797 }
17798 },
17799 "static": true
17800 },
17801 {
17802 "docs": {
17803 "stability": "stable",
17804 "summary": "Use an existing `DockerImageAsset` for this container image."
17805 },
17806 "locationInModule": {
17807 "filename": "lib/container-image.ts",
17808 "line": 45
17809 },
17810 "name": "fromDockerImageAsset",
17811 "parameters": [
17812 {
17813 "docs": {
17814 "summary": "The `DockerImageAsset` to use for this container definition."
17815 },
17816 "name": "asset",
17817 "type": {
17818 "fqn": "@aws-cdk/aws-ecr-assets.DockerImageAsset"
17819 }
17820 }
17821 ],
17822 "returns": {
17823 "type": {
17824 "fqn": "@aws-cdk/aws-ecs.ContainerImage"
17825 }
17826 },
17827 "static": true
17828 },
17829 {
17830 "docs": {
17831 "stability": "stable",
17832 "summary": "Reference an image in an ECR repository."
17833 },
17834 "locationInModule": {
17835 "filename": "lib/container-image.ts",
17836 "line": 24
17837 },
17838 "name": "fromEcrRepository",
17839 "parameters": [
17840 {
17841 "name": "repository",
17842 "type": {
17843 "fqn": "@aws-cdk/aws-ecr.IRepository"
17844 }
17845 },
17846 {
17847 "name": "tag",
17848 "optional": true,
17849 "type": {
17850 "primitive": "string"
17851 }
17852 }
17853 ],
17854 "returns": {
17855 "type": {
17856 "fqn": "@aws-cdk/aws-ecs.EcrImage"
17857 }
17858 },
17859 "static": true
17860 },
17861 {
17862 "docs": {
17863 "stability": "stable",
17864 "summary": "Reference an image on DockerHub or another online registry."
17865 },
17866 "locationInModule": {
17867 "filename": "lib/container-image.ts",
17868 "line": 17
17869 },
17870 "name": "fromRegistry",
17871 "parameters": [
17872 {
17873 "name": "name",
17874 "type": {
17875 "primitive": "string"
17876 }
17877 },
17878 {
17879 "name": "props",
17880 "optional": true,
17881 "type": {
17882 "fqn": "@aws-cdk/aws-ecs.RepositoryImageProps"
17883 }
17884 }
17885 ],
17886 "returns": {
17887 "type": {
17888 "fqn": "@aws-cdk/aws-ecs.RepositoryImage"
17889 }
17890 },
17891 "static": true
17892 },
17893 {
17894 "docs": {
17895 "remarks": "Use this method if the container image has already been created by another process (e.g. jib)\nand you want to add it as a container image asset.",
17896 "stability": "stable",
17897 "summary": "Use an existing tarball for this container image."
17898 },
17899 "locationInModule": {
17900 "filename": "lib/container-image.ts",
17901 "line": 65
17902 },
17903 "name": "fromTarball",
17904 "parameters": [
17905 {
17906 "docs": {
17907 "remarks": "You can use language-specific idioms (such as `__dirname` in Node.js)\nto create an absolute path based on the current script running directory.",
17908 "summary": "Absolute path to the tarball."
17909 },
17910 "name": "tarballFile",
17911 "type": {
17912 "primitive": "string"
17913 }
17914 }
17915 ],
17916 "returns": {
17917 "type": {
17918 "fqn": "@aws-cdk/aws-ecs.ContainerImage"
17919 }
17920 },
17921 "static": true
17922 },
17923 {
17924 "abstract": true,
17925 "docs": {
17926 "stability": "stable",
17927 "summary": "Called when the image is used by a ContainerDefinition."
17928 },
17929 "locationInModule": {
17930 "filename": "lib/container-image.ts",
17931 "line": 82
17932 },
17933 "name": "bind",
17934 "parameters": [
17935 {
17936 "name": "scope",
17937 "type": {
17938 "fqn": "@aws-cdk/core.Construct"
17939 }
17940 },
17941 {
17942 "name": "containerDefinition",
17943 "type": {
17944 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
17945 }
17946 }
17947 ],
17948 "returns": {
17949 "type": {
17950 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig"
17951 }
17952 }
17953 }
17954 ],
17955 "name": "ContainerImage",
17956 "symbolId": "lib/container-image:ContainerImage"
17957 },
17958 "@aws-cdk/aws-ecs.ContainerImageConfig": {
17959 "assembly": "@aws-cdk/aws-ecs",
17960 "datatype": true,
17961 "docs": {
17962 "stability": "stable",
17963 "summary": "The configuration for creating a container image.",
17964 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst containerImageConfig: ecs.ContainerImageConfig = {\n imageName: 'imageName',\n\n // the properties below are optional\n repositoryCredentials: {\n credentialsParameter: 'credentialsParameter',\n },\n};",
17965 "custom": {
17966 "exampleMetadata": "fixture=_generated"
17967 }
17968 },
17969 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig",
17970 "kind": "interface",
17971 "locationInModule": {
17972 "filename": "lib/container-image.ts",
17973 "line": 88
17974 },
17975 "name": "ContainerImageConfig",
17976 "properties": [
17977 {
17978 "abstract": true,
17979 "docs": {
17980 "stability": "stable",
17981 "summary": "Specifies the name of the container image."
17982 },
17983 "immutable": true,
17984 "locationInModule": {
17985 "filename": "lib/container-image.ts",
17986 "line": 92
17987 },
17988 "name": "imageName",
17989 "type": {
17990 "primitive": "string"
17991 }
17992 },
17993 {
17994 "abstract": true,
17995 "docs": {
17996 "stability": "stable",
17997 "summary": "Specifies the credentials used to access the image repository."
17998 },
17999 "immutable": true,
18000 "locationInModule": {
18001 "filename": "lib/container-image.ts",
18002 "line": 97
18003 },
18004 "name": "repositoryCredentials",
18005 "optional": true,
18006 "type": {
18007 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.RepositoryCredentialsProperty"
18008 }
18009 }
18010 ],
18011 "symbolId": "lib/container-image:ContainerImageConfig"
18012 },
18013 "@aws-cdk/aws-ecs.CpuArchitecture": {
18014 "assembly": "@aws-cdk/aws-ecs",
18015 "docs": {
18016 "custom": {
18017 "exampleMetadata": "infused"
18018 },
18019 "example": "// Create a Task Definition for the Windows container to start\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,\n cpuArchitecture: ecs.CpuArchitecture.X86_64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('windowsservercore', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),\n});",
18020 "stability": "stable",
18021 "summary": "The CpuArchitecture for Fargate Runtime Platform."
18022 },
18023 "fqn": "@aws-cdk/aws-ecs.CpuArchitecture",
18024 "kind": "class",
18025 "locationInModule": {
18026 "filename": "lib/runtime-platform.ts",
18027 "line": 4
18028 },
18029 "methods": [
18030 {
18031 "docs": {
18032 "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-cpuarchitecture for all available cpu architecture.",
18033 "stability": "stable",
18034 "summary": "Other cpu architecture."
18035 },
18036 "locationInModule": {
18037 "filename": "lib/runtime-platform.ts",
18038 "line": 23
18039 },
18040 "name": "of",
18041 "parameters": [
18042 {
18043 "docs": {
18044 "summary": "cpu architecture."
18045 },
18046 "name": "cpuArchitecture",
18047 "type": {
18048 "primitive": "string"
18049 }
18050 }
18051 ],
18052 "returns": {
18053 "type": {
18054 "fqn": "@aws-cdk/aws-ecs.CpuArchitecture"
18055 }
18056 },
18057 "static": true
18058 }
18059 ],
18060 "name": "CpuArchitecture",
18061 "properties": [
18062 {
18063 "const": true,
18064 "docs": {
18065 "stability": "stable",
18066 "summary": "ARM64."
18067 },
18068 "immutable": true,
18069 "locationInModule": {
18070 "filename": "lib/runtime-platform.ts",
18071 "line": 8
18072 },
18073 "name": "ARM64",
18074 "static": true,
18075 "type": {
18076 "fqn": "@aws-cdk/aws-ecs.CpuArchitecture"
18077 }
18078 },
18079 {
18080 "const": true,
18081 "docs": {
18082 "stability": "stable",
18083 "summary": "X86_64."
18084 },
18085 "immutable": true,
18086 "locationInModule": {
18087 "filename": "lib/runtime-platform.ts",
18088 "line": 13
18089 },
18090 "name": "X86_64",
18091 "static": true,
18092 "type": {
18093 "fqn": "@aws-cdk/aws-ecs.CpuArchitecture"
18094 }
18095 }
18096 ],
18097 "symbolId": "lib/runtime-platform:CpuArchitecture"
18098 },
18099 "@aws-cdk/aws-ecs.CpuUtilizationScalingProps": {
18100 "assembly": "@aws-cdk/aws-ecs",
18101 "datatype": true,
18102 "docs": {
18103 "custom": {
18104 "exampleMetadata": "infused"
18105 },
18106 "example": "declare const target: elbv2.ApplicationTargetGroup;\ndeclare const service: ecs.BaseService;\nconst scaling = service.autoScaleTaskCount({ maxCapacity: 10 });\nscaling.scaleOnCpuUtilization('CpuScaling', {\n targetUtilizationPercent: 50,\n});\n\nscaling.scaleOnRequestCount('RequestScaling', {\n requestsPerTarget: 10000,\n targetGroup: target,\n});",
18107 "stability": "stable",
18108 "summary": "The properties for enabling scaling based on CPU utilization."
18109 },
18110 "fqn": "@aws-cdk/aws-ecs.CpuUtilizationScalingProps",
18111 "interfaces": [
18112 "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps"
18113 ],
18114 "kind": "interface",
18115 "locationInModule": {
18116 "filename": "lib/base/scalable-task-count.ts",
18117 "line": 103
18118 },
18119 "name": "CpuUtilizationScalingProps",
18120 "properties": [
18121 {
18122 "abstract": true,
18123 "docs": {
18124 "stability": "stable",
18125 "summary": "The target value for CPU utilization across all tasks in the service."
18126 },
18127 "immutable": true,
18128 "locationInModule": {
18129 "filename": "lib/base/scalable-task-count.ts",
18130 "line": 107
18131 },
18132 "name": "targetUtilizationPercent",
18133 "type": {
18134 "primitive": "number"
18135 }
18136 }
18137 ],
18138 "symbolId": "lib/base/scalable-task-count:CpuUtilizationScalingProps"
18139 },
18140 "@aws-cdk/aws-ecs.DeploymentCircuitBreaker": {
18141 "assembly": "@aws-cdk/aws-ecs",
18142 "datatype": true,
18143 "docs": {
18144 "custom": {
18145 "exampleMetadata": "infused"
18146 },
18147 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst service = new ecs.FargateService(this, 'Service', {\n cluster,\n taskDefinition,\n circuitBreaker: { rollback: true },\n});",
18148 "stability": "stable",
18149 "summary": "The deployment circuit breaker to use for the service."
18150 },
18151 "fqn": "@aws-cdk/aws-ecs.DeploymentCircuitBreaker",
18152 "kind": "interface",
18153 "locationInModule": {
18154 "filename": "lib/base/base-service.ts",
18155 "line": 50
18156 },
18157 "name": "DeploymentCircuitBreaker",
18158 "properties": [
18159 {
18160 "abstract": true,
18161 "docs": {
18162 "default": "false",
18163 "stability": "stable",
18164 "summary": "Whether to enable rollback on deployment failure."
18165 },
18166 "immutable": true,
18167 "locationInModule": {
18168 "filename": "lib/base/base-service.ts",
18169 "line": 55
18170 },
18171 "name": "rollback",
18172 "optional": true,
18173 "type": {
18174 "primitive": "boolean"
18175 }
18176 }
18177 ],
18178 "symbolId": "lib/base/base-service:DeploymentCircuitBreaker"
18179 },
18180 "@aws-cdk/aws-ecs.DeploymentController": {
18181 "assembly": "@aws-cdk/aws-ecs",
18182 "datatype": true,
18183 "docs": {
18184 "custom": {
18185 "exampleMetadata": "infused"
18186 },
18187 "example": "declare const cluster: ecs.Cluster;\nconst loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {\n cluster,\n memoryLimitMiB: 1024,\n desiredCount: 1,\n cpu: 512,\n taskImageOptions: {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n },\n deploymentController: {\n type: ecs.DeploymentControllerType.CODE_DEPLOY,\n },\n});",
18188 "stability": "stable",
18189 "summary": "The deployment controller to use for the service."
18190 },
18191 "fqn": "@aws-cdk/aws-ecs.DeploymentController",
18192 "kind": "interface",
18193 "locationInModule": {
18194 "filename": "lib/base/base-service.ts",
18195 "line": 38
18196 },
18197 "name": "DeploymentController",
18198 "properties": [
18199 {
18200 "abstract": true,
18201 "docs": {
18202 "default": "DeploymentControllerType.ECS",
18203 "stability": "stable",
18204 "summary": "The deployment controller type to use."
18205 },
18206 "immutable": true,
18207 "locationInModule": {
18208 "filename": "lib/base/base-service.ts",
18209 "line": 44
18210 },
18211 "name": "type",
18212 "optional": true,
18213 "type": {
18214 "fqn": "@aws-cdk/aws-ecs.DeploymentControllerType"
18215 }
18216 }
18217 ],
18218 "symbolId": "lib/base/base-service:DeploymentController"
18219 },
18220 "@aws-cdk/aws-ecs.DeploymentControllerType": {
18221 "assembly": "@aws-cdk/aws-ecs",
18222 "docs": {
18223 "custom": {
18224 "exampleMetadata": "infused"
18225 },
18226 "example": "declare const cluster: ecs.Cluster;\nconst loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {\n cluster,\n memoryLimitMiB: 1024,\n desiredCount: 1,\n cpu: 512,\n taskImageOptions: {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n },\n deploymentController: {\n type: ecs.DeploymentControllerType.CODE_DEPLOY,\n },\n});",
18227 "stability": "stable",
18228 "summary": "The deployment controller type to use for the service."
18229 },
18230 "fqn": "@aws-cdk/aws-ecs.DeploymentControllerType",
18231 "kind": "enum",
18232 "locationInModule": {
18233 "filename": "lib/base/base-service.ts",
18234 "line": 1090
18235 },
18236 "members": [
18237 {
18238 "docs": {
18239 "stability": "stable",
18240 "summary": "The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version."
18241 },
18242 "name": "ECS"
18243 },
18244 {
18245 "docs": {
18246 "stability": "stable",
18247 "summary": "The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy."
18248 },
18249 "name": "CODE_DEPLOY"
18250 },
18251 {
18252 "docs": {
18253 "stability": "stable",
18254 "summary": "The external (EXTERNAL) deployment type enables you to use any third-party deployment controller."
18255 },
18256 "name": "EXTERNAL"
18257 }
18258 ],
18259 "name": "DeploymentControllerType",
18260 "symbolId": "lib/base/base-service:DeploymentControllerType"
18261 },
18262 "@aws-cdk/aws-ecs.Device": {
18263 "assembly": "@aws-cdk/aws-ecs",
18264 "datatype": true,
18265 "docs": {
18266 "stability": "stable",
18267 "summary": "A container instance host device.",
18268 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst device: ecs.Device = {\n hostPath: 'hostPath',\n\n // the properties below are optional\n containerPath: 'containerPath',\n permissions: [ecs.DevicePermission.READ],\n};",
18269 "custom": {
18270 "exampleMetadata": "fixture=_generated"
18271 }
18272 },
18273 "fqn": "@aws-cdk/aws-ecs.Device",
18274 "kind": "interface",
18275 "locationInModule": {
18276 "filename": "lib/linux-parameters.ts",
18277 "line": 126
18278 },
18279 "name": "Device",
18280 "properties": [
18281 {
18282 "abstract": true,
18283 "docs": {
18284 "stability": "stable",
18285 "summary": "The path for the device on the host container instance."
18286 },
18287 "immutable": true,
18288 "locationInModule": {
18289 "filename": "lib/linux-parameters.ts",
18290 "line": 137
18291 },
18292 "name": "hostPath",
18293 "type": {
18294 "primitive": "string"
18295 }
18296 },
18297 {
18298 "abstract": true,
18299 "docs": {
18300 "default": "Same path as the host",
18301 "stability": "stable",
18302 "summary": "The path inside the container at which to expose the host device."
18303 },
18304 "immutable": true,
18305 "locationInModule": {
18306 "filename": "lib/linux-parameters.ts",
18307 "line": 132
18308 },
18309 "name": "containerPath",
18310 "optional": true,
18311 "type": {
18312 "primitive": "string"
18313 }
18314 },
18315 {
18316 "abstract": true,
18317 "docs": {
18318 "default": "Readonly",
18319 "remarks": "By default, the container has permissions for read, write, and mknod for the device.",
18320 "stability": "stable",
18321 "summary": "The explicit permissions to provide to the container for the device."
18322 },
18323 "immutable": true,
18324 "locationInModule": {
18325 "filename": "lib/linux-parameters.ts",
18326 "line": 145
18327 },
18328 "name": "permissions",
18329 "optional": true,
18330 "type": {
18331 "collection": {
18332 "elementtype": {
18333 "fqn": "@aws-cdk/aws-ecs.DevicePermission"
18334 },
18335 "kind": "array"
18336 }
18337 }
18338 }
18339 ],
18340 "symbolId": "lib/linux-parameters:Device"
18341 },
18342 "@aws-cdk/aws-ecs.DevicePermission": {
18343 "assembly": "@aws-cdk/aws-ecs",
18344 "docs": {
18345 "stability": "stable",
18346 "summary": "Permissions for device access."
18347 },
18348 "fqn": "@aws-cdk/aws-ecs.DevicePermission",
18349 "kind": "enum",
18350 "locationInModule": {
18351 "filename": "lib/linux-parameters.ts",
18352 "line": 232
18353 },
18354 "members": [
18355 {
18356 "docs": {
18357 "stability": "stable",
18358 "summary": "Read."
18359 },
18360 "name": "READ"
18361 },
18362 {
18363 "docs": {
18364 "stability": "stable",
18365 "summary": "Write."
18366 },
18367 "name": "WRITE"
18368 },
18369 {
18370 "docs": {
18371 "stability": "stable",
18372 "summary": "Make a node."
18373 },
18374 "name": "MKNOD"
18375 }
18376 ],
18377 "name": "DevicePermission",
18378 "symbolId": "lib/linux-parameters:DevicePermission"
18379 },
18380 "@aws-cdk/aws-ecs.DockerVolumeConfiguration": {
18381 "assembly": "@aws-cdk/aws-ecs",
18382 "datatype": true,
18383 "docs": {
18384 "remarks": "Docker volumes are only supported when you are using the EC2 launch type.",
18385 "stability": "stable",
18386 "summary": "The configuration for a Docker volume.",
18387 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst dockerVolumeConfiguration: ecs.DockerVolumeConfiguration = {\n driver: 'driver',\n scope: ecs.Scope.TASK,\n\n // the properties below are optional\n autoprovision: false,\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n};",
18388 "custom": {
18389 "exampleMetadata": "fixture=_generated"
18390 }
18391 },
18392 "fqn": "@aws-cdk/aws-ecs.DockerVolumeConfiguration",
18393 "kind": "interface",
18394 "locationInModule": {
18395 "filename": "lib/base/task-definition.ts",
18396 "line": 955
18397 },
18398 "name": "DockerVolumeConfiguration",
18399 "properties": [
18400 {
18401 "abstract": true,
18402 "docs": {
18403 "stability": "stable",
18404 "summary": "The Docker volume driver to use."
18405 },
18406 "immutable": true,
18407 "locationInModule": {
18408 "filename": "lib/base/task-definition.ts",
18409 "line": 966
18410 },
18411 "name": "driver",
18412 "type": {
18413 "primitive": "string"
18414 }
18415 },
18416 {
18417 "abstract": true,
18418 "docs": {
18419 "stability": "stable",
18420 "summary": "The scope for the Docker volume that determines its lifecycle."
18421 },
18422 "immutable": true,
18423 "locationInModule": {
18424 "filename": "lib/base/task-definition.ts",
18425 "line": 982
18426 },
18427 "name": "scope",
18428 "type": {
18429 "fqn": "@aws-cdk/aws-ecs.Scope"
18430 }
18431 },
18432 {
18433 "abstract": true,
18434 "docs": {
18435 "default": "false",
18436 "remarks": "If true is specified, the Docker volume will be created for you.",
18437 "stability": "stable",
18438 "summary": "Specifies whether the Docker volume should be created if it does not already exist."
18439 },
18440 "immutable": true,
18441 "locationInModule": {
18442 "filename": "lib/base/task-definition.ts",
18443 "line": 962
18444 },
18445 "name": "autoprovision",
18446 "optional": true,
18447 "type": {
18448 "primitive": "boolean"
18449 }
18450 },
18451 {
18452 "abstract": true,
18453 "docs": {
18454 "default": "No options",
18455 "stability": "stable",
18456 "summary": "A map of Docker driver-specific options passed through."
18457 },
18458 "immutable": true,
18459 "locationInModule": {
18460 "filename": "lib/base/task-definition.ts",
18461 "line": 972
18462 },
18463 "name": "driverOpts",
18464 "optional": true,
18465 "type": {
18466 "collection": {
18467 "elementtype": {
18468 "primitive": "string"
18469 },
18470 "kind": "map"
18471 }
18472 }
18473 },
18474 {
18475 "abstract": true,
18476 "docs": {
18477 "default": "No labels",
18478 "stability": "stable",
18479 "summary": "Custom metadata to add to your Docker volume."
18480 },
18481 "immutable": true,
18482 "locationInModule": {
18483 "filename": "lib/base/task-definition.ts",
18484 "line": 978
18485 },
18486 "name": "labels",
18487 "optional": true,
18488 "type": {
18489 "collection": {
18490 "elementtype": {
18491 "primitive": "string"
18492 },
18493 "kind": "map"
18494 }
18495 }
18496 }
18497 ],
18498 "symbolId": "lib/base/task-definition:DockerVolumeConfiguration"
18499 },
18500 "@aws-cdk/aws-ecs.Ec2Service": {
18501 "assembly": "@aws-cdk/aws-ecs",
18502 "base": "@aws-cdk/aws-ecs.BaseService",
18503 "docs": {
18504 "custom": {
18505 "exampleMetadata": "infused",
18506 "resource": "AWS::ECS::Service"
18507 },
18508 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elb.LoadBalancer(this, 'LB', { vpc });\nlb.addListener({ externalPort: 80 });\nlb.addTarget(service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 80,\n}));",
18509 "stability": "stable",
18510 "summary": "This creates a service using the EC2 launch type on an ECS cluster."
18511 },
18512 "fqn": "@aws-cdk/aws-ecs.Ec2Service",
18513 "initializer": {
18514 "docs": {
18515 "stability": "stable",
18516 "summary": "Constructs a new instance of the Ec2Service class."
18517 },
18518 "locationInModule": {
18519 "filename": "lib/ec2/ec2-service.ts",
18520 "line": 150
18521 },
18522 "parameters": [
18523 {
18524 "name": "scope",
18525 "type": {
18526 "fqn": "constructs.Construct"
18527 }
18528 },
18529 {
18530 "name": "id",
18531 "type": {
18532 "primitive": "string"
18533 }
18534 },
18535 {
18536 "name": "props",
18537 "type": {
18538 "fqn": "@aws-cdk/aws-ecs.Ec2ServiceProps"
18539 }
18540 }
18541 ]
18542 },
18543 "interfaces": [
18544 "@aws-cdk/aws-ecs.IEc2Service"
18545 ],
18546 "kind": "class",
18547 "locationInModule": {
18548 "filename": "lib/ec2/ec2-service.ts",
18549 "line": 123
18550 },
18551 "methods": [
18552 {
18553 "docs": {
18554 "stability": "stable",
18555 "summary": "Imports from the specified service ARN."
18556 },
18557 "locationInModule": {
18558 "filename": "lib/ec2/ec2-service.ts",
18559 "line": 128
18560 },
18561 "name": "fromEc2ServiceArn",
18562 "parameters": [
18563 {
18564 "name": "scope",
18565 "type": {
18566 "fqn": "constructs.Construct"
18567 }
18568 },
18569 {
18570 "name": "id",
18571 "type": {
18572 "primitive": "string"
18573 }
18574 },
18575 {
18576 "name": "ec2ServiceArn",
18577 "type": {
18578 "primitive": "string"
18579 }
18580 }
18581 ],
18582 "returns": {
18583 "type": {
18584 "fqn": "@aws-cdk/aws-ecs.IEc2Service"
18585 }
18586 },
18587 "static": true
18588 },
18589 {
18590 "docs": {
18591 "stability": "stable",
18592 "summary": "Imports from the specified service attrributes."
18593 },
18594 "locationInModule": {
18595 "filename": "lib/ec2/ec2-service.ts",
18596 "line": 139
18597 },
18598 "name": "fromEc2ServiceAttributes",
18599 "parameters": [
18600 {
18601 "name": "scope",
18602 "type": {
18603 "fqn": "constructs.Construct"
18604 }
18605 },
18606 {
18607 "name": "id",
18608 "type": {
18609 "primitive": "string"
18610 }
18611 },
18612 {
18613 "name": "attrs",
18614 "type": {
18615 "fqn": "@aws-cdk/aws-ecs.Ec2ServiceAttributes"
18616 }
18617 }
18618 ],
18619 "returns": {
18620 "type": {
18621 "fqn": "@aws-cdk/aws-ecs.IBaseService"
18622 }
18623 },
18624 "static": true
18625 },
18626 {
18627 "docs": {
18628 "remarks": "For more information, see\n[Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).",
18629 "stability": "stable",
18630 "summary": "Adds one or more placement constraints to use for tasks in the service."
18631 },
18632 "locationInModule": {
18633 "filename": "lib/ec2/ec2-service.ts",
18634 "line": 239
18635 },
18636 "name": "addPlacementConstraints",
18637 "parameters": [
18638 {
18639 "name": "constraints",
18640 "type": {
18641 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
18642 },
18643 "variadic": true
18644 }
18645 ],
18646 "variadic": true
18647 },
18648 {
18649 "docs": {
18650 "remarks": "For more information, see\n[Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).",
18651 "stability": "stable",
18652 "summary": "Adds one or more placement strategies to use for tasks in the service."
18653 },
18654 "locationInModule": {
18655 "filename": "lib/ec2/ec2-service.ts",
18656 "line": 225
18657 },
18658 "name": "addPlacementStrategies",
18659 "parameters": [
18660 {
18661 "name": "strategies",
18662 "type": {
18663 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
18664 },
18665 "variadic": true
18666 }
18667 ],
18668 "variadic": true
18669 },
18670 {
18671 "docs": {
18672 "stability": "stable",
18673 "summary": "Validates this Ec2Service."
18674 },
18675 "locationInModule": {
18676 "filename": "lib/ec2/ec2-service.ts",
18677 "line": 248
18678 },
18679 "name": "validate",
18680 "overrides": "@aws-cdk/core.Construct",
18681 "protected": true,
18682 "returns": {
18683 "type": {
18684 "collection": {
18685 "elementtype": {
18686 "primitive": "string"
18687 },
18688 "kind": "array"
18689 }
18690 }
18691 }
18692 }
18693 ],
18694 "name": "Ec2Service",
18695 "symbolId": "lib/ec2/ec2-service:Ec2Service"
18696 },
18697 "@aws-cdk/aws-ecs.Ec2ServiceAttributes": {
18698 "assembly": "@aws-cdk/aws-ecs",
18699 "datatype": true,
18700 "docs": {
18701 "stability": "stable",
18702 "summary": "The properties to import from the service using the EC2 launch type.",
18703 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const cluster: ecs.Cluster;\nconst ec2ServiceAttributes: ecs.Ec2ServiceAttributes = {\n cluster: cluster,\n\n // the properties below are optional\n serviceArn: 'serviceArn',\n serviceName: 'serviceName',\n};",
18704 "custom": {
18705 "exampleMetadata": "fixture=_generated"
18706 }
18707 },
18708 "fqn": "@aws-cdk/aws-ecs.Ec2ServiceAttributes",
18709 "kind": "interface",
18710 "locationInModule": {
18711 "filename": "lib/ec2/ec2-service.ts",
18712 "line": 97
18713 },
18714 "name": "Ec2ServiceAttributes",
18715 "properties": [
18716 {
18717 "abstract": true,
18718 "docs": {
18719 "stability": "stable",
18720 "summary": "The cluster that hosts the service."
18721 },
18722 "immutable": true,
18723 "locationInModule": {
18724 "filename": "lib/ec2/ec2-service.ts",
18725 "line": 101
18726 },
18727 "name": "cluster",
18728 "type": {
18729 "fqn": "@aws-cdk/aws-ecs.ICluster"
18730 }
18731 },
18732 {
18733 "abstract": true,
18734 "docs": {
18735 "default": "- either this, or {@link serviceName}, is required",
18736 "stability": "stable",
18737 "summary": "The service ARN."
18738 },
18739 "immutable": true,
18740 "locationInModule": {
18741 "filename": "lib/ec2/ec2-service.ts",
18742 "line": 108
18743 },
18744 "name": "serviceArn",
18745 "optional": true,
18746 "type": {
18747 "primitive": "string"
18748 }
18749 },
18750 {
18751 "abstract": true,
18752 "docs": {
18753 "default": "- either this, or {@link serviceArn}, is required",
18754 "stability": "stable",
18755 "summary": "The name of the service."
18756 },
18757 "immutable": true,
18758 "locationInModule": {
18759 "filename": "lib/ec2/ec2-service.ts",
18760 "line": 115
18761 },
18762 "name": "serviceName",
18763 "optional": true,
18764 "type": {
18765 "primitive": "string"
18766 }
18767 }
18768 ],
18769 "symbolId": "lib/ec2/ec2-service:Ec2ServiceAttributes"
18770 },
18771 "@aws-cdk/aws-ecs.Ec2ServiceProps": {
18772 "assembly": "@aws-cdk/aws-ecs",
18773 "datatype": true,
18774 "docs": {
18775 "custom": {
18776 "exampleMetadata": "infused"
18777 },
18778 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elb.LoadBalancer(this, 'LB', { vpc });\nlb.addListener({ externalPort: 80 });\nlb.addTarget(service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 80,\n}));",
18779 "stability": "stable",
18780 "summary": "The properties for defining a service using the EC2 launch type."
18781 },
18782 "fqn": "@aws-cdk/aws-ecs.Ec2ServiceProps",
18783 "interfaces": [
18784 "@aws-cdk/aws-ecs.BaseServiceOptions"
18785 ],
18786 "kind": "interface",
18787 "locationInModule": {
18788 "filename": "lib/ec2/ec2-service.ts",
18789 "line": 14
18790 },
18791 "name": "Ec2ServiceProps",
18792 "properties": [
18793 {
18794 "abstract": true,
18795 "docs": {
18796 "remarks": "[disable-awslint:ref-via-interface]",
18797 "stability": "stable",
18798 "summary": "The task definition to use for tasks in the service."
18799 },
18800 "immutable": true,
18801 "locationInModule": {
18802 "filename": "lib/ec2/ec2-service.ts",
18803 "line": 20
18804 },
18805 "name": "taskDefinition",
18806 "type": {
18807 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
18808 }
18809 },
18810 {
18811 "abstract": true,
18812 "docs": {
18813 "default": "false",
18814 "remarks": "If true, each task will receive a public IP address.\n\nThis property is only used for tasks that use the awsvpc network mode.",
18815 "stability": "stable",
18816 "summary": "Specifies whether the task's elastic network interface receives a public IP address."
18817 },
18818 "immutable": true,
18819 "locationInModule": {
18820 "filename": "lib/ec2/ec2-service.ts",
18821 "line": 30
18822 },
18823 "name": "assignPublicIp",
18824 "optional": true,
18825 "type": {
18826 "primitive": "boolean"
18827 }
18828 },
18829 {
18830 "abstract": true,
18831 "docs": {
18832 "default": "false",
18833 "remarks": "If true, the service scheduler deploys exactly one task on each container instance in your cluster.\n\nWhen you are using this strategy, do not specify a desired number of tasks orany task placement strategies.",
18834 "stability": "stable",
18835 "summary": "Specifies whether the service will use the daemon scheduling strategy."
18836 },
18837 "immutable": true,
18838 "locationInModule": {
18839 "filename": "lib/ec2/ec2-service.ts",
18840 "line": 84
18841 },
18842 "name": "daemon",
18843 "optional": true,
18844 "type": {
18845 "primitive": "boolean"
18846 }
18847 },
18848 {
18849 "abstract": true,
18850 "docs": {
18851 "default": "- No constraints.",
18852 "remarks": "For more information, see\n[Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).",
18853 "stability": "stable",
18854 "summary": "The placement constraints to use for tasks in the service."
18855 },
18856 "immutable": true,
18857 "locationInModule": {
18858 "filename": "lib/ec2/ec2-service.ts",
18859 "line": 66
18860 },
18861 "name": "placementConstraints",
18862 "optional": true,
18863 "type": {
18864 "collection": {
18865 "elementtype": {
18866 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
18867 },
18868 "kind": "array"
18869 }
18870 }
18871 },
18872 {
18873 "abstract": true,
18874 "docs": {
18875 "default": "- No strategies.",
18876 "remarks": "For more information, see\n[Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).",
18877 "stability": "stable",
18878 "summary": "The placement strategies to use for tasks in the service."
18879 },
18880 "immutable": true,
18881 "locationInModule": {
18882 "filename": "lib/ec2/ec2-service.ts",
18883 "line": 74
18884 },
18885 "name": "placementStrategies",
18886 "optional": true,
18887 "type": {
18888 "collection": {
18889 "elementtype": {
18890 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
18891 },
18892 "kind": "array"
18893 }
18894 }
18895 },
18896 {
18897 "abstract": true,
18898 "docs": {
18899 "default": "- A new security group is created.",
18900 "deprecated": "use securityGroups instead.",
18901 "remarks": "If you do not specify a security group, a new security group is created.\n\nThis property is only used for tasks that use the awsvpc network mode.",
18902 "stability": "deprecated",
18903 "summary": "The security groups to associate with the service."
18904 },
18905 "immutable": true,
18906 "locationInModule": {
18907 "filename": "lib/ec2/ec2-service.ts",
18908 "line": 49
18909 },
18910 "name": "securityGroup",
18911 "optional": true,
18912 "type": {
18913 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
18914 }
18915 },
18916 {
18917 "abstract": true,
18918 "docs": {
18919 "default": "- A new security group is created.",
18920 "remarks": "If you do not specify a security group, a new security group is created.\n\nThis property is only used for tasks that use the awsvpc network mode.",
18921 "stability": "stable",
18922 "summary": "The security groups to associate with the service."
18923 },
18924 "immutable": true,
18925 "locationInModule": {
18926 "filename": "lib/ec2/ec2-service.ts",
18927 "line": 58
18928 },
18929 "name": "securityGroups",
18930 "optional": true,
18931 "type": {
18932 "collection": {
18933 "elementtype": {
18934 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
18935 },
18936 "kind": "array"
18937 }
18938 }
18939 },
18940 {
18941 "abstract": true,
18942 "docs": {
18943 "default": "- Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.",
18944 "remarks": "This property is only used for tasks that use the awsvpc network mode.",
18945 "stability": "stable",
18946 "summary": "The subnets to associate with the service."
18947 },
18948 "immutable": true,
18949 "locationInModule": {
18950 "filename": "lib/ec2/ec2-service.ts",
18951 "line": 39
18952 },
18953 "name": "vpcSubnets",
18954 "optional": true,
18955 "type": {
18956 "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
18957 }
18958 }
18959 ],
18960 "symbolId": "lib/ec2/ec2-service:Ec2ServiceProps"
18961 },
18962 "@aws-cdk/aws-ecs.Ec2TaskDefinition": {
18963 "assembly": "@aws-cdk/aws-ecs",
18964 "base": "@aws-cdk/aws-ecs.TaskDefinition",
18965 "docs": {
18966 "custom": {
18967 "exampleMetadata": "infused",
18968 "resource": "AWS::ECS::TaskDefinition"
18969 },
18970 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.splunk({\n token: SecretValue.secretsManager('my-splunk-token'),\n url: 'my-splunk-url',\n }),\n});",
18971 "stability": "stable",
18972 "summary": "The details of a task definition run on an EC2 cluster."
18973 },
18974 "fqn": "@aws-cdk/aws-ecs.Ec2TaskDefinition",
18975 "initializer": {
18976 "docs": {
18977 "stability": "stable",
18978 "summary": "Constructs a new instance of the Ec2TaskDefinition class."
18979 },
18980 "locationInModule": {
18981 "filename": "lib/ec2/ec2-task-definition.ts",
18982 "line": 115
18983 },
18984 "parameters": [
18985 {
18986 "name": "scope",
18987 "type": {
18988 "fqn": "constructs.Construct"
18989 }
18990 },
18991 {
18992 "name": "id",
18993 "type": {
18994 "primitive": "string"
18995 }
18996 },
18997 {
18998 "name": "props",
18999 "optional": true,
19000 "type": {
19001 "fqn": "@aws-cdk/aws-ecs.Ec2TaskDefinitionProps"
19002 }
19003 }
19004 ]
19005 },
19006 "interfaces": [
19007 "@aws-cdk/aws-ecs.IEc2TaskDefinition"
19008 ],
19009 "kind": "class",
19010 "locationInModule": {
19011 "filename": "lib/ec2/ec2-task-definition.ts",
19012 "line": 85
19013 },
19014 "methods": [
19015 {
19016 "docs": {
19017 "stability": "stable",
19018 "summary": "Imports a task definition from the specified task definition ARN."
19019 },
19020 "locationInModule": {
19021 "filename": "lib/ec2/ec2-task-definition.ts",
19022 "line": 90
19023 },
19024 "name": "fromEc2TaskDefinitionArn",
19025 "parameters": [
19026 {
19027 "name": "scope",
19028 "type": {
19029 "fqn": "constructs.Construct"
19030 }
19031 },
19032 {
19033 "name": "id",
19034 "type": {
19035 "primitive": "string"
19036 }
19037 },
19038 {
19039 "name": "ec2TaskDefinitionArn",
19040 "type": {
19041 "primitive": "string"
19042 }
19043 }
19044 ],
19045 "returns": {
19046 "type": {
19047 "fqn": "@aws-cdk/aws-ecs.IEc2TaskDefinition"
19048 }
19049 },
19050 "static": true
19051 },
19052 {
19053 "docs": {
19054 "stability": "stable",
19055 "summary": "Imports an existing Ec2 task definition from its attributes."
19056 },
19057 "locationInModule": {
19058 "filename": "lib/ec2/ec2-task-definition.ts",
19059 "line": 99
19060 },
19061 "name": "fromEc2TaskDefinitionAttributes",
19062 "parameters": [
19063 {
19064 "name": "scope",
19065 "type": {
19066 "fqn": "constructs.Construct"
19067 }
19068 },
19069 {
19070 "name": "id",
19071 "type": {
19072 "primitive": "string"
19073 }
19074 },
19075 {
19076 "name": "attrs",
19077 "type": {
19078 "fqn": "@aws-cdk/aws-ecs.Ec2TaskDefinitionAttributes"
19079 }
19080 }
19081 ],
19082 "returns": {
19083 "type": {
19084 "fqn": "@aws-cdk/aws-ecs.IEc2TaskDefinition"
19085 }
19086 },
19087 "static": true
19088 }
19089 ],
19090 "name": "Ec2TaskDefinition",
19091 "symbolId": "lib/ec2/ec2-task-definition:Ec2TaskDefinition"
19092 },
19093 "@aws-cdk/aws-ecs.Ec2TaskDefinitionAttributes": {
19094 "assembly": "@aws-cdk/aws-ecs",
19095 "datatype": true,
19096 "docs": {
19097 "stability": "stable",
19098 "summary": "Attributes used to import an existing EC2 task definition.",
19099 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst ec2TaskDefinitionAttributes: ecs.Ec2TaskDefinitionAttributes = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n networkMode: ecs.NetworkMode.NONE,\n taskRole: role,\n};",
19100 "custom": {
19101 "exampleMetadata": "fixture=_generated"
19102 }
19103 },
19104 "fqn": "@aws-cdk/aws-ecs.Ec2TaskDefinitionAttributes",
19105 "interfaces": [
19106 "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes"
19107 ],
19108 "kind": "interface",
19109 "locationInModule": {
19110 "filename": "lib/ec2/ec2-task-definition.ts",
19111 "line": 76
19112 },
19113 "name": "Ec2TaskDefinitionAttributes",
19114 "symbolId": "lib/ec2/ec2-task-definition:Ec2TaskDefinitionAttributes"
19115 },
19116 "@aws-cdk/aws-ecs.Ec2TaskDefinitionProps": {
19117 "assembly": "@aws-cdk/aws-ecs",
19118 "datatype": true,
19119 "docs": {
19120 "custom": {
19121 "exampleMetadata": "infused"
19122 },
19123 "example": "const ec2TaskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef', {\n networkMode: ecs.NetworkMode.BRIDGE,\n});\n\nconst container = ec2TaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n // ... other options here ...\n});",
19124 "stability": "stable",
19125 "summary": "The properties for a task definition run on an EC2 cluster."
19126 },
19127 "fqn": "@aws-cdk/aws-ecs.Ec2TaskDefinitionProps",
19128 "interfaces": [
19129 "@aws-cdk/aws-ecs.CommonTaskDefinitionProps"
19130 ],
19131 "kind": "interface",
19132 "locationInModule": {
19133 "filename": "lib/ec2/ec2-task-definition.ts",
19134 "line": 19
19135 },
19136 "name": "Ec2TaskDefinitionProps",
19137 "properties": [
19138 {
19139 "abstract": true,
19140 "docs": {
19141 "default": "- No inference accelerators.",
19142 "remarks": "Not supported in Fargate.",
19143 "stability": "stable",
19144 "summary": "The inference accelerators to use for the containers in the task."
19145 },
19146 "immutable": true,
19147 "locationInModule": {
19148 "filename": "lib/ec2/ec2-task-definition.ts",
19149 "line": 63
19150 },
19151 "name": "inferenceAccelerators",
19152 "optional": true,
19153 "type": {
19154 "collection": {
19155 "elementtype": {
19156 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator"
19157 },
19158 "kind": "array"
19159 }
19160 }
19161 },
19162 {
19163 "abstract": true,
19164 "docs": {
19165 "default": "- IpcMode used by the task is not specified",
19166 "remarks": "Not supported in Fargate and Windows containers.",
19167 "stability": "stable",
19168 "summary": "The IPC resource namespace to use for the containers in the task."
19169 },
19170 "immutable": true,
19171 "locationInModule": {
19172 "filename": "lib/ec2/ec2-task-definition.ts",
19173 "line": 45
19174 },
19175 "name": "ipcMode",
19176 "optional": true,
19177 "type": {
19178 "fqn": "@aws-cdk/aws-ecs.IpcMode"
19179 }
19180 },
19181 {
19182 "abstract": true,
19183 "docs": {
19184 "default": "- NetworkMode.BRIDGE for EC2 tasks, AWS_VPC for Fargate tasks.",
19185 "remarks": "The valid values are NONE, BRIDGE, AWS_VPC, and HOST.",
19186 "stability": "stable",
19187 "summary": "The Docker networking mode to use for the containers in the task."
19188 },
19189 "immutable": true,
19190 "locationInModule": {
19191 "filename": "lib/ec2/ec2-task-definition.ts",
19192 "line": 27
19193 },
19194 "name": "networkMode",
19195 "optional": true,
19196 "type": {
19197 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
19198 }
19199 },
19200 {
19201 "abstract": true,
19202 "docs": {
19203 "default": "- PidMode used by the task is not specified",
19204 "remarks": "Not supported in Fargate and Windows containers.",
19205 "stability": "stable",
19206 "summary": "The process namespace to use for the containers in the task."
19207 },
19208 "immutable": true,
19209 "locationInModule": {
19210 "filename": "lib/ec2/ec2-task-definition.ts",
19211 "line": 54
19212 },
19213 "name": "pidMode",
19214 "optional": true,
19215 "type": {
19216 "fqn": "@aws-cdk/aws-ecs.PidMode"
19217 }
19218 },
19219 {
19220 "abstract": true,
19221 "docs": {
19222 "default": "- No placement constraints.",
19223 "remarks": "You can\nspecify a maximum of 10 constraints per task (this limit includes\nconstraints in the task definition and those specified at run time).",
19224 "stability": "stable",
19225 "summary": "An array of placement constraint objects to use for the task."
19226 },
19227 "immutable": true,
19228 "locationInModule": {
19229 "filename": "lib/ec2/ec2-task-definition.ts",
19230 "line": 36
19231 },
19232 "name": "placementConstraints",
19233 "optional": true,
19234 "type": {
19235 "collection": {
19236 "elementtype": {
19237 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
19238 },
19239 "kind": "array"
19240 }
19241 }
19242 }
19243 ],
19244 "symbolId": "lib/ec2/ec2-task-definition:Ec2TaskDefinitionProps"
19245 },
19246 "@aws-cdk/aws-ecs.EcrImage": {
19247 "assembly": "@aws-cdk/aws-ecs",
19248 "base": "@aws-cdk/aws-ecs.ContainerImage",
19249 "docs": {
19250 "custom": {
19251 "exampleMetadata": "infused"
19252 },
19253 "example": "import * as ecr from '@aws-cdk/aws-ecr';\n\nconst repo = ecr.Repository.fromRepositoryName(this, 'batch-job-repo', 'todo-list');\n\nnew batch.JobDefinition(this, 'batch-job-def-from-ecr', {\n container: {\n image: new ecs.EcrImage(repo, 'latest'),\n },\n});",
19254 "stability": "stable",
19255 "summary": "An image from an Amazon ECR repository."
19256 },
19257 "fqn": "@aws-cdk/aws-ecs.EcrImage",
19258 "initializer": {
19259 "docs": {
19260 "stability": "stable",
19261 "summary": "Constructs a new instance of the EcrImage class."
19262 },
19263 "locationInModule": {
19264 "filename": "lib/images/ecr.ts",
19265 "line": 25
19266 },
19267 "parameters": [
19268 {
19269 "name": "repository",
19270 "type": {
19271 "fqn": "@aws-cdk/aws-ecr.IRepository"
19272 }
19273 },
19274 {
19275 "name": "tagOrDigest",
19276 "type": {
19277 "primitive": "string"
19278 }
19279 }
19280 ]
19281 },
19282 "kind": "class",
19283 "locationInModule": {
19284 "filename": "lib/images/ecr.ts",
19285 "line": 12
19286 },
19287 "methods": [
19288 {
19289 "docs": {
19290 "stability": "stable",
19291 "summary": "Called when the image is used by a ContainerDefinition."
19292 },
19293 "locationInModule": {
19294 "filename": "lib/images/ecr.ts",
19295 "line": 31
19296 },
19297 "name": "bind",
19298 "overrides": "@aws-cdk/aws-ecs.ContainerImage",
19299 "parameters": [
19300 {
19301 "name": "_scope",
19302 "type": {
19303 "fqn": "@aws-cdk/core.Construct"
19304 }
19305 },
19306 {
19307 "name": "containerDefinition",
19308 "type": {
19309 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
19310 }
19311 }
19312 ],
19313 "returns": {
19314 "type": {
19315 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig"
19316 }
19317 }
19318 }
19319 ],
19320 "name": "EcrImage",
19321 "properties": [
19322 {
19323 "docs": {
19324 "remarks": "For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or\n012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.",
19325 "stability": "stable",
19326 "summary": "The image name. Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest."
19327 },
19328 "immutable": true,
19329 "locationInModule": {
19330 "filename": "lib/images/ecr.ts",
19331 "line": 20
19332 },
19333 "name": "imageName",
19334 "type": {
19335 "primitive": "string"
19336 }
19337 }
19338 ],
19339 "symbolId": "lib/images/ecr:EcrImage"
19340 },
19341 "@aws-cdk/aws-ecs.EcsOptimizedAmi": {
19342 "assembly": "@aws-cdk/aws-ecs",
19343 "docs": {
19344 "custom": {
19345 "exampleMetadata": "infused"
19346 },
19347 "deprecated": "see {@link EcsOptimizedImage#amazonLinux}, {@link EcsOptimizedImage#amazonLinux} and {@link EcsOptimizedImage#windows}",
19348 "example": "declare const vpc: ec2.Vpc;\nconst myComputeEnv = new batch.ComputeEnvironment(this, 'ComputeEnv', {\n computeResources: {\n image: new ecs.EcsOptimizedAmi({\n generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2,\n }),\n vpc,\n }\n});",
19349 "stability": "deprecated",
19350 "summary": "Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM."
19351 },
19352 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedAmi",
19353 "initializer": {
19354 "docs": {
19355 "stability": "deprecated",
19356 "summary": "Constructs a new instance of the EcsOptimizedAmi class."
19357 },
19358 "locationInModule": {
19359 "filename": "lib/amis.ts",
19360 "line": 112
19361 },
19362 "parameters": [
19363 {
19364 "name": "props",
19365 "optional": true,
19366 "type": {
19367 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedAmiProps"
19368 }
19369 }
19370 ]
19371 },
19372 "interfaces": [
19373 "@aws-cdk/aws-ec2.IMachineImage"
19374 ],
19375 "kind": "class",
19376 "locationInModule": {
19377 "filename": "lib/amis.ts",
19378 "line": 101
19379 },
19380 "methods": [
19381 {
19382 "docs": {
19383 "stability": "deprecated",
19384 "summary": "Return the correct image."
19385 },
19386 "locationInModule": {
19387 "filename": "lib/amis.ts",
19388 "line": 148
19389 },
19390 "name": "getImage",
19391 "overrides": "@aws-cdk/aws-ec2.IMachineImage",
19392 "parameters": [
19393 {
19394 "name": "scope",
19395 "type": {
19396 "fqn": "@aws-cdk/core.Construct"
19397 }
19398 }
19399 ],
19400 "returns": {
19401 "type": {
19402 "fqn": "@aws-cdk/aws-ec2.MachineImageConfig"
19403 }
19404 }
19405 }
19406 ],
19407 "name": "EcsOptimizedAmi",
19408 "symbolId": "lib/amis:EcsOptimizedAmi"
19409 },
19410 "@aws-cdk/aws-ecs.EcsOptimizedAmiProps": {
19411 "assembly": "@aws-cdk/aws-ecs",
19412 "datatype": true,
19413 "docs": {
19414 "custom": {
19415 "exampleMetadata": "infused"
19416 },
19417 "deprecated": "see {@link EcsOptimizedImage}",
19418 "example": "declare const vpc: ec2.Vpc;\nconst myComputeEnv = new batch.ComputeEnvironment(this, 'ComputeEnv', {\n computeResources: {\n image: new ecs.EcsOptimizedAmi({\n generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2,\n }),\n vpc,\n }\n});",
19419 "stability": "deprecated",
19420 "summary": "The properties that define which ECS-optimized AMI is used."
19421 },
19422 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedAmiProps",
19423 "kind": "interface",
19424 "locationInModule": {
19425 "filename": "lib/amis.ts",
19426 "line": 49
19427 },
19428 "name": "EcsOptimizedAmiProps",
19429 "properties": [
19430 {
19431 "abstract": true,
19432 "docs": {
19433 "default": "false",
19434 "remarks": "By default, the newest image is used on each deployment. This will cause\ninstances to be replaced whenever a new version is released, and may cause\ndowntime if there aren't enough running instances in the AutoScalingGroup\nto reschedule the tasks on.\n\nIf set to true, the AMI ID will be cached in `cdk.context.json` and the\nsame value will be used on future runs. Your instances will not be replaced\nbut your AMI version will grow old over time. To refresh the AMI lookup,\nyou will have to evict the value from the cache using the `cdk context`\ncommand. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for\nmore information.\n\nCan not be set to `true` in environment-agnostic stacks.",
19435 "stability": "deprecated",
19436 "summary": "Whether the AMI ID is cached to be stable between deployments."
19437 },
19438 "immutable": true,
19439 "locationInModule": {
19440 "filename": "lib/amis.ts",
19441 "line": 90
19442 },
19443 "name": "cachedInContext",
19444 "optional": true,
19445 "type": {
19446 "primitive": "boolean"
19447 }
19448 },
19449 {
19450 "abstract": true,
19451 "docs": {
19452 "default": "AmazonLinuxGeneration.AmazonLinux2",
19453 "stability": "deprecated",
19454 "summary": "The Amazon Linux generation to use."
19455 },
19456 "immutable": true,
19457 "locationInModule": {
19458 "filename": "lib/amis.ts",
19459 "line": 55
19460 },
19461 "name": "generation",
19462 "optional": true,
19463 "type": {
19464 "fqn": "@aws-cdk/aws-ec2.AmazonLinuxGeneration"
19465 }
19466 },
19467 {
19468 "abstract": true,
19469 "docs": {
19470 "default": "AmiHardwareType.Standard",
19471 "stability": "deprecated",
19472 "summary": "The ECS-optimized AMI variant to use."
19473 },
19474 "immutable": true,
19475 "locationInModule": {
19476 "filename": "lib/amis.ts",
19477 "line": 69
19478 },
19479 "name": "hardwareType",
19480 "optional": true,
19481 "type": {
19482 "fqn": "@aws-cdk/aws-ecs.AmiHardwareType"
19483 }
19484 },
19485 {
19486 "abstract": true,
19487 "docs": {
19488 "default": "none, uses Linux generation",
19489 "stability": "deprecated",
19490 "summary": "The Windows Server version to use."
19491 },
19492 "immutable": true,
19493 "locationInModule": {
19494 "filename": "lib/amis.ts",
19495 "line": 62
19496 },
19497 "name": "windowsVersion",
19498 "optional": true,
19499 "type": {
19500 "fqn": "@aws-cdk/aws-ecs.WindowsOptimizedVersion"
19501 }
19502 }
19503 ],
19504 "symbolId": "lib/amis:EcsOptimizedAmiProps"
19505 },
19506 "@aws-cdk/aws-ecs.EcsOptimizedImage": {
19507 "assembly": "@aws-cdk/aws-ecs",
19508 "docs": {
19509 "custom": {
19510 "exampleMetadata": "infused"
19511 },
19512 "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n});\n\n// Either add default capacity\ncluster.addCapacity('DefaultAutoScalingGroupCapacity', {\n instanceType: new ec2.InstanceType(\"t2.xlarge\"),\n desiredCapacity: 3,\n});\n\n// Or add customized capacity. Be sure to start the Amazon ECS-optimized AMI.\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n vpc,\n instanceType: new ec2.InstanceType('t2.xlarge'),\n machineImage: ecs.EcsOptimizedImage.amazonLinux(),\n // Or use Amazon ECS-Optimized Amazon Linux 2 AMI\n // machineImage: EcsOptimizedImage.amazonLinux2(),\n desiredCapacity: 3,\n // ... other options here ...\n});\n\ncluster.addAutoScalingGroup(autoScalingGroup);",
19513 "stability": "stable",
19514 "summary": "Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM."
19515 },
19516 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImage",
19517 "interfaces": [
19518 "@aws-cdk/aws-ec2.IMachineImage"
19519 ],
19520 "kind": "class",
19521 "locationInModule": {
19522 "filename": "lib/amis.ts",
19523 "line": 189
19524 },
19525 "methods": [
19526 {
19527 "docs": {
19528 "stability": "stable",
19529 "summary": "Construct an Amazon Linux AMI image from the latest ECS Optimized AMI published in SSM."
19530 },
19531 "locationInModule": {
19532 "filename": "lib/amis.ts",
19533 "line": 206
19534 },
19535 "name": "amazonLinux",
19536 "parameters": [
19537 {
19538 "name": "options",
19539 "optional": true,
19540 "type": {
19541 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImageOptions"
19542 }
19543 }
19544 ],
19545 "returns": {
19546 "type": {
19547 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImage"
19548 }
19549 },
19550 "static": true
19551 },
19552 {
19553 "docs": {
19554 "stability": "stable",
19555 "summary": "Construct an Amazon Linux 2 image from the latest ECS Optimized AMI published in SSM."
19556 },
19557 "locationInModule": {
19558 "filename": "lib/amis.ts",
19559 "line": 195
19560 },
19561 "name": "amazonLinux2",
19562 "parameters": [
19563 {
19564 "docs": {
19565 "summary": "ECS-optimized AMI variant to use."
19566 },
19567 "name": "hardwareType",
19568 "optional": true,
19569 "type": {
19570 "fqn": "@aws-cdk/aws-ecs.AmiHardwareType"
19571 }
19572 },
19573 {
19574 "name": "options",
19575 "optional": true,
19576 "type": {
19577 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImageOptions"
19578 }
19579 }
19580 ],
19581 "returns": {
19582 "type": {
19583 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImage"
19584 }
19585 },
19586 "static": true
19587 },
19588 {
19589 "docs": {
19590 "stability": "stable",
19591 "summary": "Construct a Windows image from the latest ECS Optimized AMI published in SSM."
19592 },
19593 "locationInModule": {
19594 "filename": "lib/amis.ts",
19595 "line": 218
19596 },
19597 "name": "windows",
19598 "parameters": [
19599 {
19600 "docs": {
19601 "summary": "Windows Version to use."
19602 },
19603 "name": "windowsVersion",
19604 "type": {
19605 "fqn": "@aws-cdk/aws-ecs.WindowsOptimizedVersion"
19606 }
19607 },
19608 {
19609 "name": "options",
19610 "optional": true,
19611 "type": {
19612 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImageOptions"
19613 }
19614 }
19615 ],
19616 "returns": {
19617 "type": {
19618 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImage"
19619 }
19620 },
19621 "static": true
19622 },
19623 {
19624 "docs": {
19625 "stability": "stable",
19626 "summary": "Return the correct image."
19627 },
19628 "locationInModule": {
19629 "filename": "lib/amis.ts",
19630 "line": 261
19631 },
19632 "name": "getImage",
19633 "overrides": "@aws-cdk/aws-ec2.IMachineImage",
19634 "parameters": [
19635 {
19636 "name": "scope",
19637 "type": {
19638 "fqn": "@aws-cdk/core.Construct"
19639 }
19640 }
19641 ],
19642 "returns": {
19643 "type": {
19644 "fqn": "@aws-cdk/aws-ec2.MachineImageConfig"
19645 }
19646 }
19647 }
19648 ],
19649 "name": "EcsOptimizedImage",
19650 "symbolId": "lib/amis:EcsOptimizedImage"
19651 },
19652 "@aws-cdk/aws-ecs.EcsOptimizedImageOptions": {
19653 "assembly": "@aws-cdk/aws-ecs",
19654 "datatype": true,
19655 "docs": {
19656 "custom": {
19657 "exampleMetadata": "infused"
19658 },
19659 "example": "declare const vpc: ec2.Vpc;\nconst autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {\n machineImage: ecs.EcsOptimizedImage.amazonLinux({ cachedInContext: true }),\n vpc,\n instanceType: new ec2.InstanceType('t2.micro'),\n});",
19660 "stability": "stable",
19661 "summary": "Additional configuration properties for EcsOptimizedImage factory functions."
19662 },
19663 "fqn": "@aws-cdk/aws-ecs.EcsOptimizedImageOptions",
19664 "kind": "interface",
19665 "locationInModule": {
19666 "filename": "lib/amis.ts",
19667 "line": 163
19668 },
19669 "name": "EcsOptimizedImageOptions",
19670 "properties": [
19671 {
19672 "abstract": true,
19673 "docs": {
19674 "default": "false",
19675 "remarks": "By default, the newest image is used on each deployment. This will cause\ninstances to be replaced whenever a new version is released, and may cause\ndowntime if there aren't enough running instances in the AutoScalingGroup\nto reschedule the tasks on.\n\nIf set to true, the AMI ID will be cached in `cdk.context.json` and the\nsame value will be used on future runs. Your instances will not be replaced\nbut your AMI version will grow old over time. To refresh the AMI lookup,\nyou will have to evict the value from the cache using the `cdk context`\ncommand. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for\nmore information.\n\nCan not be set to `true` in environment-agnostic stacks.",
19676 "stability": "stable",
19677 "summary": "Whether the AMI ID is cached to be stable between deployments."
19678 },
19679 "immutable": true,
19680 "locationInModule": {
19681 "filename": "lib/amis.ts",
19682 "line": 183
19683 },
19684 "name": "cachedInContext",
19685 "optional": true,
19686 "type": {
19687 "primitive": "boolean"
19688 }
19689 }
19690 ],
19691 "symbolId": "lib/amis:EcsOptimizedImageOptions"
19692 },
19693 "@aws-cdk/aws-ecs.EcsTarget": {
19694 "assembly": "@aws-cdk/aws-ecs",
19695 "datatype": true,
19696 "docs": {
19697 "custom": {
19698 "exampleMetadata": "infused"
19699 },
19700 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);",
19701 "stability": "stable"
19702 },
19703 "fqn": "@aws-cdk/aws-ecs.EcsTarget",
19704 "kind": "interface",
19705 "locationInModule": {
19706 "filename": "lib/base/base-service.ts",
19707 "line": 59
19708 },
19709 "name": "EcsTarget",
19710 "properties": [
19711 {
19712 "abstract": true,
19713 "docs": {
19714 "stability": "stable",
19715 "summary": "The name of the container."
19716 },
19717 "immutable": true,
19718 "locationInModule": {
19719 "filename": "lib/base/base-service.ts",
19720 "line": 63
19721 },
19722 "name": "containerName",
19723 "type": {
19724 "primitive": "string"
19725 }
19726 },
19727 {
19728 "abstract": true,
19729 "docs": {
19730 "stability": "stable",
19731 "summary": "Listener and properties for adding target group to the listener."
19732 },
19733 "immutable": true,
19734 "locationInModule": {
19735 "filename": "lib/base/base-service.ts",
19736 "line": 87
19737 },
19738 "name": "listener",
19739 "type": {
19740 "fqn": "@aws-cdk/aws-ecs.ListenerConfig"
19741 }
19742 },
19743 {
19744 "abstract": true,
19745 "docs": {
19746 "stability": "stable",
19747 "summary": "ID for a target group to be created."
19748 },
19749 "immutable": true,
19750 "locationInModule": {
19751 "filename": "lib/base/base-service.ts",
19752 "line": 82
19753 },
19754 "name": "newTargetGroupId",
19755 "type": {
19756 "primitive": "string"
19757 }
19758 },
19759 {
19760 "abstract": true,
19761 "docs": {
19762 "default": "- Container port of the first added port mapping.",
19763 "remarks": "Only applicable when using application/network load balancers.",
19764 "stability": "stable",
19765 "summary": "The port number of the container."
19766 },
19767 "immutable": true,
19768 "locationInModule": {
19769 "filename": "lib/base/base-service.ts",
19770 "line": 70
19771 },
19772 "name": "containerPort",
19773 "optional": true,
19774 "type": {
19775 "primitive": "number"
19776 }
19777 },
19778 {
19779 "abstract": true,
19780 "docs": {
19781 "default": "Protocol.TCP",
19782 "remarks": "Only applicable when using application load balancers.",
19783 "stability": "stable",
19784 "summary": "The protocol used for the port mapping."
19785 },
19786 "immutable": true,
19787 "locationInModule": {
19788 "filename": "lib/base/base-service.ts",
19789 "line": 77
19790 },
19791 "name": "protocol",
19792 "optional": true,
19793 "type": {
19794 "fqn": "@aws-cdk/aws-ecs.Protocol"
19795 }
19796 }
19797 ],
19798 "symbolId": "lib/base/base-service:EcsTarget"
19799 },
19800 "@aws-cdk/aws-ecs.EfsVolumeConfiguration": {
19801 "assembly": "@aws-cdk/aws-ecs",
19802 "datatype": true,
19803 "docs": {
19804 "stability": "stable",
19805 "summary": "The configuration for an Elastic FileSystem volume.",
19806 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst efsVolumeConfiguration: ecs.EfsVolumeConfiguration = {\n fileSystemId: 'fileSystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n};",
19807 "custom": {
19808 "exampleMetadata": "fixture=_generated"
19809 }
19810 },
19811 "fqn": "@aws-cdk/aws-ecs.EfsVolumeConfiguration",
19812 "kind": "interface",
19813 "locationInModule": {
19814 "filename": "lib/base/task-definition.ts",
19815 "line": 1013
19816 },
19817 "name": "EfsVolumeConfiguration",
19818 "properties": [
19819 {
19820 "abstract": true,
19821 "docs": {
19822 "stability": "stable",
19823 "summary": "The Amazon EFS file system ID to use."
19824 },
19825 "immutable": true,
19826 "locationInModule": {
19827 "filename": "lib/base/task-definition.ts",
19828 "line": 1017
19829 },
19830 "name": "fileSystemId",
19831 "type": {
19832 "primitive": "string"
19833 }
19834 },
19835 {
19836 "abstract": true,
19837 "docs": {
19838 "default": "No configuration.",
19839 "stability": "stable",
19840 "summary": "The authorization configuration details for the Amazon EFS file system."
19841 },
19842 "immutable": true,
19843 "locationInModule": {
19844 "filename": "lib/base/task-definition.ts",
19845 "line": 1047
19846 },
19847 "name": "authorizationConfig",
19848 "optional": true,
19849 "type": {
19850 "fqn": "@aws-cdk/aws-ecs.AuthorizationConfig"
19851 }
19852 },
19853 {
19854 "abstract": true,
19855 "docs": {
19856 "default": "The root of the Amazon EFS volume",
19857 "remarks": "Specifying / will have the same effect as omitting this parameter.",
19858 "stability": "stable",
19859 "summary": "The directory within the Amazon EFS file system to mount as the root directory inside the host."
19860 },
19861 "immutable": true,
19862 "locationInModule": {
19863 "filename": "lib/base/task-definition.ts",
19864 "line": 1024
19865 },
19866 "name": "rootDirectory",
19867 "optional": true,
19868 "type": {
19869 "primitive": "string"
19870 }
19871 },
19872 {
19873 "abstract": true,
19874 "docs": {
19875 "default": "DISABLED",
19876 "remarks": "Transit encryption must be enabled if Amazon EFS IAM authorization is used.\n\nValid values: ENABLED | DISABLED",
19877 "stability": "stable",
19878 "summary": "Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server."
19879 },
19880 "immutable": true,
19881 "locationInModule": {
19882 "filename": "lib/base/task-definition.ts",
19883 "line": 1034
19884 },
19885 "name": "transitEncryption",
19886 "optional": true,
19887 "type": {
19888 "primitive": "string"
19889 }
19890 },
19891 {
19892 "abstract": true,
19893 "docs": {
19894 "default": "Port selection strategy that the Amazon EFS mount helper uses.",
19895 "remarks": "EFS mount helper uses.",
19896 "stability": "stable",
19897 "summary": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server."
19898 },
19899 "immutable": true,
19900 "locationInModule": {
19901 "filename": "lib/base/task-definition.ts",
19902 "line": 1041
19903 },
19904 "name": "transitEncryptionPort",
19905 "optional": true,
19906 "type": {
19907 "primitive": "number"
19908 }
19909 }
19910 ],
19911 "symbolId": "lib/base/task-definition:EfsVolumeConfiguration"
19912 },
19913 "@aws-cdk/aws-ecs.EnvironmentFile": {
19914 "abstract": true,
19915 "assembly": "@aws-cdk/aws-ecs",
19916 "docs": {
19917 "custom": {
19918 "exampleMetadata": "infused"
19919 },
19920 "example": "declare const secret: secretsmanager.Secret;\ndeclare const dbSecret: secretsmanager.Secret;\ndeclare const parameter: ssm.StringParameter;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const s3Bucket: s3.Bucket;\n\nconst newContainer = taskDefinition.addContainer('container', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n environment: { // clear text, not for sensitive data\n STAGE: 'prod',\n },\n environmentFiles: [ // list of environment files hosted either on local disk or S3\n ecs.EnvironmentFile.fromAsset('./demo-env-file.env'),\n ecs.EnvironmentFile.fromBucket(s3Bucket, 'assets/demo-env-file.env'),\n ],\n secrets: { // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store at container start-up.\n SECRET: ecs.Secret.fromSecretsManager(secret),\n DB_PASSWORD: ecs.Secret.fromSecretsManager(dbSecret, 'password'), // Reference a specific JSON field, (requires platform version 1.4.0 or later for Fargate tasks)\n API_KEY: ecs.Secret.fromSecretsManagerVersion(secret, { versionId: '12345' }, 'apiKey'), // Reference a specific version of the secret by its version id or version stage (requires platform version 1.4.0 or later for Fargate tasks)\n PARAMETER: ecs.Secret.fromSsmParameter(parameter),\n },\n});\nnewContainer.addEnvironment('QUEUE_NAME', 'MyQueue');",
19921 "stability": "stable",
19922 "summary": "Constructs for types of environment files."
19923 },
19924 "fqn": "@aws-cdk/aws-ecs.EnvironmentFile",
19925 "initializer": {
19926 "docs": {
19927 "stability": "stable"
19928 }
19929 },
19930 "kind": "class",
19931 "locationInModule": {
19932 "filename": "lib/environment-file.ts",
19933 "line": 8
19934 },
19935 "methods": [
19936 {
19937 "docs": {
19938 "stability": "stable",
19939 "summary": "Loads the environment file from a local disk path."
19940 },
19941 "locationInModule": {
19942 "filename": "lib/environment-file.ts",
19943 "line": 15
19944 },
19945 "name": "fromAsset",
19946 "parameters": [
19947 {
19948 "docs": {
19949 "summary": "Local disk path."
19950 },
19951 "name": "path",
19952 "type": {
19953 "primitive": "string"
19954 }
19955 },
19956 {
19957 "name": "options",
19958 "optional": true,
19959 "type": {
19960 "fqn": "@aws-cdk/aws-s3-assets.AssetOptions"
19961 }
19962 }
19963 ],
19964 "returns": {
19965 "type": {
19966 "fqn": "@aws-cdk/aws-ecs.AssetEnvironmentFile"
19967 }
19968 },
19969 "static": true
19970 },
19971 {
19972 "docs": {
19973 "returns": "`S3EnvironmentFile` associated with the specified S3 object.",
19974 "stability": "stable",
19975 "summary": "Loads the environment file from an S3 bucket."
19976 },
19977 "locationInModule": {
19978 "filename": "lib/environment-file.ts",
19979 "line": 27
19980 },
19981 "name": "fromBucket",
19982 "parameters": [
19983 {
19984 "docs": {
19985 "summary": "The S3 bucket."
19986 },
19987 "name": "bucket",
19988 "type": {
19989 "fqn": "@aws-cdk/aws-s3.IBucket"
19990 }
19991 },
19992 {
19993 "docs": {
19994 "summary": "The object key."
19995 },
19996 "name": "key",
19997 "type": {
19998 "primitive": "string"
19999 }
20000 },
20001 {
20002 "docs": {
20003 "summary": "Optional S3 object version."
20004 },
20005 "name": "objectVersion",
20006 "optional": true,
20007 "type": {
20008 "primitive": "string"
20009 }
20010 }
20011 ],
20012 "returns": {
20013 "type": {
20014 "fqn": "@aws-cdk/aws-ecs.S3EnvironmentFile"
20015 }
20016 },
20017 "static": true
20018 },
20019 {
20020 "abstract": true,
20021 "docs": {
20022 "stability": "stable",
20023 "summary": "Called when the container is initialized to allow this object to bind to the stack."
20024 },
20025 "locationInModule": {
20026 "filename": "lib/environment-file.ts",
20027 "line": 37
20028 },
20029 "name": "bind",
20030 "parameters": [
20031 {
20032 "docs": {
20033 "summary": "The binding scope."
20034 },
20035 "name": "scope",
20036 "type": {
20037 "fqn": "@aws-cdk/core.Construct"
20038 }
20039 }
20040 ],
20041 "returns": {
20042 "type": {
20043 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileConfig"
20044 }
20045 }
20046 }
20047 ],
20048 "name": "EnvironmentFile",
20049 "symbolId": "lib/environment-file:EnvironmentFile"
20050 },
20051 "@aws-cdk/aws-ecs.EnvironmentFileConfig": {
20052 "assembly": "@aws-cdk/aws-ecs",
20053 "datatype": true,
20054 "docs": {
20055 "stability": "stable",
20056 "summary": "Configuration for the environment file.",
20057 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst environmentFileConfig: ecs.EnvironmentFileConfig = {\n fileType: ecs.EnvironmentFileType.S3,\n s3Location: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n objectVersion: 'objectVersion',\n },\n};",
20058 "custom": {
20059 "exampleMetadata": "fixture=_generated"
20060 }
20061 },
20062 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileConfig",
20063 "kind": "interface",
20064 "locationInModule": {
20065 "filename": "lib/environment-file.ts",
20066 "line": 108
20067 },
20068 "name": "EnvironmentFileConfig",
20069 "properties": [
20070 {
20071 "abstract": true,
20072 "docs": {
20073 "stability": "stable",
20074 "summary": "The type of environment file."
20075 },
20076 "immutable": true,
20077 "locationInModule": {
20078 "filename": "lib/environment-file.ts",
20079 "line": 112
20080 },
20081 "name": "fileType",
20082 "type": {
20083 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileType"
20084 }
20085 },
20086 {
20087 "abstract": true,
20088 "docs": {
20089 "stability": "stable",
20090 "summary": "The location of the environment file in S3."
20091 },
20092 "immutable": true,
20093 "locationInModule": {
20094 "filename": "lib/environment-file.ts",
20095 "line": 117
20096 },
20097 "name": "s3Location",
20098 "type": {
20099 "fqn": "@aws-cdk/aws-s3.Location"
20100 }
20101 }
20102 ],
20103 "symbolId": "lib/environment-file:EnvironmentFileConfig"
20104 },
20105 "@aws-cdk/aws-ecs.EnvironmentFileType": {
20106 "assembly": "@aws-cdk/aws-ecs",
20107 "docs": {
20108 "stability": "stable",
20109 "summary": "Type of environment file to be included in the container definition."
20110 },
20111 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileType",
20112 "kind": "enum",
20113 "locationInModule": {
20114 "filename": "lib/environment-file.ts",
20115 "line": 123
20116 },
20117 "members": [
20118 {
20119 "docs": {
20120 "stability": "stable",
20121 "summary": "Environment file hosted on S3, referenced by object ARN."
20122 },
20123 "name": "S3"
20124 }
20125 ],
20126 "name": "EnvironmentFileType",
20127 "symbolId": "lib/environment-file:EnvironmentFileType"
20128 },
20129 "@aws-cdk/aws-ecs.ExecuteCommandConfiguration": {
20130 "assembly": "@aws-cdk/aws-ecs",
20131 "datatype": true,
20132 "docs": {
20133 "custom": {
20134 "exampleMetadata": "infused"
20135 },
20136 "example": "declare const vpc: ec2.Vpc;\nconst kmsKey = new kms.Key(this, 'KmsKey');\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the log group\nconst logGroup = new logs.LogGroup(this, 'LogGroup', {\n encryptionKey: kmsKey,\n});\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket\nconst execBucket = new s3.Bucket(this, 'EcsExecBucket', {\n encryptionKey: kmsKey,\n});\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n executeCommandConfiguration: {\n kmsKey,\n logConfiguration: {\n cloudWatchLogGroup: logGroup,\n cloudWatchEncryptionEnabled: true,\n s3Bucket: execBucket,\n s3EncryptionEnabled: true,\n s3KeyPrefix: 'exec-command-output',\n },\n logging: ecs.ExecuteCommandLogging.OVERRIDE,\n },\n});",
20137 "remarks": "For more information, see\n[ExecuteCommandConfiguration] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html",
20138 "stability": "stable",
20139 "summary": "The details of the execute command configuration."
20140 },
20141 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandConfiguration",
20142 "kind": "interface",
20143 "locationInModule": {
20144 "filename": "lib/cluster.ts",
20145 "line": 945
20146 },
20147 "name": "ExecuteCommandConfiguration",
20148 "properties": [
20149 {
20150 "abstract": true,
20151 "docs": {
20152 "default": "- none",
20153 "stability": "stable",
20154 "summary": "The AWS Key Management Service key ID to encrypt the data between the local client and the container."
20155 },
20156 "immutable": true,
20157 "locationInModule": {
20158 "filename": "lib/cluster.ts",
20159 "line": 951
20160 },
20161 "name": "kmsKey",
20162 "optional": true,
20163 "type": {
20164 "fqn": "@aws-cdk/aws-kms.IKey"
20165 }
20166 },
20167 {
20168 "abstract": true,
20169 "docs": {
20170 "default": "- none",
20171 "remarks": "The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.",
20172 "stability": "stable",
20173 "summary": "The log configuration for the results of the execute command actions."
20174 },
20175 "immutable": true,
20176 "locationInModule": {
20177 "filename": "lib/cluster.ts",
20178 "line": 958
20179 },
20180 "name": "logConfiguration",
20181 "optional": true,
20182 "type": {
20183 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandLogConfiguration"
20184 }
20185 },
20186 {
20187 "abstract": true,
20188 "docs": {
20189 "default": "- none",
20190 "stability": "stable",
20191 "summary": "The log settings to use for logging the execute command session."
20192 },
20193 "immutable": true,
20194 "locationInModule": {
20195 "filename": "lib/cluster.ts",
20196 "line": 965
20197 },
20198 "name": "logging",
20199 "optional": true,
20200 "type": {
20201 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandLogging"
20202 }
20203 }
20204 ],
20205 "symbolId": "lib/cluster:ExecuteCommandConfiguration"
20206 },
20207 "@aws-cdk/aws-ecs.ExecuteCommandLogConfiguration": {
20208 "assembly": "@aws-cdk/aws-ecs",
20209 "datatype": true,
20210 "docs": {
20211 "custom": {
20212 "exampleMetadata": "infused"
20213 },
20214 "example": "declare const vpc: ec2.Vpc;\nconst kmsKey = new kms.Key(this, 'KmsKey');\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the log group\nconst logGroup = new logs.LogGroup(this, 'LogGroup', {\n encryptionKey: kmsKey,\n});\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket\nconst execBucket = new s3.Bucket(this, 'EcsExecBucket', {\n encryptionKey: kmsKey,\n});\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n executeCommandConfiguration: {\n kmsKey,\n logConfiguration: {\n cloudWatchLogGroup: logGroup,\n cloudWatchEncryptionEnabled: true,\n s3Bucket: execBucket,\n s3EncryptionEnabled: true,\n s3KeyPrefix: 'exec-command-output',\n },\n logging: ecs.ExecuteCommandLogging.OVERRIDE,\n },\n});",
20215 "remarks": "The logs can be sent to CloudWatch Logs and/ or an Amazon S3 bucket.\nFor more information, see [ExecuteCommandLogConfiguration] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html",
20216 "stability": "stable",
20217 "summary": "The log configuration for the results of the execute command actions."
20218 },
20219 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandLogConfiguration",
20220 "kind": "interface",
20221 "locationInModule": {
20222 "filename": "lib/cluster.ts",
20223 "line": 993
20224 },
20225 "name": "ExecuteCommandLogConfiguration",
20226 "properties": [
20227 {
20228 "abstract": true,
20229 "docs": {
20230 "default": "- encryption will be disabled.",
20231 "stability": "stable",
20232 "summary": "Whether or not to enable encryption on the CloudWatch logs."
20233 },
20234 "immutable": true,
20235 "locationInModule": {
20236 "filename": "lib/cluster.ts",
20237 "line": 999
20238 },
20239 "name": "cloudWatchEncryptionEnabled",
20240 "optional": true,
20241 "type": {
20242 "primitive": "boolean"
20243 }
20244 },
20245 {
20246 "abstract": true,
20247 "docs": {
20248 "default": "- none",
20249 "remarks": "The CloudWatch log group must already be created.",
20250 "stability": "stable",
20251 "summary": "The name of the CloudWatch log group to send logs to."
20252 },
20253 "immutable": true,
20254 "locationInModule": {
20255 "filename": "lib/cluster.ts",
20256 "line": 1005
20257 },
20258 "name": "cloudWatchLogGroup",
20259 "optional": true,
20260 "type": {
20261 "fqn": "@aws-cdk/aws-logs.ILogGroup"
20262 }
20263 },
20264 {
20265 "abstract": true,
20266 "docs": {
20267 "default": "- none",
20268 "remarks": "The S3 bucket must already be created.",
20269 "stability": "stable",
20270 "summary": "The name of the S3 bucket to send logs to."
20271 },
20272 "immutable": true,
20273 "locationInModule": {
20274 "filename": "lib/cluster.ts",
20275 "line": 1012
20276 },
20277 "name": "s3Bucket",
20278 "optional": true,
20279 "type": {
20280 "fqn": "@aws-cdk/aws-s3.IBucket"
20281 }
20282 },
20283 {
20284 "abstract": true,
20285 "docs": {
20286 "default": "- encryption will be disabled.",
20287 "stability": "stable",
20288 "summary": "Whether or not to enable encryption on the CloudWatch logs."
20289 },
20290 "immutable": true,
20291 "locationInModule": {
20292 "filename": "lib/cluster.ts",
20293 "line": 1019
20294 },
20295 "name": "s3EncryptionEnabled",
20296 "optional": true,
20297 "type": {
20298 "primitive": "boolean"
20299 }
20300 },
20301 {
20302 "abstract": true,
20303 "docs": {
20304 "default": "- none",
20305 "stability": "stable",
20306 "summary": "An optional folder in the S3 bucket to place logs in."
20307 },
20308 "immutable": true,
20309 "locationInModule": {
20310 "filename": "lib/cluster.ts",
20311 "line": 1026
20312 },
20313 "name": "s3KeyPrefix",
20314 "optional": true,
20315 "type": {
20316 "primitive": "string"
20317 }
20318 }
20319 ],
20320 "symbolId": "lib/cluster:ExecuteCommandLogConfiguration"
20321 },
20322 "@aws-cdk/aws-ecs.ExecuteCommandLogging": {
20323 "assembly": "@aws-cdk/aws-ecs",
20324 "docs": {
20325 "custom": {
20326 "exampleMetadata": "infused"
20327 },
20328 "example": "declare const vpc: ec2.Vpc;\nconst kmsKey = new kms.Key(this, 'KmsKey');\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the log group\nconst logGroup = new logs.LogGroup(this, 'LogGroup', {\n encryptionKey: kmsKey,\n});\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket\nconst execBucket = new s3.Bucket(this, 'EcsExecBucket', {\n encryptionKey: kmsKey,\n});\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n executeCommandConfiguration: {\n kmsKey,\n logConfiguration: {\n cloudWatchLogGroup: logGroup,\n cloudWatchEncryptionEnabled: true,\n s3Bucket: execBucket,\n s3EncryptionEnabled: true,\n s3KeyPrefix: 'exec-command-output',\n },\n logging: ecs.ExecuteCommandLogging.OVERRIDE,\n },\n});",
20329 "remarks": "For more information, see\n[Logging] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging",
20330 "stability": "stable",
20331 "summary": "The log settings to use to for logging the execute command session."
20332 },
20333 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandLogging",
20334 "kind": "enum",
20335 "locationInModule": {
20336 "filename": "lib/cluster.ts",
20337 "line": 972
20338 },
20339 "members": [
20340 {
20341 "docs": {
20342 "stability": "stable",
20343 "summary": "The execute command session is not logged."
20344 },
20345 "name": "NONE"
20346 },
20347 {
20348 "docs": {
20349 "remarks": "If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.",
20350 "stability": "stable",
20351 "summary": "The awslogs configuration in the task definition is used."
20352 },
20353 "name": "DEFAULT"
20354 },
20355 {
20356 "docs": {
20357 "stability": "stable",
20358 "summary": "Specify the logging details as a part of logConfiguration."
20359 },
20360 "name": "OVERRIDE"
20361 }
20362 ],
20363 "name": "ExecuteCommandLogging",
20364 "symbolId": "lib/cluster:ExecuteCommandLogging"
20365 },
20366 "@aws-cdk/aws-ecs.ExternalService": {
20367 "assembly": "@aws-cdk/aws-ecs",
20368 "base": "@aws-cdk/aws-ecs.BaseService",
20369 "docs": {
20370 "custom": {
20371 "exampleMetadata": "infused",
20372 "resource": "AWS::ECS::Service"
20373 },
20374 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\n\nconst service = new ecs.ExternalService(this, 'Service', {\n cluster,\n taskDefinition,\n desiredCount: 5,\n});",
20375 "stability": "stable",
20376 "summary": "This creates a service using the External launch type on an ECS cluster."
20377 },
20378 "fqn": "@aws-cdk/aws-ecs.ExternalService",
20379 "initializer": {
20380 "docs": {
20381 "stability": "stable",
20382 "summary": "Constructs a new instance of the ExternalService class."
20383 },
20384 "locationInModule": {
20385 "filename": "lib/external/external-service.ts",
20386 "line": 91
20387 },
20388 "parameters": [
20389 {
20390 "name": "scope",
20391 "type": {
20392 "fqn": "constructs.Construct"
20393 }
20394 },
20395 {
20396 "name": "id",
20397 "type": {
20398 "primitive": "string"
20399 }
20400 },
20401 {
20402 "name": "props",
20403 "type": {
20404 "fqn": "@aws-cdk/aws-ecs.ExternalServiceProps"
20405 }
20406 }
20407 ]
20408 },
20409 "interfaces": [
20410 "@aws-cdk/aws-ecs.IExternalService"
20411 ],
20412 "kind": "class",
20413 "locationInModule": {
20414 "filename": "lib/external/external-service.ts",
20415 "line": 68
20416 },
20417 "methods": [
20418 {
20419 "docs": {
20420 "stability": "stable",
20421 "summary": "Imports from the specified service ARN."
20422 },
20423 "locationInModule": {
20424 "filename": "lib/external/external-service.ts",
20425 "line": 73
20426 },
20427 "name": "fromExternalServiceArn",
20428 "parameters": [
20429 {
20430 "name": "scope",
20431 "type": {
20432 "fqn": "constructs.Construct"
20433 }
20434 },
20435 {
20436 "name": "id",
20437 "type": {
20438 "primitive": "string"
20439 }
20440 },
20441 {
20442 "name": "externalServiceArn",
20443 "type": {
20444 "primitive": "string"
20445 }
20446 }
20447 ],
20448 "returns": {
20449 "type": {
20450 "fqn": "@aws-cdk/aws-ecs.IExternalService"
20451 }
20452 },
20453 "static": true
20454 },
20455 {
20456 "docs": {
20457 "stability": "stable",
20458 "summary": "Imports from the specified service attrributes."
20459 },
20460 "locationInModule": {
20461 "filename": "lib/external/external-service.ts",
20462 "line": 84
20463 },
20464 "name": "fromExternalServiceAttributes",
20465 "parameters": [
20466 {
20467 "name": "scope",
20468 "type": {
20469 "fqn": "constructs.Construct"
20470 }
20471 },
20472 {
20473 "name": "id",
20474 "type": {
20475 "primitive": "string"
20476 }
20477 },
20478 {
20479 "name": "attrs",
20480 "type": {
20481 "fqn": "@aws-cdk/aws-ecs.ExternalServiceAttributes"
20482 }
20483 }
20484 ],
20485 "returns": {
20486 "type": {
20487 "fqn": "@aws-cdk/aws-ecs.IBaseService"
20488 }
20489 },
20490 "static": true
20491 },
20492 {
20493 "docs": {
20494 "stability": "stable",
20495 "summary": "Overriden method to throw error as `associateCloudMapService` is not supported for external service."
20496 },
20497 "locationInModule": {
20498 "filename": "lib/external/external-service.ts",
20499 "line": 187
20500 },
20501 "name": "associateCloudMapService",
20502 "overrides": "@aws-cdk/aws-ecs.BaseService",
20503 "parameters": [
20504 {
20505 "name": "_options",
20506 "type": {
20507 "fqn": "@aws-cdk/aws-ecs.AssociateCloudMapServiceOptions"
20508 }
20509 }
20510 ]
20511 },
20512 {
20513 "docs": {
20514 "stability": "stable",
20515 "summary": "Overriden method to throw error as `attachToApplicationTargetGroup` is not supported for external service."
20516 },
20517 "locationInModule": {
20518 "filename": "lib/external/external-service.ts",
20519 "line": 144
20520 },
20521 "name": "attachToApplicationTargetGroup",
20522 "overrides": "@aws-cdk/aws-ecs.BaseService",
20523 "parameters": [
20524 {
20525 "name": "_targetGroup",
20526 "type": {
20527 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.IApplicationTargetGroup"
20528 }
20529 }
20530 ],
20531 "returns": {
20532 "type": {
20533 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps"
20534 }
20535 }
20536 },
20537 {
20538 "docs": {
20539 "stability": "stable",
20540 "summary": "Overriden method to throw error as `autoScaleTaskCount` is not supported for external service."
20541 },
20542 "locationInModule": {
20543 "filename": "lib/external/external-service.ts",
20544 "line": 173
20545 },
20546 "name": "autoScaleTaskCount",
20547 "overrides": "@aws-cdk/aws-ecs.BaseService",
20548 "parameters": [
20549 {
20550 "name": "_props",
20551 "type": {
20552 "fqn": "@aws-cdk/aws-applicationautoscaling.EnableScalingProps"
20553 }
20554 }
20555 ],
20556 "returns": {
20557 "type": {
20558 "fqn": "@aws-cdk/aws-ecs.ScalableTaskCount"
20559 }
20560 }
20561 },
20562 {
20563 "docs": {
20564 "stability": "stable",
20565 "summary": "Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service."
20566 },
20567 "locationInModule": {
20568 "filename": "lib/external/external-service.ts",
20569 "line": 166
20570 },
20571 "name": "configureAwsVpcNetworkingWithSecurityGroups",
20572 "overrides": "@aws-cdk/aws-ecs.BaseService",
20573 "parameters": [
20574 {
20575 "name": "_vpc",
20576 "type": {
20577 "fqn": "@aws-cdk/aws-ec2.IVpc"
20578 }
20579 },
20580 {
20581 "name": "_assignPublicIp",
20582 "optional": true,
20583 "type": {
20584 "primitive": "boolean"
20585 }
20586 },
20587 {
20588 "name": "_vpcSubnets",
20589 "optional": true,
20590 "type": {
20591 "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
20592 }
20593 },
20594 {
20595 "name": "_securityGroups",
20596 "optional": true,
20597 "type": {
20598 "collection": {
20599 "elementtype": {
20600 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
20601 },
20602 "kind": "array"
20603 }
20604 }
20605 }
20606 ],
20607 "protected": true
20608 },
20609 {
20610 "docs": {
20611 "stability": "stable",
20612 "summary": "Overriden method to throw error as `enableCloudMap` is not supported for external service."
20613 },
20614 "locationInModule": {
20615 "filename": "lib/external/external-service.ts",
20616 "line": 180
20617 },
20618 "name": "enableCloudMap",
20619 "overrides": "@aws-cdk/aws-ecs.BaseService",
20620 "parameters": [
20621 {
20622 "name": "_options",
20623 "type": {
20624 "fqn": "@aws-cdk/aws-ecs.CloudMapOptions"
20625 }
20626 }
20627 ],
20628 "returns": {
20629 "type": {
20630 "fqn": "@aws-cdk/aws-servicediscovery.Service"
20631 }
20632 }
20633 },
20634 {
20635 "docs": {
20636 "stability": "stable",
20637 "summary": "Overriden method to throw error as `loadBalancerTarget` is not supported for external service."
20638 },
20639 "locationInModule": {
20640 "filename": "lib/external/external-service.ts",
20641 "line": 151
20642 },
20643 "name": "loadBalancerTarget",
20644 "overrides": "@aws-cdk/aws-ecs.BaseService",
20645 "parameters": [
20646 {
20647 "name": "_options",
20648 "type": {
20649 "fqn": "@aws-cdk/aws-ecs.LoadBalancerTargetOptions"
20650 }
20651 }
20652 ],
20653 "returns": {
20654 "type": {
20655 "fqn": "@aws-cdk/aws-ecs.IEcsLoadBalancerTarget"
20656 }
20657 }
20658 },
20659 {
20660 "docs": {
20661 "stability": "stable",
20662 "summary": "Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external service."
20663 },
20664 "locationInModule": {
20665 "filename": "lib/external/external-service.ts",
20666 "line": 158
20667 },
20668 "name": "registerLoadBalancerTargets",
20669 "overrides": "@aws-cdk/aws-ecs.BaseService",
20670 "parameters": [
20671 {
20672 "name": "_targets",
20673 "type": {
20674 "fqn": "@aws-cdk/aws-ecs.EcsTarget"
20675 },
20676 "variadic": true
20677 }
20678 ],
20679 "variadic": true
20680 }
20681 ],
20682 "name": "ExternalService",
20683 "symbolId": "lib/external/external-service:ExternalService"
20684 },
20685 "@aws-cdk/aws-ecs.ExternalServiceAttributes": {
20686 "assembly": "@aws-cdk/aws-ecs",
20687 "datatype": true,
20688 "docs": {
20689 "stability": "stable",
20690 "summary": "The properties to import from the service using the External launch type.",
20691 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const cluster: ecs.Cluster;\nconst externalServiceAttributes: ecs.ExternalServiceAttributes = {\n cluster: cluster,\n\n // the properties below are optional\n serviceArn: 'serviceArn',\n serviceName: 'serviceName',\n};",
20692 "custom": {
20693 "exampleMetadata": "fixture=_generated"
20694 }
20695 },
20696 "fqn": "@aws-cdk/aws-ecs.ExternalServiceAttributes",
20697 "kind": "interface",
20698 "locationInModule": {
20699 "filename": "lib/external/external-service.ts",
20700 "line": 42
20701 },
20702 "name": "ExternalServiceAttributes",
20703 "properties": [
20704 {
20705 "abstract": true,
20706 "docs": {
20707 "stability": "stable",
20708 "summary": "The cluster that hosts the service."
20709 },
20710 "immutable": true,
20711 "locationInModule": {
20712 "filename": "lib/external/external-service.ts",
20713 "line": 46
20714 },
20715 "name": "cluster",
20716 "type": {
20717 "fqn": "@aws-cdk/aws-ecs.ICluster"
20718 }
20719 },
20720 {
20721 "abstract": true,
20722 "docs": {
20723 "default": "- either this, or {@link serviceName}, is required",
20724 "stability": "stable",
20725 "summary": "The service ARN."
20726 },
20727 "immutable": true,
20728 "locationInModule": {
20729 "filename": "lib/external/external-service.ts",
20730 "line": 53
20731 },
20732 "name": "serviceArn",
20733 "optional": true,
20734 "type": {
20735 "primitive": "string"
20736 }
20737 },
20738 {
20739 "abstract": true,
20740 "docs": {
20741 "default": "- either this, or {@link serviceArn}, is required",
20742 "stability": "stable",
20743 "summary": "The name of the service."
20744 },
20745 "immutable": true,
20746 "locationInModule": {
20747 "filename": "lib/external/external-service.ts",
20748 "line": 60
20749 },
20750 "name": "serviceName",
20751 "optional": true,
20752 "type": {
20753 "primitive": "string"
20754 }
20755 }
20756 ],
20757 "symbolId": "lib/external/external-service:ExternalServiceAttributes"
20758 },
20759 "@aws-cdk/aws-ecs.ExternalServiceProps": {
20760 "assembly": "@aws-cdk/aws-ecs",
20761 "datatype": true,
20762 "docs": {
20763 "custom": {
20764 "exampleMetadata": "infused"
20765 },
20766 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\n\nconst service = new ecs.ExternalService(this, 'Service', {\n cluster,\n taskDefinition,\n desiredCount: 5,\n});",
20767 "stability": "stable",
20768 "summary": "The properties for defining a service using the External launch type."
20769 },
20770 "fqn": "@aws-cdk/aws-ecs.ExternalServiceProps",
20771 "interfaces": [
20772 "@aws-cdk/aws-ecs.BaseServiceOptions"
20773 ],
20774 "kind": "interface",
20775 "locationInModule": {
20776 "filename": "lib/external/external-service.ts",
20777 "line": 15
20778 },
20779 "name": "ExternalServiceProps",
20780 "properties": [
20781 {
20782 "abstract": true,
20783 "docs": {
20784 "remarks": "[disable-awslint:ref-via-interface]",
20785 "stability": "stable",
20786 "summary": "The task definition to use for tasks in the service."
20787 },
20788 "immutable": true,
20789 "locationInModule": {
20790 "filename": "lib/external/external-service.ts",
20791 "line": 21
20792 },
20793 "name": "taskDefinition",
20794 "type": {
20795 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
20796 }
20797 },
20798 {
20799 "abstract": true,
20800 "docs": {
20801 "default": "- A new security group is created.",
20802 "remarks": "If you do not specify a security group, a new security group is created.",
20803 "stability": "stable",
20804 "summary": "The security groups to associate with the service."
20805 },
20806 "immutable": true,
20807 "locationInModule": {
20808 "filename": "lib/external/external-service.ts",
20809 "line": 29
20810 },
20811 "name": "securityGroups",
20812 "optional": true,
20813 "type": {
20814 "collection": {
20815 "elementtype": {
20816 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
20817 },
20818 "kind": "array"
20819 }
20820 }
20821 }
20822 ],
20823 "symbolId": "lib/external/external-service:ExternalServiceProps"
20824 },
20825 "@aws-cdk/aws-ecs.ExternalTaskDefinition": {
20826 "assembly": "@aws-cdk/aws-ecs",
20827 "base": "@aws-cdk/aws-ecs.TaskDefinition",
20828 "docs": {
20829 "custom": {
20830 "exampleMetadata": "infused",
20831 "resource": "AWS::ECS::TaskDefinition"
20832 },
20833 "example": "const externalTaskDefinition = new ecs.ExternalTaskDefinition(this, 'TaskDef');\n\nconst container = externalTaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n // ... other options here ...\n});",
20834 "stability": "stable",
20835 "summary": "The details of a task definition run on an External cluster."
20836 },
20837 "fqn": "@aws-cdk/aws-ecs.ExternalTaskDefinition",
20838 "initializer": {
20839 "docs": {
20840 "stability": "stable",
20841 "summary": "Constructs a new instance of the ExternalTaskDefinition class."
20842 },
20843 "locationInModule": {
20844 "filename": "lib/external/external-task-definition.ts",
20845 "line": 69
20846 },
20847 "parameters": [
20848 {
20849 "name": "scope",
20850 "type": {
20851 "fqn": "constructs.Construct"
20852 }
20853 },
20854 {
20855 "name": "id",
20856 "type": {
20857 "primitive": "string"
20858 }
20859 },
20860 {
20861 "name": "props",
20862 "optional": true,
20863 "type": {
20864 "fqn": "@aws-cdk/aws-ecs.ExternalTaskDefinitionProps"
20865 }
20866 }
20867 ]
20868 },
20869 "interfaces": [
20870 "@aws-cdk/aws-ecs.IExternalTaskDefinition"
20871 ],
20872 "kind": "class",
20873 "locationInModule": {
20874 "filename": "lib/external/external-task-definition.ts",
20875 "line": 39
20876 },
20877 "methods": [
20878 {
20879 "docs": {
20880 "stability": "stable",
20881 "summary": "Imports a task definition from the specified task definition ARN."
20882 },
20883 "locationInModule": {
20884 "filename": "lib/external/external-task-definition.ts",
20885 "line": 44
20886 },
20887 "name": "fromEc2TaskDefinitionArn",
20888 "parameters": [
20889 {
20890 "name": "scope",
20891 "type": {
20892 "fqn": "constructs.Construct"
20893 }
20894 },
20895 {
20896 "name": "id",
20897 "type": {
20898 "primitive": "string"
20899 }
20900 },
20901 {
20902 "name": "externalTaskDefinitionArn",
20903 "type": {
20904 "primitive": "string"
20905 }
20906 }
20907 ],
20908 "returns": {
20909 "type": {
20910 "fqn": "@aws-cdk/aws-ecs.IExternalTaskDefinition"
20911 }
20912 },
20913 "static": true
20914 },
20915 {
20916 "docs": {
20917 "stability": "stable",
20918 "summary": "Imports an existing External task definition from its attributes."
20919 },
20920 "locationInModule": {
20921 "filename": "lib/external/external-task-definition.ts",
20922 "line": 53
20923 },
20924 "name": "fromExternalTaskDefinitionAttributes",
20925 "parameters": [
20926 {
20927 "name": "scope",
20928 "type": {
20929 "fqn": "constructs.Construct"
20930 }
20931 },
20932 {
20933 "name": "id",
20934 "type": {
20935 "primitive": "string"
20936 }
20937 },
20938 {
20939 "name": "attrs",
20940 "type": {
20941 "fqn": "@aws-cdk/aws-ecs.ExternalTaskDefinitionAttributes"
20942 }
20943 }
20944 ],
20945 "returns": {
20946 "type": {
20947 "fqn": "@aws-cdk/aws-ecs.IExternalTaskDefinition"
20948 }
20949 },
20950 "static": true
20951 },
20952 {
20953 "docs": {
20954 "stability": "stable",
20955 "summary": "Overriden method to throw error as interface accelerators are not supported for external tasks."
20956 },
20957 "locationInModule": {
20958 "filename": "lib/external/external-task-definition.ts",
20959 "line": 80
20960 },
20961 "name": "addInferenceAccelerator",
20962 "overrides": "@aws-cdk/aws-ecs.TaskDefinition",
20963 "parameters": [
20964 {
20965 "name": "_inferenceAccelerator",
20966 "type": {
20967 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator"
20968 }
20969 }
20970 ]
20971 }
20972 ],
20973 "name": "ExternalTaskDefinition",
20974 "symbolId": "lib/external/external-task-definition:ExternalTaskDefinition"
20975 },
20976 "@aws-cdk/aws-ecs.ExternalTaskDefinitionAttributes": {
20977 "assembly": "@aws-cdk/aws-ecs",
20978 "datatype": true,
20979 "docs": {
20980 "stability": "stable",
20981 "summary": "Attributes used to import an existing External task definition.",
20982 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst externalTaskDefinitionAttributes: ecs.ExternalTaskDefinitionAttributes = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n networkMode: ecs.NetworkMode.NONE,\n taskRole: role,\n};",
20983 "custom": {
20984 "exampleMetadata": "fixture=_generated"
20985 }
20986 },
20987 "fqn": "@aws-cdk/aws-ecs.ExternalTaskDefinitionAttributes",
20988 "interfaces": [
20989 "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes"
20990 ],
20991 "kind": "interface",
20992 "locationInModule": {
20993 "filename": "lib/external/external-task-definition.ts",
20994 "line": 30
20995 },
20996 "name": "ExternalTaskDefinitionAttributes",
20997 "symbolId": "lib/external/external-task-definition:ExternalTaskDefinitionAttributes"
20998 },
20999 "@aws-cdk/aws-ecs.ExternalTaskDefinitionProps": {
21000 "assembly": "@aws-cdk/aws-ecs",
21001 "datatype": true,
21002 "docs": {
21003 "stability": "stable",
21004 "summary": "The properties for a task definition run on an External cluster.",
21005 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const proxyConfiguration: ecs.ProxyConfiguration;\ndeclare const role: iam.Role;\nconst externalTaskDefinitionProps: ecs.ExternalTaskDefinitionProps = {\n executionRole: role,\n family: 'family',\n proxyConfiguration: proxyConfiguration,\n taskRole: role,\n volumes: [{\n name: 'name',\n\n // the properties below are optional\n dockerVolumeConfiguration: {\n driver: 'driver',\n scope: ecs.Scope.TASK,\n\n // the properties below are optional\n autoprovision: false,\n driverOpts: {\n driverOptsKey: 'driverOpts',\n },\n labels: {\n labelsKey: 'labels',\n },\n },\n efsVolumeConfiguration: {\n fileSystemId: 'fileSystemId',\n\n // the properties below are optional\n authorizationConfig: {\n accessPointId: 'accessPointId',\n iam: 'iam',\n },\n rootDirectory: 'rootDirectory',\n transitEncryption: 'transitEncryption',\n transitEncryptionPort: 123,\n },\n host: {\n sourcePath: 'sourcePath',\n },\n }],\n};",
21006 "custom": {
21007 "exampleMetadata": "fixture=_generated"
21008 }
21009 },
21010 "fqn": "@aws-cdk/aws-ecs.ExternalTaskDefinitionProps",
21011 "interfaces": [
21012 "@aws-cdk/aws-ecs.CommonTaskDefinitionProps"
21013 ],
21014 "kind": "interface",
21015 "locationInModule": {
21016 "filename": "lib/external/external-task-definition.ts",
21017 "line": 16
21018 },
21019 "name": "ExternalTaskDefinitionProps",
21020 "symbolId": "lib/external/external-task-definition:ExternalTaskDefinitionProps"
21021 },
21022 "@aws-cdk/aws-ecs.FargatePlatformVersion": {
21023 "assembly": "@aws-cdk/aws-ecs",
21024 "docs": {
21025 "custom": {
21026 "exampleMetadata": "infused"
21027 },
21028 "example": "declare const cluster: ecs.Cluster;\nconst scheduledFargateTask = new ecsPatterns.ScheduledFargateTask(this, 'ScheduledFargateTask', {\n cluster,\n scheduledFargateTaskImageOptions: {\n image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),\n memoryLimitMiB: 512,\n },\n schedule: appscaling.Schedule.expression('rate(1 minute)'),\n platformVersion: ecs.FargatePlatformVersion.LATEST,\n});",
21029 "see": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html",
21030 "stability": "stable",
21031 "summary": "The platform version on which to run your service."
21032 },
21033 "fqn": "@aws-cdk/aws-ecs.FargatePlatformVersion",
21034 "kind": "enum",
21035 "locationInModule": {
21036 "filename": "lib/fargate/fargate-service.ts",
21037 "line": 169
21038 },
21039 "members": [
21040 {
21041 "docs": {
21042 "stability": "stable",
21043 "summary": "The latest, recommended platform version."
21044 },
21045 "name": "LATEST"
21046 },
21047 {
21048 "docs": {
21049 "remarks": "Supports EFS endpoints, CAP_SYS_PTRACE Linux capability,\nnetwork performance metrics in CloudWatch Container Insights,\nconsolidated 20 GB ephemeral volume.",
21050 "stability": "stable",
21051 "summary": "Version 1.4.0."
21052 },
21053 "name": "VERSION1_4"
21054 },
21055 {
21056 "docs": {
21057 "remarks": "Supports secrets, task recycling.",
21058 "stability": "stable",
21059 "summary": "Version 1.3.0."
21060 },
21061 "name": "VERSION1_3"
21062 },
21063 {
21064 "docs": {
21065 "remarks": "Supports private registries.",
21066 "stability": "stable",
21067 "summary": "Version 1.2.0."
21068 },
21069 "name": "VERSION1_2"
21070 },
21071 {
21072 "docs": {
21073 "remarks": "Supports task metadata, health checks, service discovery.",
21074 "stability": "stable",
21075 "summary": "Version 1.1.0."
21076 },
21077 "name": "VERSION1_1"
21078 },
21079 {
21080 "docs": {
21081 "remarks": "Based on Amazon Linux 2017.09.",
21082 "stability": "stable",
21083 "summary": "Initial release."
21084 },
21085 "name": "VERSION1_0"
21086 }
21087 ],
21088 "name": "FargatePlatformVersion",
21089 "symbolId": "lib/fargate/fargate-service:FargatePlatformVersion"
21090 },
21091 "@aws-cdk/aws-ecs.FargateService": {
21092 "assembly": "@aws-cdk/aws-ecs",
21093 "base": "@aws-cdk/aws-ecs.BaseService",
21094 "docs": {
21095 "custom": {
21096 "exampleMetadata": "infused",
21097 "resource": "AWS::ECS::Service"
21098 },
21099 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);",
21100 "stability": "stable",
21101 "summary": "This creates a service using the Fargate launch type on an ECS cluster."
21102 },
21103 "fqn": "@aws-cdk/aws-ecs.FargateService",
21104 "initializer": {
21105 "docs": {
21106 "stability": "stable",
21107 "summary": "Constructs a new instance of the FargateService class."
21108 },
21109 "locationInModule": {
21110 "filename": "lib/fargate/fargate-service.ts",
21111 "line": 123
21112 },
21113 "parameters": [
21114 {
21115 "name": "scope",
21116 "type": {
21117 "fqn": "constructs.Construct"
21118 }
21119 },
21120 {
21121 "name": "id",
21122 "type": {
21123 "primitive": "string"
21124 }
21125 },
21126 {
21127 "name": "props",
21128 "type": {
21129 "fqn": "@aws-cdk/aws-ecs.FargateServiceProps"
21130 }
21131 }
21132 ]
21133 },
21134 "interfaces": [
21135 "@aws-cdk/aws-ecs.IFargateService"
21136 ],
21137 "kind": "class",
21138 "locationInModule": {
21139 "filename": "lib/fargate/fargate-service.ts",
21140 "line": 100
21141 },
21142 "methods": [
21143 {
21144 "docs": {
21145 "stability": "stable",
21146 "summary": "Imports from the specified service ARN."
21147 },
21148 "locationInModule": {
21149 "filename": "lib/fargate/fargate-service.ts",
21150 "line": 105
21151 },
21152 "name": "fromFargateServiceArn",
21153 "parameters": [
21154 {
21155 "name": "scope",
21156 "type": {
21157 "fqn": "constructs.Construct"
21158 }
21159 },
21160 {
21161 "name": "id",
21162 "type": {
21163 "primitive": "string"
21164 }
21165 },
21166 {
21167 "name": "fargateServiceArn",
21168 "type": {
21169 "primitive": "string"
21170 }
21171 }
21172 ],
21173 "returns": {
21174 "type": {
21175 "fqn": "@aws-cdk/aws-ecs.IFargateService"
21176 }
21177 },
21178 "static": true
21179 },
21180 {
21181 "docs": {
21182 "stability": "stable",
21183 "summary": "Imports from the specified service attrributes."
21184 },
21185 "locationInModule": {
21186 "filename": "lib/fargate/fargate-service.ts",
21187 "line": 116
21188 },
21189 "name": "fromFargateServiceAttributes",
21190 "parameters": [
21191 {
21192 "name": "scope",
21193 "type": {
21194 "fqn": "constructs.Construct"
21195 }
21196 },
21197 {
21198 "name": "id",
21199 "type": {
21200 "primitive": "string"
21201 }
21202 },
21203 {
21204 "name": "attrs",
21205 "type": {
21206 "fqn": "@aws-cdk/aws-ecs.FargateServiceAttributes"
21207 }
21208 }
21209 ],
21210 "returns": {
21211 "type": {
21212 "fqn": "@aws-cdk/aws-ecs.IBaseService"
21213 }
21214 },
21215 "static": true
21216 }
21217 ],
21218 "name": "FargateService",
21219 "symbolId": "lib/fargate/fargate-service:FargateService"
21220 },
21221 "@aws-cdk/aws-ecs.FargateServiceAttributes": {
21222 "assembly": "@aws-cdk/aws-ecs",
21223 "datatype": true,
21224 "docs": {
21225 "stability": "stable",
21226 "summary": "The properties to import from the service using the Fargate launch type.",
21227 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const cluster: ecs.Cluster;\nconst fargateServiceAttributes: ecs.FargateServiceAttributes = {\n cluster: cluster,\n\n // the properties below are optional\n serviceArn: 'serviceArn',\n serviceName: 'serviceName',\n};",
21228 "custom": {
21229 "exampleMetadata": "fixture=_generated"
21230 }
21231 },
21232 "fqn": "@aws-cdk/aws-ecs.FargateServiceAttributes",
21233 "kind": "interface",
21234 "locationInModule": {
21235 "filename": "lib/fargate/fargate-service.ts",
21236 "line": 74
21237 },
21238 "name": "FargateServiceAttributes",
21239 "properties": [
21240 {
21241 "abstract": true,
21242 "docs": {
21243 "stability": "stable",
21244 "summary": "The cluster that hosts the service."
21245 },
21246 "immutable": true,
21247 "locationInModule": {
21248 "filename": "lib/fargate/fargate-service.ts",
21249 "line": 78
21250 },
21251 "name": "cluster",
21252 "type": {
21253 "fqn": "@aws-cdk/aws-ecs.ICluster"
21254 }
21255 },
21256 {
21257 "abstract": true,
21258 "docs": {
21259 "default": "- either this, or {@link serviceName}, is required",
21260 "stability": "stable",
21261 "summary": "The service ARN."
21262 },
21263 "immutable": true,
21264 "locationInModule": {
21265 "filename": "lib/fargate/fargate-service.ts",
21266 "line": 85
21267 },
21268 "name": "serviceArn",
21269 "optional": true,
21270 "type": {
21271 "primitive": "string"
21272 }
21273 },
21274 {
21275 "abstract": true,
21276 "docs": {
21277 "default": "- either this, or {@link serviceArn}, is required",
21278 "stability": "stable",
21279 "summary": "The name of the service."
21280 },
21281 "immutable": true,
21282 "locationInModule": {
21283 "filename": "lib/fargate/fargate-service.ts",
21284 "line": 92
21285 },
21286 "name": "serviceName",
21287 "optional": true,
21288 "type": {
21289 "primitive": "string"
21290 }
21291 }
21292 ],
21293 "symbolId": "lib/fargate/fargate-service:FargateServiceAttributes"
21294 },
21295 "@aws-cdk/aws-ecs.FargateServiceProps": {
21296 "assembly": "@aws-cdk/aws-ecs",
21297 "datatype": true,
21298 "docs": {
21299 "custom": {
21300 "exampleMetadata": "infused"
21301 },
21302 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);",
21303 "stability": "stable",
21304 "summary": "The properties for defining a service using the Fargate launch type."
21305 },
21306 "fqn": "@aws-cdk/aws-ecs.FargateServiceProps",
21307 "interfaces": [
21308 "@aws-cdk/aws-ecs.BaseServiceOptions"
21309 ],
21310 "kind": "interface",
21311 "locationInModule": {
21312 "filename": "lib/fargate/fargate-service.ts",
21313 "line": 13
21314 },
21315 "name": "FargateServiceProps",
21316 "properties": [
21317 {
21318 "abstract": true,
21319 "docs": {
21320 "remarks": "[disable-awslint:ref-via-interface]",
21321 "stability": "stable",
21322 "summary": "The task definition to use for tasks in the service."
21323 },
21324 "immutable": true,
21325 "locationInModule": {
21326 "filename": "lib/fargate/fargate-service.ts",
21327 "line": 19
21328 },
21329 "name": "taskDefinition",
21330 "type": {
21331 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
21332 }
21333 },
21334 {
21335 "abstract": true,
21336 "docs": {
21337 "default": "false",
21338 "remarks": "If true, each task will receive a public IP address.",
21339 "stability": "stable",
21340 "summary": "Specifies whether the task's elastic network interface receives a public IP address."
21341 },
21342 "immutable": true,
21343 "locationInModule": {
21344 "filename": "lib/fargate/fargate-service.ts",
21345 "line": 28
21346 },
21347 "name": "assignPublicIp",
21348 "optional": true,
21349 "type": {
21350 "primitive": "boolean"
21351 }
21352 },
21353 {
21354 "abstract": true,
21355 "docs": {
21356 "default": "Latest",
21357 "remarks": "If one is not specified, the LATEST platform version is used by default. For more information, see\n[AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)\nin the Amazon Elastic Container Service Developer Guide.",
21358 "stability": "stable",
21359 "summary": "The platform version on which to run your service."
21360 },
21361 "immutable": true,
21362 "locationInModule": {
21363 "filename": "lib/fargate/fargate-service.ts",
21364 "line": 61
21365 },
21366 "name": "platformVersion",
21367 "optional": true,
21368 "type": {
21369 "fqn": "@aws-cdk/aws-ecs.FargatePlatformVersion"
21370 }
21371 },
21372 {
21373 "abstract": true,
21374 "docs": {
21375 "default": "- A new security group is created.",
21376 "deprecated": "use securityGroups instead.",
21377 "remarks": "If you do not specify a security group, a new security group is created.",
21378 "stability": "deprecated",
21379 "summary": "The security groups to associate with the service."
21380 },
21381 "immutable": true,
21382 "locationInModule": {
21383 "filename": "lib/fargate/fargate-service.ts",
21384 "line": 43
21385 },
21386 "name": "securityGroup",
21387 "optional": true,
21388 "type": {
21389 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
21390 }
21391 },
21392 {
21393 "abstract": true,
21394 "docs": {
21395 "default": "- A new security group is created.",
21396 "remarks": "If you do not specify a security group, a new security group is created.",
21397 "stability": "stable",
21398 "summary": "The security groups to associate with the service."
21399 },
21400 "immutable": true,
21401 "locationInModule": {
21402 "filename": "lib/fargate/fargate-service.ts",
21403 "line": 50
21404 },
21405 "name": "securityGroups",
21406 "optional": true,
21407 "type": {
21408 "collection": {
21409 "elementtype": {
21410 "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
21411 },
21412 "kind": "array"
21413 }
21414 }
21415 },
21416 {
21417 "abstract": true,
21418 "docs": {
21419 "default": "- Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.",
21420 "stability": "stable",
21421 "summary": "The subnets to associate with the service."
21422 },
21423 "immutable": true,
21424 "locationInModule": {
21425 "filename": "lib/fargate/fargate-service.ts",
21426 "line": 35
21427 },
21428 "name": "vpcSubnets",
21429 "optional": true,
21430 "type": {
21431 "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
21432 }
21433 }
21434 ],
21435 "symbolId": "lib/fargate/fargate-service:FargateServiceProps"
21436 },
21437 "@aws-cdk/aws-ecs.FargateTaskDefinition": {
21438 "assembly": "@aws-cdk/aws-ecs",
21439 "base": "@aws-cdk/aws-ecs.TaskDefinition",
21440 "docs": {
21441 "custom": {
21442 "exampleMetadata": "infused",
21443 "resource": "AWS::ECS::TaskDefinition"
21444 },
21445 "example": "const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\nconst container = fargateTaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n // ... other options here ...\n});",
21446 "stability": "stable",
21447 "summary": "The details of a task definition run on a Fargate cluster."
21448 },
21449 "fqn": "@aws-cdk/aws-ecs.FargateTaskDefinition",
21450 "initializer": {
21451 "docs": {
21452 "stability": "stable",
21453 "summary": "Constructs a new instance of the FargateTaskDefinition class."
21454 },
21455 "locationInModule": {
21456 "filename": "lib/fargate/fargate-task-definition.ts",
21457 "line": 134
21458 },
21459 "parameters": [
21460 {
21461 "name": "scope",
21462 "type": {
21463 "fqn": "constructs.Construct"
21464 }
21465 },
21466 {
21467 "name": "id",
21468 "type": {
21469 "primitive": "string"
21470 }
21471 },
21472 {
21473 "name": "props",
21474 "optional": true,
21475 "type": {
21476 "fqn": "@aws-cdk/aws-ecs.FargateTaskDefinitionProps"
21477 }
21478 }
21479 ]
21480 },
21481 "interfaces": [
21482 "@aws-cdk/aws-ecs.IFargateTaskDefinition"
21483 ],
21484 "kind": "class",
21485 "locationInModule": {
21486 "filename": "lib/fargate/fargate-task-definition.ts",
21487 "line": 93
21488 },
21489 "methods": [
21490 {
21491 "docs": {
21492 "stability": "stable",
21493 "summary": "Imports a task definition from the specified task definition ARN."
21494 },
21495 "locationInModule": {
21496 "filename": "lib/fargate/fargate-task-definition.ts",
21497 "line": 98
21498 },
21499 "name": "fromFargateTaskDefinitionArn",
21500 "parameters": [
21501 {
21502 "name": "scope",
21503 "type": {
21504 "fqn": "constructs.Construct"
21505 }
21506 },
21507 {
21508 "name": "id",
21509 "type": {
21510 "primitive": "string"
21511 }
21512 },
21513 {
21514 "name": "fargateTaskDefinitionArn",
21515 "type": {
21516 "primitive": "string"
21517 }
21518 }
21519 ],
21520 "returns": {
21521 "type": {
21522 "fqn": "@aws-cdk/aws-ecs.IFargateTaskDefinition"
21523 }
21524 },
21525 "static": true
21526 },
21527 {
21528 "docs": {
21529 "stability": "stable",
21530 "summary": "Import an existing Fargate task definition from its attributes."
21531 },
21532 "locationInModule": {
21533 "filename": "lib/fargate/fargate-task-definition.ts",
21534 "line": 105
21535 },
21536 "name": "fromFargateTaskDefinitionAttributes",
21537 "parameters": [
21538 {
21539 "name": "scope",
21540 "type": {
21541 "fqn": "constructs.Construct"
21542 }
21543 },
21544 {
21545 "name": "id",
21546 "type": {
21547 "primitive": "string"
21548 }
21549 },
21550 {
21551 "name": "attrs",
21552 "type": {
21553 "fqn": "@aws-cdk/aws-ecs.FargateTaskDefinitionAttributes"
21554 }
21555 }
21556 ],
21557 "returns": {
21558 "type": {
21559 "fqn": "@aws-cdk/aws-ecs.IFargateTaskDefinition"
21560 }
21561 },
21562 "static": true
21563 }
21564 ],
21565 "name": "FargateTaskDefinition",
21566 "properties": [
21567 {
21568 "docs": {
21569 "remarks": "Fargate tasks require the awsvpc network mode.",
21570 "stability": "stable",
21571 "summary": "The Docker networking mode to use for the containers in the task."
21572 },
21573 "immutable": true,
21574 "locationInModule": {
21575 "filename": "lib/fargate/fargate-task-definition.ts",
21576 "line": 121
21577 },
21578 "name": "networkMode",
21579 "overrides": "@aws-cdk/aws-ecs.TaskDefinition",
21580 "type": {
21581 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
21582 }
21583 },
21584 {
21585 "docs": {
21586 "stability": "stable",
21587 "summary": "The amount (in GiB) of ephemeral storage to be allocated to the task."
21588 },
21589 "immutable": true,
21590 "locationInModule": {
21591 "filename": "lib/fargate/fargate-task-definition.ts",
21592 "line": 129
21593 },
21594 "name": "ephemeralStorageGiB",
21595 "optional": true,
21596 "overrides": "@aws-cdk/aws-ecs.TaskDefinition",
21597 "type": {
21598 "primitive": "number"
21599 }
21600 }
21601 ],
21602 "symbolId": "lib/fargate/fargate-task-definition:FargateTaskDefinition"
21603 },
21604 "@aws-cdk/aws-ecs.FargateTaskDefinitionAttributes": {
21605 "assembly": "@aws-cdk/aws-ecs",
21606 "datatype": true,
21607 "docs": {
21608 "stability": "stable",
21609 "summary": "Attributes used to import an existing Fargate task definition.",
21610 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst fargateTaskDefinitionAttributes: ecs.FargateTaskDefinitionAttributes = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n networkMode: ecs.NetworkMode.NONE,\n taskRole: role,\n};",
21611 "custom": {
21612 "exampleMetadata": "fixture=_generated"
21613 }
21614 },
21615 "fqn": "@aws-cdk/aws-ecs.FargateTaskDefinitionAttributes",
21616 "interfaces": [
21617 "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes"
21618 ],
21619 "kind": "interface",
21620 "locationInModule": {
21621 "filename": "lib/fargate/fargate-task-definition.ts",
21622 "line": 84
21623 },
21624 "name": "FargateTaskDefinitionAttributes",
21625 "symbolId": "lib/fargate/fargate-task-definition:FargateTaskDefinitionAttributes"
21626 },
21627 "@aws-cdk/aws-ecs.FargateTaskDefinitionProps": {
21628 "assembly": "@aws-cdk/aws-ecs",
21629 "datatype": true,
21630 "docs": {
21631 "custom": {
21632 "exampleMetadata": "infused"
21633 },
21634 "example": "const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\nconst container = fargateTaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n // ... other options here ...\n});",
21635 "stability": "stable",
21636 "summary": "The properties for a task definition."
21637 },
21638 "fqn": "@aws-cdk/aws-ecs.FargateTaskDefinitionProps",
21639 "interfaces": [
21640 "@aws-cdk/aws-ecs.CommonTaskDefinitionProps"
21641 ],
21642 "kind": "interface",
21643 "locationInModule": {
21644 "filename": "lib/fargate/fargate-task-definition.ts",
21645 "line": 17
21646 },
21647 "name": "FargateTaskDefinitionProps",
21648 "properties": [
21649 {
21650 "abstract": true,
21651 "docs": {
21652 "default": "256",
21653 "remarks": "For tasks using the Fargate launch type,\nthis field is required and you must use one of the following values,\nwhich determines your range of valid values for the memory parameter:\n\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n\n512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n\n1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n\n2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n\n4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)",
21654 "stability": "stable",
21655 "summary": "The number of cpu units used by the task."
21656 },
21657 "immutable": true,
21658 "locationInModule": {
21659 "filename": "lib/fargate/fargate-task-definition.ts",
21660 "line": 35
21661 },
21662 "name": "cpu",
21663 "optional": true,
21664 "type": {
21665 "primitive": "number"
21666 }
21667 },
21668 {
21669 "abstract": true,
21670 "docs": {
21671 "default": "20",
21672 "remarks": "The maximum supported value is 200 GiB.\n\nNOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later.",
21673 "stability": "stable",
21674 "summary": "The amount (in GiB) of ephemeral storage to be allocated to the task."
21675 },
21676 "immutable": true,
21677 "locationInModule": {
21678 "filename": "lib/fargate/fargate-task-definition.ts",
21679 "line": 62
21680 },
21681 "name": "ephemeralStorageGiB",
21682 "optional": true,
21683 "type": {
21684 "primitive": "number"
21685 }
21686 },
21687 {
21688 "abstract": true,
21689 "docs": {
21690 "default": "512",
21691 "remarks": "For tasks using the Fargate launch type,\nthis field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:\n\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)\n\n1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)\n\n2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)\n\nBetween 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)\n\nBetween 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)",
21692 "stability": "stable",
21693 "summary": "The amount (in MiB) of memory used by the task."
21694 },
21695 "immutable": true,
21696 "locationInModule": {
21697 "filename": "lib/fargate/fargate-task-definition.ts",
21698 "line": 53
21699 },
21700 "name": "memoryLimitMiB",
21701 "optional": true,
21702 "type": {
21703 "primitive": "number"
21704 }
21705 },
21706 {
21707 "abstract": true,
21708 "docs": {
21709 "default": "- Undefined.",
21710 "remarks": "A runtimePlatform is supported only for tasks using the Fargate launch type.",
21711 "stability": "stable",
21712 "summary": "The operating system that your task definitions are running on."
21713 },
21714 "immutable": true,
21715 "locationInModule": {
21716 "filename": "lib/fargate/fargate-task-definition.ts",
21717 "line": 71
21718 },
21719 "name": "runtimePlatform",
21720 "optional": true,
21721 "type": {
21722 "fqn": "@aws-cdk/aws-ecs.RuntimePlatform"
21723 }
21724 }
21725 ],
21726 "symbolId": "lib/fargate/fargate-task-definition:FargateTaskDefinitionProps"
21727 },
21728 "@aws-cdk/aws-ecs.FireLensLogDriver": {
21729 "assembly": "@aws-cdk/aws-ecs",
21730 "base": "@aws-cdk/aws-ecs.LogDriver",
21731 "docs": {
21732 "stability": "stable",
21733 "summary": "FireLens enables you to use task definition parameters to route logs to an AWS service or AWS Partner Network (APN) destination for log storage and analytics.",
21734 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const secret: ecs.Secret;\nconst fireLensLogDriver = new ecs.FireLensLogDriver({\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n options: {\n optionsKey: 'options',\n },\n secretOptions: {\n secretOptionsKey: secret,\n },\n tag: 'tag',\n});",
21735 "custom": {
21736 "exampleMetadata": "fixture=_generated"
21737 }
21738 },
21739 "fqn": "@aws-cdk/aws-ecs.FireLensLogDriver",
21740 "initializer": {
21741 "docs": {
21742 "stability": "stable",
21743 "summary": "Constructs a new instance of the FireLensLogDriver class."
21744 },
21745 "locationInModule": {
21746 "filename": "lib/log-drivers/firelens-log-driver.ts",
21747 "line": 48
21748 },
21749 "parameters": [
21750 {
21751 "docs": {
21752 "summary": "the awsfirelens log driver configuration options."
21753 },
21754 "name": "props",
21755 "type": {
21756 "fqn": "@aws-cdk/aws-ecs.FireLensLogDriverProps"
21757 }
21758 }
21759 ]
21760 },
21761 "kind": "class",
21762 "locationInModule": {
21763 "filename": "lib/log-drivers/firelens-log-driver.ts",
21764 "line": 31
21765 },
21766 "methods": [
21767 {
21768 "docs": {
21769 "stability": "stable",
21770 "summary": "Called when the log driver is configured on a container."
21771 },
21772 "locationInModule": {
21773 "filename": "lib/log-drivers/firelens-log-driver.ts",
21774 "line": 58
21775 },
21776 "name": "bind",
21777 "overrides": "@aws-cdk/aws-ecs.LogDriver",
21778 "parameters": [
21779 {
21780 "name": "_scope",
21781 "type": {
21782 "fqn": "@aws-cdk/core.Construct"
21783 }
21784 },
21785 {
21786 "name": "_containerDefinition",
21787 "type": {
21788 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
21789 }
21790 }
21791 ],
21792 "returns": {
21793 "type": {
21794 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
21795 }
21796 }
21797 }
21798 ],
21799 "name": "FireLensLogDriver",
21800 "symbolId": "lib/log-drivers/firelens-log-driver:FireLensLogDriver"
21801 },
21802 "@aws-cdk/aws-ecs.FireLensLogDriverProps": {
21803 "assembly": "@aws-cdk/aws-ecs",
21804 "datatype": true,
21805 "docs": {
21806 "custom": {
21807 "exampleMetadata": "infused"
21808 },
21809 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.firelens({\n options: {\n Name: 'firehose',\n region: 'us-west-2',\n delivery_stream: 'my-stream',\n },\n }),\n});",
21810 "stability": "stable",
21811 "summary": "Specifies the firelens log driver configuration options."
21812 },
21813 "fqn": "@aws-cdk/aws-ecs.FireLensLogDriverProps",
21814 "interfaces": [
21815 "@aws-cdk/aws-ecs.BaseLogDriverProps"
21816 ],
21817 "kind": "interface",
21818 "locationInModule": {
21819 "filename": "lib/log-drivers/firelens-log-driver.ts",
21820 "line": 13
21821 },
21822 "name": "FireLensLogDriverProps",
21823 "properties": [
21824 {
21825 "abstract": true,
21826 "docs": {
21827 "default": "- the log driver options",
21828 "stability": "stable",
21829 "summary": "The configuration options to send to the log driver."
21830 },
21831 "immutable": true,
21832 "locationInModule": {
21833 "filename": "lib/log-drivers/firelens-log-driver.ts",
21834 "line": 18
21835 },
21836 "name": "options",
21837 "optional": true,
21838 "type": {
21839 "collection": {
21840 "elementtype": {
21841 "primitive": "string"
21842 },
21843 "kind": "map"
21844 }
21845 }
21846 },
21847 {
21848 "abstract": true,
21849 "docs": {
21850 "default": "- No secret options provided.",
21851 "stability": "stable",
21852 "summary": "The secrets to pass to the log configuration."
21853 },
21854 "immutable": true,
21855 "locationInModule": {
21856 "filename": "lib/log-drivers/firelens-log-driver.ts",
21857 "line": 24
21858 },
21859 "name": "secretOptions",
21860 "optional": true,
21861 "type": {
21862 "collection": {
21863 "elementtype": {
21864 "fqn": "@aws-cdk/aws-ecs.Secret"
21865 },
21866 "kind": "map"
21867 }
21868 }
21869 }
21870 ],
21871 "symbolId": "lib/log-drivers/firelens-log-driver:FireLensLogDriverProps"
21872 },
21873 "@aws-cdk/aws-ecs.FirelensConfig": {
21874 "assembly": "@aws-cdk/aws-ecs",
21875 "datatype": true,
21876 "docs": {
21877 "stability": "stable",
21878 "summary": "Firelens Configuration https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef.",
21879 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst firelensConfig: ecs.FirelensConfig = {\n type: ecs.FirelensLogRouterType.FLUENTBIT,\n\n // the properties below are optional\n options: {\n configFileValue: 'configFileValue',\n\n // the properties below are optional\n configFileType: ecs.FirelensConfigFileType.S3,\n enableECSLogMetadata: false,\n },\n};",
21880 "custom": {
21881 "exampleMetadata": "fixture=_generated"
21882 }
21883 },
21884 "fqn": "@aws-cdk/aws-ecs.FirelensConfig",
21885 "kind": "interface",
21886 "locationInModule": {
21887 "filename": "lib/firelens-log-router.ts",
21888 "line": 71
21889 },
21890 "name": "FirelensConfig",
21891 "properties": [
21892 {
21893 "abstract": true,
21894 "docs": {
21895 "default": "- fluentbit",
21896 "stability": "stable",
21897 "summary": "The log router to use."
21898 },
21899 "immutable": true,
21900 "locationInModule": {
21901 "filename": "lib/firelens-log-router.ts",
21902 "line": 77
21903 },
21904 "name": "type",
21905 "type": {
21906 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterType"
21907 }
21908 },
21909 {
21910 "abstract": true,
21911 "docs": {
21912 "default": "- no additional options",
21913 "stability": "stable",
21914 "summary": "Firelens options."
21915 },
21916 "immutable": true,
21917 "locationInModule": {
21918 "filename": "lib/firelens-log-router.ts",
21919 "line": 83
21920 },
21921 "name": "options",
21922 "optional": true,
21923 "type": {
21924 "fqn": "@aws-cdk/aws-ecs.FirelensOptions"
21925 }
21926 }
21927 ],
21928 "symbolId": "lib/firelens-log-router:FirelensConfig"
21929 },
21930 "@aws-cdk/aws-ecs.FirelensConfigFileType": {
21931 "assembly": "@aws-cdk/aws-ecs",
21932 "docs": {
21933 "remarks": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig",
21934 "stability": "stable",
21935 "summary": "Firelens configuration file type, s3 or file path."
21936 },
21937 "fqn": "@aws-cdk/aws-ecs.FirelensConfigFileType",
21938 "kind": "enum",
21939 "locationInModule": {
21940 "filename": "lib/firelens-log-router.ts",
21941 "line": 31
21942 },
21943 "members": [
21944 {
21945 "docs": {
21946 "stability": "stable",
21947 "summary": "s3."
21948 },
21949 "name": "S3"
21950 },
21951 {
21952 "docs": {
21953 "stability": "stable",
21954 "summary": "fluentd."
21955 },
21956 "name": "FILE"
21957 }
21958 ],
21959 "name": "FirelensConfigFileType",
21960 "symbolId": "lib/firelens-log-router:FirelensConfigFileType"
21961 },
21962 "@aws-cdk/aws-ecs.FirelensLogRouter": {
21963 "assembly": "@aws-cdk/aws-ecs",
21964 "base": "@aws-cdk/aws-ecs.ContainerDefinition",
21965 "docs": {
21966 "stability": "stable",
21967 "summary": "Firelens log router.",
21968 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const containerImage: ecs.ContainerImage;\ndeclare const environmentFile: ecs.EnvironmentFile;\ndeclare const linuxParameters: ecs.LinuxParameters;\ndeclare const logDriver: ecs.LogDriver;\ndeclare const secret: ecs.Secret;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst firelensLogRouter = new ecs.FirelensLogRouter(this, 'MyFirelensLogRouter', {\n firelensConfig: {\n type: ecs.FirelensLogRouterType.FLUENTBIT,\n\n // the properties below are optional\n options: {\n configFileValue: 'configFileValue',\n\n // the properties below are optional\n configFileType: ecs.FirelensConfigFileType.S3,\n enableECSLogMetadata: false,\n },\n },\n image: containerImage,\n taskDefinition: taskDefinition,\n\n // the properties below are optional\n command: ['command'],\n containerName: 'containerName',\n cpu: 123,\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: {\n environmentKey: 'environment',\n },\n environmentFiles: [environmentFile],\n essential: false,\n extraHosts: {\n extraHostsKey: 'extraHosts',\n },\n gpuCount: 123,\n healthCheck: {\n command: ['command'],\n\n // the properties below are optional\n interval: cdk.Duration.minutes(30),\n retries: 123,\n startPeriod: cdk.Duration.minutes(30),\n timeout: cdk.Duration.minutes(30),\n },\n hostname: 'hostname',\n inferenceAcceleratorResources: ['inferenceAcceleratorResources'],\n linuxParameters: linuxParameters,\n logging: logDriver,\n memoryLimitMiB: 123,\n memoryReservationMiB: 123,\n portMappings: [{\n containerPort: 123,\n\n // the properties below are optional\n hostPort: 123,\n protocol: ecs.Protocol.TCP,\n }],\n privileged: false,\n readonlyRootFilesystem: false,\n secrets: {\n secretsKey: secret,\n },\n startTimeout: cdk.Duration.minutes(30),\n stopTimeout: cdk.Duration.minutes(30),\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n user: 'user',\n workingDirectory: 'workingDirectory',\n});",
21969 "custom": {
21970 "exampleMetadata": "fixture=_generated"
21971 }
21972 },
21973 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouter",
21974 "initializer": {
21975 "docs": {
21976 "stability": "stable",
21977 "summary": "Constructs a new instance of the FirelensLogRouter class."
21978 },
21979 "locationInModule": {
21980 "filename": "lib/firelens-log-router.ts",
21981 "line": 200
21982 },
21983 "parameters": [
21984 {
21985 "name": "scope",
21986 "type": {
21987 "fqn": "constructs.Construct"
21988 }
21989 },
21990 {
21991 "name": "id",
21992 "type": {
21993 "primitive": "string"
21994 }
21995 },
21996 {
21997 "name": "props",
21998 "type": {
21999 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterProps"
22000 }
22001 }
22002 ]
22003 },
22004 "kind": "class",
22005 "locationInModule": {
22006 "filename": "lib/firelens-log-router.ts",
22007 "line": 190
22008 },
22009 "methods": [
22010 {
22011 "docs": {
22012 "stability": "stable",
22013 "summary": "Render this container definition to a CloudFormation object."
22014 },
22015 "locationInModule": {
22016 "filename": "lib/firelens-log-router.ts",
22017 "line": 240
22018 },
22019 "name": "renderContainerDefinition",
22020 "overrides": "@aws-cdk/aws-ecs.ContainerDefinition",
22021 "parameters": [
22022 {
22023 "name": "_taskDefinition",
22024 "optional": true,
22025 "type": {
22026 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
22027 }
22028 }
22029 ],
22030 "returns": {
22031 "type": {
22032 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ContainerDefinitionProperty"
22033 }
22034 }
22035 }
22036 ],
22037 "name": "FirelensLogRouter",
22038 "properties": [
22039 {
22040 "docs": {
22041 "stability": "stable",
22042 "summary": "Firelens configuration."
22043 },
22044 "immutable": true,
22045 "locationInModule": {
22046 "filename": "lib/firelens-log-router.ts",
22047 "line": 195
22048 },
22049 "name": "firelensConfig",
22050 "type": {
22051 "fqn": "@aws-cdk/aws-ecs.FirelensConfig"
22052 }
22053 }
22054 ],
22055 "symbolId": "lib/firelens-log-router:FirelensLogRouter"
22056 },
22057 "@aws-cdk/aws-ecs.FirelensLogRouterDefinitionOptions": {
22058 "assembly": "@aws-cdk/aws-ecs",
22059 "datatype": true,
22060 "docs": {
22061 "stability": "stable",
22062 "summary": "The options for creating a firelens log router.",
22063 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const containerImage: ecs.ContainerImage;\ndeclare const environmentFile: ecs.EnvironmentFile;\ndeclare const linuxParameters: ecs.LinuxParameters;\ndeclare const logDriver: ecs.LogDriver;\ndeclare const secret: ecs.Secret;\nconst firelensLogRouterDefinitionOptions: ecs.FirelensLogRouterDefinitionOptions = {\n firelensConfig: {\n type: ecs.FirelensLogRouterType.FLUENTBIT,\n\n // the properties below are optional\n options: {\n configFileValue: 'configFileValue',\n\n // the properties below are optional\n configFileType: ecs.FirelensConfigFileType.S3,\n enableECSLogMetadata: false,\n },\n },\n image: containerImage,\n\n // the properties below are optional\n command: ['command'],\n containerName: 'containerName',\n cpu: 123,\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: {\n environmentKey: 'environment',\n },\n environmentFiles: [environmentFile],\n essential: false,\n extraHosts: {\n extraHostsKey: 'extraHosts',\n },\n gpuCount: 123,\n healthCheck: {\n command: ['command'],\n\n // the properties below are optional\n interval: cdk.Duration.minutes(30),\n retries: 123,\n startPeriod: cdk.Duration.minutes(30),\n timeout: cdk.Duration.minutes(30),\n },\n hostname: 'hostname',\n inferenceAcceleratorResources: ['inferenceAcceleratorResources'],\n linuxParameters: linuxParameters,\n logging: logDriver,\n memoryLimitMiB: 123,\n memoryReservationMiB: 123,\n portMappings: [{\n containerPort: 123,\n\n // the properties below are optional\n hostPort: 123,\n protocol: ecs.Protocol.TCP,\n }],\n privileged: false,\n readonlyRootFilesystem: false,\n secrets: {\n secretsKey: secret,\n },\n startTimeout: cdk.Duration.minutes(30),\n stopTimeout: cdk.Duration.minutes(30),\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n user: 'user',\n workingDirectory: 'workingDirectory',\n};",
22064 "custom": {
22065 "exampleMetadata": "fixture=_generated"
22066 }
22067 },
22068 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterDefinitionOptions",
22069 "interfaces": [
22070 "@aws-cdk/aws-ecs.ContainerDefinitionOptions"
22071 ],
22072 "kind": "interface",
22073 "locationInModule": {
22074 "filename": "lib/firelens-log-router.ts",
22075 "line": 99
22076 },
22077 "name": "FirelensLogRouterDefinitionOptions",
22078 "properties": [
22079 {
22080 "abstract": true,
22081 "docs": {
22082 "stability": "stable",
22083 "summary": "Firelens configuration."
22084 },
22085 "immutable": true,
22086 "locationInModule": {
22087 "filename": "lib/firelens-log-router.ts",
22088 "line": 103
22089 },
22090 "name": "firelensConfig",
22091 "type": {
22092 "fqn": "@aws-cdk/aws-ecs.FirelensConfig"
22093 }
22094 }
22095 ],
22096 "symbolId": "lib/firelens-log-router:FirelensLogRouterDefinitionOptions"
22097 },
22098 "@aws-cdk/aws-ecs.FirelensLogRouterProps": {
22099 "assembly": "@aws-cdk/aws-ecs",
22100 "datatype": true,
22101 "docs": {
22102 "stability": "stable",
22103 "summary": "The properties in a firelens log router.",
22104 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const containerImage: ecs.ContainerImage;\ndeclare const environmentFile: ecs.EnvironmentFile;\ndeclare const linuxParameters: ecs.LinuxParameters;\ndeclare const logDriver: ecs.LogDriver;\ndeclare const secret: ecs.Secret;\ndeclare const taskDefinition: ecs.TaskDefinition;\nconst firelensLogRouterProps: ecs.FirelensLogRouterProps = {\n firelensConfig: {\n type: ecs.FirelensLogRouterType.FLUENTBIT,\n\n // the properties below are optional\n options: {\n configFileValue: 'configFileValue',\n\n // the properties below are optional\n configFileType: ecs.FirelensConfigFileType.S3,\n enableECSLogMetadata: false,\n },\n },\n image: containerImage,\n taskDefinition: taskDefinition,\n\n // the properties below are optional\n command: ['command'],\n containerName: 'containerName',\n cpu: 123,\n disableNetworking: false,\n dnsSearchDomains: ['dnsSearchDomains'],\n dnsServers: ['dnsServers'],\n dockerLabels: {\n dockerLabelsKey: 'dockerLabels',\n },\n dockerSecurityOptions: ['dockerSecurityOptions'],\n entryPoint: ['entryPoint'],\n environment: {\n environmentKey: 'environment',\n },\n environmentFiles: [environmentFile],\n essential: false,\n extraHosts: {\n extraHostsKey: 'extraHosts',\n },\n gpuCount: 123,\n healthCheck: {\n command: ['command'],\n\n // the properties below are optional\n interval: cdk.Duration.minutes(30),\n retries: 123,\n startPeriod: cdk.Duration.minutes(30),\n timeout: cdk.Duration.minutes(30),\n },\n hostname: 'hostname',\n inferenceAcceleratorResources: ['inferenceAcceleratorResources'],\n linuxParameters: linuxParameters,\n logging: logDriver,\n memoryLimitMiB: 123,\n memoryReservationMiB: 123,\n portMappings: [{\n containerPort: 123,\n\n // the properties below are optional\n hostPort: 123,\n protocol: ecs.Protocol.TCP,\n }],\n privileged: false,\n readonlyRootFilesystem: false,\n secrets: {\n secretsKey: secret,\n },\n startTimeout: cdk.Duration.minutes(30),\n stopTimeout: cdk.Duration.minutes(30),\n systemControls: [{\n namespace: 'namespace',\n value: 'value',\n }],\n user: 'user',\n workingDirectory: 'workingDirectory',\n};",
22105 "custom": {
22106 "exampleMetadata": "fixture=_generated"
22107 }
22108 },
22109 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterProps",
22110 "interfaces": [
22111 "@aws-cdk/aws-ecs.ContainerDefinitionProps"
22112 ],
22113 "kind": "interface",
22114 "locationInModule": {
22115 "filename": "lib/firelens-log-router.ts",
22116 "line": 89
22117 },
22118 "name": "FirelensLogRouterProps",
22119 "properties": [
22120 {
22121 "abstract": true,
22122 "docs": {
22123 "stability": "stable",
22124 "summary": "Firelens configuration."
22125 },
22126 "immutable": true,
22127 "locationInModule": {
22128 "filename": "lib/firelens-log-router.ts",
22129 "line": 93
22130 },
22131 "name": "firelensConfig",
22132 "type": {
22133 "fqn": "@aws-cdk/aws-ecs.FirelensConfig"
22134 }
22135 }
22136 ],
22137 "symbolId": "lib/firelens-log-router:FirelensLogRouterProps"
22138 },
22139 "@aws-cdk/aws-ecs.FirelensLogRouterType": {
22140 "assembly": "@aws-cdk/aws-ecs",
22141 "docs": {
22142 "remarks": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html",
22143 "stability": "stable",
22144 "summary": "Firelens log router type, fluentbit or fluentd."
22145 },
22146 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterType",
22147 "kind": "enum",
22148 "locationInModule": {
22149 "filename": "lib/firelens-log-router.ts",
22150 "line": 15
22151 },
22152 "members": [
22153 {
22154 "docs": {
22155 "stability": "stable",
22156 "summary": "fluentbit."
22157 },
22158 "name": "FLUENTBIT"
22159 },
22160 {
22161 "docs": {
22162 "stability": "stable",
22163 "summary": "fluentd."
22164 },
22165 "name": "FLUENTD"
22166 }
22167 ],
22168 "name": "FirelensLogRouterType",
22169 "symbolId": "lib/firelens-log-router:FirelensLogRouterType"
22170 },
22171 "@aws-cdk/aws-ecs.FirelensOptions": {
22172 "assembly": "@aws-cdk/aws-ecs",
22173 "datatype": true,
22174 "docs": {
22175 "stability": "stable",
22176 "summary": "The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.",
22177 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst firelensOptions: ecs.FirelensOptions = {\n configFileValue: 'configFileValue',\n\n // the properties below are optional\n configFileType: ecs.FirelensConfigFileType.S3,\n enableECSLogMetadata: false,\n};",
22178 "custom": {
22179 "exampleMetadata": "fixture=_generated"
22180 }
22181 },
22182 "fqn": "@aws-cdk/aws-ecs.FirelensOptions",
22183 "kind": "interface",
22184 "locationInModule": {
22185 "filename": "lib/firelens-log-router.ts",
22186 "line": 47
22187 },
22188 "name": "FirelensOptions",
22189 "properties": [
22190 {
22191 "abstract": true,
22192 "docs": {
22193 "stability": "stable",
22194 "summary": "Custom configuration file, S3 ARN or a file path."
22195 },
22196 "immutable": true,
22197 "locationInModule": {
22198 "filename": "lib/firelens-log-router.ts",
22199 "line": 64
22200 },
22201 "name": "configFileValue",
22202 "type": {
22203 "primitive": "string"
22204 }
22205 },
22206 {
22207 "abstract": true,
22208 "docs": {
22209 "default": "- determined by checking configFileValue with S3 ARN.",
22210 "stability": "stable",
22211 "summary": "Custom configuration file, s3 or file."
22212 },
22213 "immutable": true,
22214 "locationInModule": {
22215 "filename": "lib/firelens-log-router.ts",
22216 "line": 59
22217 },
22218 "name": "configFileType",
22219 "optional": true,
22220 "type": {
22221 "fqn": "@aws-cdk/aws-ecs.FirelensConfigFileType"
22222 }
22223 },
22224 {
22225 "abstract": true,
22226 "docs": {
22227 "default": "- true",
22228 "remarks": "You can disable this action by setting enable-ecs-log-metadata to false.",
22229 "stability": "stable",
22230 "summary": "By default, Amazon ECS adds additional fields in your log entries that help identify the source of the logs."
22231 },
22232 "immutable": true,
22233 "locationInModule": {
22234 "filename": "lib/firelens-log-router.ts",
22235 "line": 53
22236 },
22237 "name": "enableECSLogMetadata",
22238 "optional": true,
22239 "type": {
22240 "primitive": "boolean"
22241 }
22242 }
22243 ],
22244 "symbolId": "lib/firelens-log-router:FirelensOptions"
22245 },
22246 "@aws-cdk/aws-ecs.FluentdLogDriver": {
22247 "assembly": "@aws-cdk/aws-ecs",
22248 "base": "@aws-cdk/aws-ecs.LogDriver",
22249 "docs": {
22250 "stability": "stable",
22251 "summary": "A log driver that sends log information to journald Logs.",
22252 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\nconst fluentdLogDriver = new ecs.FluentdLogDriver(/* all optional props */ {\n address: 'address',\n asyncConnect: false,\n bufferLimit: 123,\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n maxRetries: 123,\n retryWait: cdk.Duration.minutes(30),\n subSecondPrecision: false,\n tag: 'tag',\n});",
22253 "custom": {
22254 "exampleMetadata": "fixture=_generated"
22255 }
22256 },
22257 "fqn": "@aws-cdk/aws-ecs.FluentdLogDriver",
22258 "initializer": {
22259 "docs": {
22260 "stability": "stable",
22261 "summary": "Constructs a new instance of the FluentdLogDriver class."
22262 },
22263 "locationInModule": {
22264 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22265 "line": 72
22266 },
22267 "parameters": [
22268 {
22269 "docs": {
22270 "summary": "the fluentd log driver configuration options."
22271 },
22272 "name": "props",
22273 "optional": true,
22274 "type": {
22275 "fqn": "@aws-cdk/aws-ecs.FluentdLogDriverProps"
22276 }
22277 }
22278 ]
22279 },
22280 "kind": "class",
22281 "locationInModule": {
22282 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22283 "line": 66
22284 },
22285 "methods": [
22286 {
22287 "docs": {
22288 "stability": "stable",
22289 "summary": "Called when the log driver is configured on a container."
22290 },
22291 "locationInModule": {
22292 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22293 "line": 79
22294 },
22295 "name": "bind",
22296 "overrides": "@aws-cdk/aws-ecs.LogDriver",
22297 "parameters": [
22298 {
22299 "name": "_scope",
22300 "type": {
22301 "fqn": "@aws-cdk/core.Construct"
22302 }
22303 },
22304 {
22305 "name": "_containerDefinition",
22306 "type": {
22307 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
22308 }
22309 }
22310 ],
22311 "returns": {
22312 "type": {
22313 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
22314 }
22315 }
22316 }
22317 ],
22318 "name": "FluentdLogDriver",
22319 "symbolId": "lib/log-drivers/fluentd-log-driver:FluentdLogDriver"
22320 },
22321 "@aws-cdk/aws-ecs.FluentdLogDriverProps": {
22322 "assembly": "@aws-cdk/aws-ecs",
22323 "datatype": true,
22324 "docs": {
22325 "remarks": "[Source](https://docs.docker.com/config/containers/logging/fluentd/)",
22326 "stability": "stable",
22327 "summary": "Specifies the fluentd log driver configuration options.",
22328 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\nconst fluentdLogDriverProps: ecs.FluentdLogDriverProps = {\n address: 'address',\n asyncConnect: false,\n bufferLimit: 123,\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n maxRetries: 123,\n retryWait: cdk.Duration.minutes(30),\n subSecondPrecision: false,\n tag: 'tag',\n};",
22329 "custom": {
22330 "exampleMetadata": "fixture=_generated"
22331 }
22332 },
22333 "fqn": "@aws-cdk/aws-ecs.FluentdLogDriverProps",
22334 "interfaces": [
22335 "@aws-cdk/aws-ecs.BaseLogDriverProps"
22336 ],
22337 "kind": "interface",
22338 "locationInModule": {
22339 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22340 "line": 16
22341 },
22342 "name": "FluentdLogDriverProps",
22343 "properties": [
22344 {
22345 "abstract": true,
22346 "docs": {
22347 "default": "- address not set.",
22348 "remarks": "Supply the\naddress option to connect to a different address. tcp(default) and unix\nsockets are supported.",
22349 "stability": "stable",
22350 "summary": "By default, the logging driver connects to localhost:24224."
22351 },
22352 "immutable": true,
22353 "locationInModule": {
22354 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22355 "line": 24
22356 },
22357 "name": "address",
22358 "optional": true,
22359 "type": {
22360 "primitive": "string"
22361 }
22362 },
22363 {
22364 "abstract": true,
22365 "docs": {
22366 "default": "- false",
22367 "remarks": "Messages are buffered until\nthe connection is established.",
22368 "stability": "stable",
22369 "summary": "Docker connects to Fluentd in the background."
22370 },
22371 "immutable": true,
22372 "locationInModule": {
22373 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22374 "line": 32
22375 },
22376 "name": "asyncConnect",
22377 "optional": true,
22378 "type": {
22379 "primitive": "boolean"
22380 }
22381 },
22382 {
22383 "abstract": true,
22384 "docs": {
22385 "default": "- The amount of RAM available to the container.",
22386 "stability": "stable",
22387 "summary": "The amount of data to buffer before flushing to disk."
22388 },
22389 "immutable": true,
22390 "locationInModule": {
22391 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22392 "line": 39
22393 },
22394 "name": "bufferLimit",
22395 "optional": true,
22396 "type": {
22397 "primitive": "number"
22398 }
22399 },
22400 {
22401 "abstract": true,
22402 "docs": {
22403 "default": "- 4294967295 (2**32 - 1).",
22404 "stability": "stable",
22405 "summary": "The maximum number of retries."
22406 },
22407 "immutable": true,
22408 "locationInModule": {
22409 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22410 "line": 53
22411 },
22412 "name": "maxRetries",
22413 "optional": true,
22414 "type": {
22415 "primitive": "number"
22416 }
22417 },
22418 {
22419 "abstract": true,
22420 "docs": {
22421 "default": "- 1 second",
22422 "stability": "stable",
22423 "summary": "How long to wait between retries."
22424 },
22425 "immutable": true,
22426 "locationInModule": {
22427 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22428 "line": 46
22429 },
22430 "name": "retryWait",
22431 "optional": true,
22432 "type": {
22433 "fqn": "@aws-cdk/core.Duration"
22434 }
22435 },
22436 {
22437 "abstract": true,
22438 "docs": {
22439 "default": "- false",
22440 "stability": "stable",
22441 "summary": "Generates event logs in nanosecond resolution."
22442 },
22443 "immutable": true,
22444 "locationInModule": {
22445 "filename": "lib/log-drivers/fluentd-log-driver.ts",
22446 "line": 60
22447 },
22448 "name": "subSecondPrecision",
22449 "optional": true,
22450 "type": {
22451 "primitive": "boolean"
22452 }
22453 }
22454 ],
22455 "symbolId": "lib/log-drivers/fluentd-log-driver:FluentdLogDriverProps"
22456 },
22457 "@aws-cdk/aws-ecs.GelfCompressionType": {
22458 "assembly": "@aws-cdk/aws-ecs",
22459 "docs": {
22460 "stability": "stable",
22461 "summary": "The type of compression the GELF driver uses to compress each log message."
22462 },
22463 "fqn": "@aws-cdk/aws-ecs.GelfCompressionType",
22464 "kind": "enum",
22465 "locationInModule": {
22466 "filename": "lib/log-drivers/gelf-log-driver.ts",
22467 "line": 14
22468 },
22469 "members": [
22470 {
22471 "docs": {
22472 "stability": "stable"
22473 },
22474 "name": "GZIP"
22475 },
22476 {
22477 "docs": {
22478 "stability": "stable"
22479 },
22480 "name": "ZLIB"
22481 },
22482 {
22483 "docs": {
22484 "stability": "stable"
22485 },
22486 "name": "NONE"
22487 }
22488 ],
22489 "name": "GelfCompressionType",
22490 "symbolId": "lib/log-drivers/gelf-log-driver:GelfCompressionType"
22491 },
22492 "@aws-cdk/aws-ecs.GelfLogDriver": {
22493 "assembly": "@aws-cdk/aws-ecs",
22494 "base": "@aws-cdk/aws-ecs.LogDriver",
22495 "docs": {
22496 "stability": "stable",
22497 "summary": "A log driver that sends log information to journald Logs.",
22498 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\nconst gelfLogDriver = new ecs.GelfLogDriver({\n address: 'address',\n\n // the properties below are optional\n compressionLevel: 123,\n compressionType: ecs.GelfCompressionType.GZIP,\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n tag: 'tag',\n tcpMaxReconnect: 123,\n tcpReconnectDelay: cdk.Duration.minutes(30),\n});",
22499 "custom": {
22500 "exampleMetadata": "fixture=_generated"
22501 }
22502 },
22503 "fqn": "@aws-cdk/aws-ecs.GelfLogDriver",
22504 "initializer": {
22505 "docs": {
22506 "stability": "stable",
22507 "summary": "Constructs a new instance of the GelfLogDriver class."
22508 },
22509 "locationInModule": {
22510 "filename": "lib/log-drivers/gelf-log-driver.ts",
22511 "line": 75
22512 },
22513 "parameters": [
22514 {
22515 "docs": {
22516 "summary": "the gelf log driver configuration options."
22517 },
22518 "name": "props",
22519 "type": {
22520 "fqn": "@aws-cdk/aws-ecs.GelfLogDriverProps"
22521 }
22522 }
22523 ]
22524 },
22525 "kind": "class",
22526 "locationInModule": {
22527 "filename": "lib/log-drivers/gelf-log-driver.ts",
22528 "line": 69
22529 },
22530 "methods": [
22531 {
22532 "docs": {
22533 "stability": "stable",
22534 "summary": "Called when the log driver is configured on a container."
22535 },
22536 "locationInModule": {
22537 "filename": "lib/log-drivers/gelf-log-driver.ts",
22538 "line": 91
22539 },
22540 "name": "bind",
22541 "overrides": "@aws-cdk/aws-ecs.LogDriver",
22542 "parameters": [
22543 {
22544 "name": "_scope",
22545 "type": {
22546 "fqn": "@aws-cdk/core.Construct"
22547 }
22548 },
22549 {
22550 "name": "_containerDefinition",
22551 "type": {
22552 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
22553 }
22554 }
22555 ],
22556 "returns": {
22557 "type": {
22558 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
22559 }
22560 }
22561 }
22562 ],
22563 "name": "GelfLogDriver",
22564 "symbolId": "lib/log-drivers/gelf-log-driver:GelfLogDriver"
22565 },
22566 "@aws-cdk/aws-ecs.GelfLogDriverProps": {
22567 "assembly": "@aws-cdk/aws-ecs",
22568 "datatype": true,
22569 "docs": {
22570 "custom": {
22571 "exampleMetadata": "infused"
22572 },
22573 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.gelf({ address: 'my-gelf-address' }),\n});",
22574 "remarks": "[Source](https://docs.docker.com/config/containers/logging/gelf/)",
22575 "stability": "stable",
22576 "summary": "Specifies the journald log driver configuration options."
22577 },
22578 "fqn": "@aws-cdk/aws-ecs.GelfLogDriverProps",
22579 "interfaces": [
22580 "@aws-cdk/aws-ecs.BaseLogDriverProps"
22581 ],
22582 "kind": "interface",
22583 "locationInModule": {
22584 "filename": "lib/log-drivers/gelf-log-driver.ts",
22585 "line": 25
22586 },
22587 "name": "GelfLogDriverProps",
22588 "properties": [
22589 {
22590 "abstract": true,
22591 "docs": {
22592 "remarks": "tcp and udp are the only supported URI\nspecifier and you must specify the port.",
22593 "stability": "stable",
22594 "summary": "The address of the GELF server."
22595 },
22596 "immutable": true,
22597 "locationInModule": {
22598 "filename": "lib/log-drivers/gelf-log-driver.ts",
22599 "line": 30
22600 },
22601 "name": "address",
22602 "type": {
22603 "primitive": "string"
22604 }
22605 },
22606 {
22607 "abstract": true,
22608 "docs": {
22609 "default": "- 1",
22610 "remarks": "An integer in the range of -1 to 9 (BestCompression). Higher levels provide more\ncompression at lower speed. Either -1 or 0 disables compression.",
22611 "stability": "stable",
22612 "summary": "UDP Only The level of compression when gzip or zlib is the gelf-compression-type."
22613 },
22614 "immutable": true,
22615 "locationInModule": {
22616 "filename": "lib/log-drivers/gelf-log-driver.ts",
22617 "line": 47
22618 },
22619 "name": "compressionLevel",
22620 "optional": true,
22621 "type": {
22622 "primitive": "number"
22623 }
22624 },
22625 {
22626 "abstract": true,
22627 "docs": {
22628 "default": "- gzip",
22629 "remarks": "Allowed values are gzip, zlib and none.",
22630 "stability": "stable",
22631 "summary": "UDP Only The type of compression the GELF driver uses to compress each log message."
22632 },
22633 "immutable": true,
22634 "locationInModule": {
22635 "filename": "lib/log-drivers/gelf-log-driver.ts",
22636 "line": 38
22637 },
22638 "name": "compressionType",
22639 "optional": true,
22640 "type": {
22641 "fqn": "@aws-cdk/aws-ecs.GelfCompressionType"
22642 }
22643 },
22644 {
22645 "abstract": true,
22646 "docs": {
22647 "default": "- 3",
22648 "remarks": "A positive integer.",
22649 "stability": "stable",
22650 "summary": "TCP Only The maximum number of reconnection attempts when the connection drop."
22651 },
22652 "immutable": true,
22653 "locationInModule": {
22654 "filename": "lib/log-drivers/gelf-log-driver.ts",
22655 "line": 55
22656 },
22657 "name": "tcpMaxReconnect",
22658 "optional": true,
22659 "type": {
22660 "primitive": "number"
22661 }
22662 },
22663 {
22664 "abstract": true,
22665 "docs": {
22666 "default": "- 1",
22667 "remarks": "A positive integer.",
22668 "stability": "stable",
22669 "summary": "TCP Only The number of seconds to wait between reconnection attempts."
22670 },
22671 "immutable": true,
22672 "locationInModule": {
22673 "filename": "lib/log-drivers/gelf-log-driver.ts",
22674 "line": 63
22675 },
22676 "name": "tcpReconnectDelay",
22677 "optional": true,
22678 "type": {
22679 "fqn": "@aws-cdk/core.Duration"
22680 }
22681 }
22682 ],
22683 "symbolId": "lib/log-drivers/gelf-log-driver:GelfLogDriverProps"
22684 },
22685 "@aws-cdk/aws-ecs.GenericLogDriver": {
22686 "assembly": "@aws-cdk/aws-ecs",
22687 "base": "@aws-cdk/aws-ecs.LogDriver",
22688 "docs": {
22689 "custom": {
22690 "exampleMetadata": "infused"
22691 },
22692 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: new ecs.GenericLogDriver({\n logDriver: 'fluentd',\n options: {\n tag: 'example-tag',\n },\n }),\n});",
22693 "stability": "stable",
22694 "summary": "A log driver that sends logs to the specified driver."
22695 },
22696 "fqn": "@aws-cdk/aws-ecs.GenericLogDriver",
22697 "initializer": {
22698 "docs": {
22699 "stability": "stable",
22700 "summary": "Constructs a new instance of the GenericLogDriver class."
22701 },
22702 "locationInModule": {
22703 "filename": "lib/log-drivers/generic-log-driver.ts",
22704 "line": 69
22705 },
22706 "parameters": [
22707 {
22708 "docs": {
22709 "summary": "the generic log driver configuration options."
22710 },
22711 "name": "props",
22712 "type": {
22713 "fqn": "@aws-cdk/aws-ecs.GenericLogDriverProps"
22714 }
22715 }
22716 ]
22717 },
22718 "kind": "class",
22719 "locationInModule": {
22720 "filename": "lib/log-drivers/generic-log-driver.ts",
22721 "line": 42
22722 },
22723 "methods": [
22724 {
22725 "docs": {
22726 "stability": "stable",
22727 "summary": "Called when the log driver is configured on a container."
22728 },
22729 "locationInModule": {
22730 "filename": "lib/log-drivers/generic-log-driver.ts",
22731 "line": 80
22732 },
22733 "name": "bind",
22734 "overrides": "@aws-cdk/aws-ecs.LogDriver",
22735 "parameters": [
22736 {
22737 "name": "_scope",
22738 "type": {
22739 "fqn": "@aws-cdk/core.Construct"
22740 }
22741 },
22742 {
22743 "name": "_containerDefinition",
22744 "type": {
22745 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
22746 }
22747 }
22748 ],
22749 "returns": {
22750 "type": {
22751 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
22752 }
22753 }
22754 }
22755 ],
22756 "name": "GenericLogDriver",
22757 "symbolId": "lib/log-drivers/generic-log-driver:GenericLogDriver"
22758 },
22759 "@aws-cdk/aws-ecs.GenericLogDriverProps": {
22760 "assembly": "@aws-cdk/aws-ecs",
22761 "datatype": true,
22762 "docs": {
22763 "custom": {
22764 "exampleMetadata": "infused"
22765 },
22766 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: new ecs.GenericLogDriver({\n logDriver: 'fluentd',\n options: {\n tag: 'example-tag',\n },\n }),\n});",
22767 "stability": "stable",
22768 "summary": "The configuration to use when creating a log driver."
22769 },
22770 "fqn": "@aws-cdk/aws-ecs.GenericLogDriverProps",
22771 "kind": "interface",
22772 "locationInModule": {
22773 "filename": "lib/log-drivers/generic-log-driver.ts",
22774 "line": 12
22775 },
22776 "name": "GenericLogDriverProps",
22777 "properties": [
22778 {
22779 "abstract": true,
22780 "docs": {
22781 "remarks": "The valid values listed for this parameter are log drivers\nthat the Amazon ECS container agent can communicate with by default.\n\nFor tasks using the Fargate launch type, the supported log drivers are awslogs and splunk.\nFor tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.\n\nFor more information about using the awslogs log driver, see\n[Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)\nin the Amazon Elastic Container Service Developer Guide.",
22782 "stability": "stable",
22783 "summary": "The log driver to use for the container."
22784 },
22785 "immutable": true,
22786 "locationInModule": {
22787 "filename": "lib/log-drivers/generic-log-driver.ts",
22788 "line": 24
22789 },
22790 "name": "logDriver",
22791 "type": {
22792 "primitive": "string"
22793 }
22794 },
22795 {
22796 "abstract": true,
22797 "docs": {
22798 "default": "- the log driver options.",
22799 "stability": "stable",
22800 "summary": "The configuration options to send to the log driver."
22801 },
22802 "immutable": true,
22803 "locationInModule": {
22804 "filename": "lib/log-drivers/generic-log-driver.ts",
22805 "line": 30
22806 },
22807 "name": "options",
22808 "optional": true,
22809 "type": {
22810 "collection": {
22811 "elementtype": {
22812 "primitive": "string"
22813 },
22814 "kind": "map"
22815 }
22816 }
22817 },
22818 {
22819 "abstract": true,
22820 "docs": {
22821 "default": "- no secret options provided.",
22822 "stability": "stable",
22823 "summary": "The secrets to pass to the log configuration."
22824 },
22825 "immutable": true,
22826 "locationInModule": {
22827 "filename": "lib/log-drivers/generic-log-driver.ts",
22828 "line": 36
22829 },
22830 "name": "secretOptions",
22831 "optional": true,
22832 "type": {
22833 "collection": {
22834 "elementtype": {
22835 "fqn": "@aws-cdk/aws-ecs.Secret"
22836 },
22837 "kind": "map"
22838 }
22839 }
22840 }
22841 ],
22842 "symbolId": "lib/log-drivers/generic-log-driver:GenericLogDriverProps"
22843 },
22844 "@aws-cdk/aws-ecs.HealthCheck": {
22845 "assembly": "@aws-cdk/aws-ecs",
22846 "datatype": true,
22847 "docs": {
22848 "custom": {
22849 "exampleMetadata": "infused"
22850 },
22851 "example": "declare const vpc: ec2.Vpc;\ndeclare const securityGroup: ec2.SecurityGroup;\nconst queueProcessingFargateService = new ecsPatterns.QueueProcessingFargateService(this, 'Service', {\n vpc,\n memoryLimitMiB: 512,\n image: ecs.ContainerImage.fromRegistry('test'),\n healthCheck: {\n command: [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ],\n // the properties below are optional\n interval: Duration.minutes(30),\n retries: 123,\n startPeriod: Duration.minutes(30),\n timeout: Duration.minutes(30),\n },\n});",
22852 "stability": "stable",
22853 "summary": "The health check command and associated configuration parameters for the container."
22854 },
22855 "fqn": "@aws-cdk/aws-ecs.HealthCheck",
22856 "kind": "interface",
22857 "locationInModule": {
22858 "filename": "lib/container-definition.ts",
22859 "line": 748
22860 },
22861 "name": "HealthCheck",
22862 "properties": [
22863 {
22864 "abstract": true,
22865 "docs": {
22866 "remarks": "The string array must start with CMD to execute the command arguments directly, or\nCMD-SHELL to run the command with the container's default shell.\n\nFor example: [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]",
22867 "stability": "stable",
22868 "summary": "A string array representing the command that the container runs to determine if it is healthy."
22869 },
22870 "immutable": true,
22871 "locationInModule": {
22872 "filename": "lib/container-definition.ts",
22873 "line": 756
22874 },
22875 "name": "command",
22876 "type": {
22877 "collection": {
22878 "elementtype": {
22879 "primitive": "string"
22880 },
22881 "kind": "array"
22882 }
22883 }
22884 },
22885 {
22886 "abstract": true,
22887 "docs": {
22888 "default": "Duration.seconds(30)",
22889 "remarks": "You may specify between 5 and 300 seconds.",
22890 "stability": "stable",
22891 "summary": "The time period in seconds between each health check execution."
22892 },
22893 "immutable": true,
22894 "locationInModule": {
22895 "filename": "lib/container-definition.ts",
22896 "line": 765
22897 },
22898 "name": "interval",
22899 "optional": true,
22900 "type": {
22901 "fqn": "@aws-cdk/core.Duration"
22902 }
22903 },
22904 {
22905 "abstract": true,
22906 "docs": {
22907 "default": "3",
22908 "remarks": "You may specify between 1 and 10 retries.",
22909 "stability": "stable",
22910 "summary": "The number of times to retry a failed health check before the container is considered unhealthy."
22911 },
22912 "immutable": true,
22913 "locationInModule": {
22914 "filename": "lib/container-definition.ts",
22915 "line": 774
22916 },
22917 "name": "retries",
22918 "optional": true,
22919 "type": {
22920 "primitive": "number"
22921 }
22922 },
22923 {
22924 "abstract": true,
22925 "docs": {
22926 "default": "No start period",
22927 "remarks": "You may specify between 0 and 300 seconds.",
22928 "stability": "stable",
22929 "summary": "The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries."
22930 },
22931 "immutable": true,
22932 "locationInModule": {
22933 "filename": "lib/container-definition.ts",
22934 "line": 784
22935 },
22936 "name": "startPeriod",
22937 "optional": true,
22938 "type": {
22939 "fqn": "@aws-cdk/core.Duration"
22940 }
22941 },
22942 {
22943 "abstract": true,
22944 "docs": {
22945 "default": "Duration.seconds(5)",
22946 "remarks": "You may specify between 2 and 60 seconds.",
22947 "stability": "stable",
22948 "summary": "The time period in seconds to wait for a health check to succeed before it is considered a failure."
22949 },
22950 "immutable": true,
22951 "locationInModule": {
22952 "filename": "lib/container-definition.ts",
22953 "line": 793
22954 },
22955 "name": "timeout",
22956 "optional": true,
22957 "type": {
22958 "fqn": "@aws-cdk/core.Duration"
22959 }
22960 }
22961 ],
22962 "symbolId": "lib/container-definition:HealthCheck"
22963 },
22964 "@aws-cdk/aws-ecs.Host": {
22965 "assembly": "@aws-cdk/aws-ecs",
22966 "datatype": true,
22967 "docs": {
22968 "stability": "stable",
22969 "summary": "The details on a container instance bind mount host volume.",
22970 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst host: ecs.Host = {\n sourcePath: 'sourcePath',\n};",
22971 "custom": {
22972 "exampleMetadata": "fixture=_generated"
22973 }
22974 },
22975 "fqn": "@aws-cdk/aws-ecs.Host",
22976 "kind": "interface",
22977 "locationInModule": {
22978 "filename": "lib/base/task-definition.ts",
22979 "line": 900
22980 },
22981 "name": "Host",
22982 "properties": [
22983 {
22984 "abstract": true,
22985 "docs": {
22986 "remarks": "If the sourcePath value does not exist on the host container instance, the Docker daemon creates it.\nIf the location does exist, the contents of the source path folder are exported.\n\nThis property is not supported for tasks that use the Fargate launch type.",
22987 "stability": "stable",
22988 "summary": "Specifies the path on the host container instance that is presented to the container."
22989 },
22990 "immutable": true,
22991 "locationInModule": {
22992 "filename": "lib/base/task-definition.ts",
22993 "line": 908
22994 },
22995 "name": "sourcePath",
22996 "optional": true,
22997 "type": {
22998 "primitive": "string"
22999 }
23000 }
23001 ],
23002 "symbolId": "lib/base/task-definition:Host"
23003 },
23004 "@aws-cdk/aws-ecs.IBaseService": {
23005 "assembly": "@aws-cdk/aws-ecs",
23006 "docs": {
23007 "stability": "stable",
23008 "summary": "The interface for BaseService."
23009 },
23010 "fqn": "@aws-cdk/aws-ecs.IBaseService",
23011 "interfaces": [
23012 "@aws-cdk/aws-ecs.IService"
23013 ],
23014 "kind": "interface",
23015 "locationInModule": {
23016 "filename": "lib/base/base-service.ts",
23017 "line": 306
23018 },
23019 "name": "IBaseService",
23020 "properties": [
23021 {
23022 "abstract": true,
23023 "docs": {
23024 "stability": "stable",
23025 "summary": "The cluster that hosts the service."
23026 },
23027 "immutable": true,
23028 "locationInModule": {
23029 "filename": "lib/base/base-service.ts",
23030 "line": 310
23031 },
23032 "name": "cluster",
23033 "type": {
23034 "fqn": "@aws-cdk/aws-ecs.ICluster"
23035 }
23036 }
23037 ],
23038 "symbolId": "lib/base/base-service:IBaseService"
23039 },
23040 "@aws-cdk/aws-ecs.ICluster": {
23041 "assembly": "@aws-cdk/aws-ecs",
23042 "docs": {
23043 "stability": "stable",
23044 "summary": "A regional grouping of one or more container instances on which you can run tasks and services."
23045 },
23046 "fqn": "@aws-cdk/aws-ecs.ICluster",
23047 "interfaces": [
23048 "@aws-cdk/core.IResource"
23049 ],
23050 "kind": "interface",
23051 "locationInModule": {
23052 "filename": "lib/cluster.ts",
23053 "line": 611
23054 },
23055 "name": "ICluster",
23056 "properties": [
23057 {
23058 "abstract": true,
23059 "docs": {
23060 "custom": {
23061 "attribute": "true"
23062 },
23063 "stability": "stable",
23064 "summary": "The Amazon Resource Name (ARN) that identifies the cluster."
23065 },
23066 "immutable": true,
23067 "locationInModule": {
23068 "filename": "lib/cluster.ts",
23069 "line": 622
23070 },
23071 "name": "clusterArn",
23072 "type": {
23073 "primitive": "string"
23074 }
23075 },
23076 {
23077 "abstract": true,
23078 "docs": {
23079 "custom": {
23080 "attribute": "true"
23081 },
23082 "stability": "stable",
23083 "summary": "The name of the cluster."
23084 },
23085 "immutable": true,
23086 "locationInModule": {
23087 "filename": "lib/cluster.ts",
23088 "line": 616
23089 },
23090 "name": "clusterName",
23091 "type": {
23092 "primitive": "string"
23093 }
23094 },
23095 {
23096 "abstract": true,
23097 "docs": {
23098 "stability": "stable",
23099 "summary": "Manage the allowed network connections for the cluster with Security Groups."
23100 },
23101 "immutable": true,
23102 "locationInModule": {
23103 "filename": "lib/cluster.ts",
23104 "line": 632
23105 },
23106 "name": "connections",
23107 "type": {
23108 "fqn": "@aws-cdk/aws-ec2.Connections"
23109 }
23110 },
23111 {
23112 "abstract": true,
23113 "docs": {
23114 "stability": "stable",
23115 "summary": "Specifies whether the cluster has EC2 instance capacity."
23116 },
23117 "immutable": true,
23118 "locationInModule": {
23119 "filename": "lib/cluster.ts",
23120 "line": 637
23121 },
23122 "name": "hasEc2Capacity",
23123 "type": {
23124 "primitive": "boolean"
23125 }
23126 },
23127 {
23128 "abstract": true,
23129 "docs": {
23130 "stability": "stable",
23131 "summary": "The VPC associated with the cluster."
23132 },
23133 "immutable": true,
23134 "locationInModule": {
23135 "filename": "lib/cluster.ts",
23136 "line": 627
23137 },
23138 "name": "vpc",
23139 "type": {
23140 "fqn": "@aws-cdk/aws-ec2.IVpc"
23141 }
23142 },
23143 {
23144 "abstract": true,
23145 "docs": {
23146 "stability": "stable",
23147 "summary": "The autoscaling group added to the cluster if capacity is associated to the cluster."
23148 },
23149 "immutable": true,
23150 "locationInModule": {
23151 "filename": "lib/cluster.ts",
23152 "line": 647
23153 },
23154 "name": "autoscalingGroup",
23155 "optional": true,
23156 "type": {
23157 "fqn": "@aws-cdk/aws-autoscaling.IAutoScalingGroup"
23158 }
23159 },
23160 {
23161 "abstract": true,
23162 "docs": {
23163 "stability": "stable",
23164 "summary": "The AWS Cloud Map namespace to associate with the cluster."
23165 },
23166 "immutable": true,
23167 "locationInModule": {
23168 "filename": "lib/cluster.ts",
23169 "line": 642
23170 },
23171 "name": "defaultCloudMapNamespace",
23172 "optional": true,
23173 "type": {
23174 "fqn": "@aws-cdk/aws-servicediscovery.INamespace"
23175 }
23176 },
23177 {
23178 "abstract": true,
23179 "docs": {
23180 "stability": "stable",
23181 "summary": "The execute command configuration for the cluster."
23182 },
23183 "immutable": true,
23184 "locationInModule": {
23185 "filename": "lib/cluster.ts",
23186 "line": 652
23187 },
23188 "name": "executeCommandConfiguration",
23189 "optional": true,
23190 "type": {
23191 "fqn": "@aws-cdk/aws-ecs.ExecuteCommandConfiguration"
23192 }
23193 }
23194 ],
23195 "symbolId": "lib/cluster:ICluster"
23196 },
23197 "@aws-cdk/aws-ecs.IEc2Service": {
23198 "assembly": "@aws-cdk/aws-ecs",
23199 "docs": {
23200 "stability": "stable",
23201 "summary": "The interface for a service using the EC2 launch type on an ECS cluster."
23202 },
23203 "fqn": "@aws-cdk/aws-ecs.IEc2Service",
23204 "interfaces": [
23205 "@aws-cdk/aws-ecs.IService"
23206 ],
23207 "kind": "interface",
23208 "locationInModule": {
23209 "filename": "lib/ec2/ec2-service.ts",
23210 "line": 90
23211 },
23212 "name": "IEc2Service",
23213 "symbolId": "lib/ec2/ec2-service:IEc2Service"
23214 },
23215 "@aws-cdk/aws-ecs.IEc2TaskDefinition": {
23216 "assembly": "@aws-cdk/aws-ecs",
23217 "docs": {
23218 "stability": "stable",
23219 "summary": "The interface of a task definition run on an EC2 cluster."
23220 },
23221 "fqn": "@aws-cdk/aws-ecs.IEc2TaskDefinition",
23222 "interfaces": [
23223 "@aws-cdk/aws-ecs.ITaskDefinition"
23224 ],
23225 "kind": "interface",
23226 "locationInModule": {
23227 "filename": "lib/ec2/ec2-task-definition.ts",
23228 "line": 69
23229 },
23230 "name": "IEc2TaskDefinition",
23231 "symbolId": "lib/ec2/ec2-task-definition:IEc2TaskDefinition"
23232 },
23233 "@aws-cdk/aws-ecs.IEcsLoadBalancerTarget": {
23234 "assembly": "@aws-cdk/aws-ecs",
23235 "docs": {
23236 "stability": "stable",
23237 "summary": "Interface for ECS load balancer target."
23238 },
23239 "fqn": "@aws-cdk/aws-ecs.IEcsLoadBalancerTarget",
23240 "interfaces": [
23241 "@aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget",
23242 "@aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget",
23243 "@aws-cdk/aws-elasticloadbalancing.ILoadBalancerTarget"
23244 ],
23245 "kind": "interface",
23246 "locationInModule": {
23247 "filename": "lib/base/base-service.ts",
23248 "line": 93
23249 },
23250 "name": "IEcsLoadBalancerTarget",
23251 "symbolId": "lib/base/base-service:IEcsLoadBalancerTarget"
23252 },
23253 "@aws-cdk/aws-ecs.IExternalService": {
23254 "assembly": "@aws-cdk/aws-ecs",
23255 "docs": {
23256 "stability": "stable",
23257 "summary": "The interface for a service using the External launch type on an ECS cluster."
23258 },
23259 "fqn": "@aws-cdk/aws-ecs.IExternalService",
23260 "interfaces": [
23261 "@aws-cdk/aws-ecs.IService"
23262 ],
23263 "kind": "interface",
23264 "locationInModule": {
23265 "filename": "lib/external/external-service.ts",
23266 "line": 35
23267 },
23268 "name": "IExternalService",
23269 "symbolId": "lib/external/external-service:IExternalService"
23270 },
23271 "@aws-cdk/aws-ecs.IExternalTaskDefinition": {
23272 "assembly": "@aws-cdk/aws-ecs",
23273 "docs": {
23274 "stability": "stable",
23275 "summary": "The interface of a task definition run on an External cluster."
23276 },
23277 "fqn": "@aws-cdk/aws-ecs.IExternalTaskDefinition",
23278 "interfaces": [
23279 "@aws-cdk/aws-ecs.ITaskDefinition"
23280 ],
23281 "kind": "interface",
23282 "locationInModule": {
23283 "filename": "lib/external/external-task-definition.ts",
23284 "line": 23
23285 },
23286 "name": "IExternalTaskDefinition",
23287 "symbolId": "lib/external/external-task-definition:IExternalTaskDefinition"
23288 },
23289 "@aws-cdk/aws-ecs.IFargateService": {
23290 "assembly": "@aws-cdk/aws-ecs",
23291 "docs": {
23292 "stability": "stable",
23293 "summary": "The interface for a service using the Fargate launch type on an ECS cluster."
23294 },
23295 "fqn": "@aws-cdk/aws-ecs.IFargateService",
23296 "interfaces": [
23297 "@aws-cdk/aws-ecs.IService"
23298 ],
23299 "kind": "interface",
23300 "locationInModule": {
23301 "filename": "lib/fargate/fargate-service.ts",
23302 "line": 67
23303 },
23304 "name": "IFargateService",
23305 "symbolId": "lib/fargate/fargate-service:IFargateService"
23306 },
23307 "@aws-cdk/aws-ecs.IFargateTaskDefinition": {
23308 "assembly": "@aws-cdk/aws-ecs",
23309 "docs": {
23310 "stability": "stable",
23311 "summary": "The interface of a task definition run on a Fargate cluster."
23312 },
23313 "fqn": "@aws-cdk/aws-ecs.IFargateTaskDefinition",
23314 "interfaces": [
23315 "@aws-cdk/aws-ecs.ITaskDefinition"
23316 ],
23317 "kind": "interface",
23318 "locationInModule": {
23319 "filename": "lib/fargate/fargate-task-definition.ts",
23320 "line": 77
23321 },
23322 "name": "IFargateTaskDefinition",
23323 "symbolId": "lib/fargate/fargate-task-definition:IFargateTaskDefinition"
23324 },
23325 "@aws-cdk/aws-ecs.IService": {
23326 "assembly": "@aws-cdk/aws-ecs",
23327 "docs": {
23328 "stability": "stable",
23329 "summary": "The interface for a service."
23330 },
23331 "fqn": "@aws-cdk/aws-ecs.IService",
23332 "interfaces": [
23333 "@aws-cdk/core.IResource"
23334 ],
23335 "kind": "interface",
23336 "locationInModule": {
23337 "filename": "lib/base/base-service.ts",
23338 "line": 19
23339 },
23340 "name": "IService",
23341 "properties": [
23342 {
23343 "abstract": true,
23344 "docs": {
23345 "custom": {
23346 "attribute": "true"
23347 },
23348 "stability": "stable",
23349 "summary": "The Amazon Resource Name (ARN) of the service."
23350 },
23351 "immutable": true,
23352 "locationInModule": {
23353 "filename": "lib/base/base-service.ts",
23354 "line": 25
23355 },
23356 "name": "serviceArn",
23357 "type": {
23358 "primitive": "string"
23359 }
23360 },
23361 {
23362 "abstract": true,
23363 "docs": {
23364 "custom": {
23365 "attribute": "true"
23366 },
23367 "stability": "stable",
23368 "summary": "The name of the service."
23369 },
23370 "immutable": true,
23371 "locationInModule": {
23372 "filename": "lib/base/base-service.ts",
23373 "line": 32
23374 },
23375 "name": "serviceName",
23376 "type": {
23377 "primitive": "string"
23378 }
23379 }
23380 ],
23381 "symbolId": "lib/base/base-service:IService"
23382 },
23383 "@aws-cdk/aws-ecs.ITaskDefinition": {
23384 "assembly": "@aws-cdk/aws-ecs",
23385 "docs": {
23386 "stability": "stable",
23387 "summary": "The interface for all task definitions."
23388 },
23389 "fqn": "@aws-cdk/aws-ecs.ITaskDefinition",
23390 "interfaces": [
23391 "@aws-cdk/core.IResource"
23392 ],
23393 "kind": "interface",
23394 "locationInModule": {
23395 "filename": "lib/base/task-definition.ts",
23396 "line": 17
23397 },
23398 "name": "ITaskDefinition",
23399 "properties": [
23400 {
23401 "abstract": true,
23402 "docs": {
23403 "stability": "stable",
23404 "summary": "What launch types this task definition should be compatible with."
23405 },
23406 "immutable": true,
23407 "locationInModule": {
23408 "filename": "lib/base/task-definition.ts",
23409 "line": 32
23410 },
23411 "name": "compatibility",
23412 "type": {
23413 "fqn": "@aws-cdk/aws-ecs.Compatibility"
23414 }
23415 },
23416 {
23417 "abstract": true,
23418 "docs": {
23419 "stability": "stable",
23420 "summary": "Return true if the task definition can be run on an EC2 cluster."
23421 },
23422 "immutable": true,
23423 "locationInModule": {
23424 "filename": "lib/base/task-definition.ts",
23425 "line": 37
23426 },
23427 "name": "isEc2Compatible",
23428 "type": {
23429 "primitive": "boolean"
23430 }
23431 },
23432 {
23433 "abstract": true,
23434 "docs": {
23435 "stability": "stable",
23436 "summary": "Return true if the task definition can be run on a ECS Anywhere cluster."
23437 },
23438 "immutable": true,
23439 "locationInModule": {
23440 "filename": "lib/base/task-definition.ts",
23441 "line": 47
23442 },
23443 "name": "isExternalCompatible",
23444 "type": {
23445 "primitive": "boolean"
23446 }
23447 },
23448 {
23449 "abstract": true,
23450 "docs": {
23451 "stability": "stable",
23452 "summary": "Return true if the task definition can be run on a Fargate cluster."
23453 },
23454 "immutable": true,
23455 "locationInModule": {
23456 "filename": "lib/base/task-definition.ts",
23457 "line": 42
23458 },
23459 "name": "isFargateCompatible",
23460 "type": {
23461 "primitive": "boolean"
23462 }
23463 },
23464 {
23465 "abstract": true,
23466 "docs": {
23467 "stability": "stable",
23468 "summary": "The networking mode to use for the containers in the task."
23469 },
23470 "immutable": true,
23471 "locationInModule": {
23472 "filename": "lib/base/task-definition.ts",
23473 "line": 53
23474 },
23475 "name": "networkMode",
23476 "type": {
23477 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
23478 }
23479 },
23480 {
23481 "abstract": true,
23482 "docs": {
23483 "custom": {
23484 "attribute": "true"
23485 },
23486 "stability": "stable",
23487 "summary": "ARN of this task definition."
23488 },
23489 "immutable": true,
23490 "locationInModule": {
23491 "filename": "lib/base/task-definition.ts",
23492 "line": 22
23493 },
23494 "name": "taskDefinitionArn",
23495 "type": {
23496 "primitive": "string"
23497 }
23498 },
23499 {
23500 "abstract": true,
23501 "docs": {
23502 "stability": "stable",
23503 "summary": "The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf."
23504 },
23505 "immutable": true,
23506 "locationInModule": {
23507 "filename": "lib/base/task-definition.ts",
23508 "line": 58
23509 },
23510 "name": "taskRole",
23511 "type": {
23512 "fqn": "@aws-cdk/aws-iam.IRole"
23513 }
23514 },
23515 {
23516 "abstract": true,
23517 "docs": {
23518 "stability": "stable",
23519 "summary": "Execution role for this task definition."
23520 },
23521 "immutable": true,
23522 "locationInModule": {
23523 "filename": "lib/base/task-definition.ts",
23524 "line": 27
23525 },
23526 "name": "executionRole",
23527 "optional": true,
23528 "type": {
23529 "fqn": "@aws-cdk/aws-iam.IRole"
23530 }
23531 }
23532 ],
23533 "symbolId": "lib/base/task-definition:ITaskDefinition"
23534 },
23535 "@aws-cdk/aws-ecs.ITaskDefinitionExtension": {
23536 "assembly": "@aws-cdk/aws-ecs",
23537 "docs": {
23538 "remarks": "Classes that want to make changes to a TaskDefinition (such as\nadding helper containers) can implement this interface, and can\nthen be \"added\" to a TaskDefinition like so:\n\n taskDefinition.addExtension(new MyExtension(\"some_parameter\"));",
23539 "stability": "stable",
23540 "summary": "An extension for Task Definitions."
23541 },
23542 "fqn": "@aws-cdk/aws-ecs.ITaskDefinitionExtension",
23543 "kind": "interface",
23544 "locationInModule": {
23545 "filename": "lib/base/task-definition.ts",
23546 "line": 1101
23547 },
23548 "methods": [
23549 {
23550 "abstract": true,
23551 "docs": {
23552 "stability": "stable",
23553 "summary": "Apply the extension to the given TaskDefinition."
23554 },
23555 "locationInModule": {
23556 "filename": "lib/base/task-definition.ts",
23557 "line": 1107
23558 },
23559 "name": "extend",
23560 "parameters": [
23561 {
23562 "docs": {
23563 "summary": "[disable-awslint:ref-via-interface]."
23564 },
23565 "name": "taskDefinition",
23566 "type": {
23567 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
23568 }
23569 }
23570 ]
23571 }
23572 ],
23573 "name": "ITaskDefinitionExtension",
23574 "symbolId": "lib/base/task-definition:ITaskDefinitionExtension"
23575 },
23576 "@aws-cdk/aws-ecs.InferenceAccelerator": {
23577 "assembly": "@aws-cdk/aws-ecs",
23578 "datatype": true,
23579 "docs": {
23580 "remarks": "For more information, see [Elastic Inference Basics](https://docs.aws.amazon.com/elastic-inference/latest/developerguide/basics.html)",
23581 "stability": "stable",
23582 "summary": "Elastic Inference Accelerator.",
23583 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst inferenceAccelerator: ecs.InferenceAccelerator = {\n deviceName: 'deviceName',\n deviceType: 'deviceType',\n};",
23584 "custom": {
23585 "exampleMetadata": "fixture=_generated"
23586 }
23587 },
23588 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator",
23589 "kind": "interface",
23590 "locationInModule": {
23591 "filename": "lib/base/task-definition.ts",
23592 "line": 832
23593 },
23594 "name": "InferenceAccelerator",
23595 "properties": [
23596 {
23597 "abstract": true,
23598 "docs": {
23599 "default": "- empty",
23600 "stability": "stable",
23601 "summary": "The Elastic Inference accelerator device name."
23602 },
23603 "immutable": true,
23604 "locationInModule": {
23605 "filename": "lib/base/task-definition.ts",
23606 "line": 837
23607 },
23608 "name": "deviceName",
23609 "optional": true,
23610 "type": {
23611 "primitive": "string"
23612 }
23613 },
23614 {
23615 "abstract": true,
23616 "docs": {
23617 "default": "- empty",
23618 "remarks": "The allowed values are: eia2.medium, eia2.large and eia2.xlarge.",
23619 "stability": "stable",
23620 "summary": "The Elastic Inference accelerator type to use."
23621 },
23622 "immutable": true,
23623 "locationInModule": {
23624 "filename": "lib/base/task-definition.ts",
23625 "line": 843
23626 },
23627 "name": "deviceType",
23628 "optional": true,
23629 "type": {
23630 "primitive": "string"
23631 }
23632 }
23633 ],
23634 "symbolId": "lib/base/task-definition:InferenceAccelerator"
23635 },
23636 "@aws-cdk/aws-ecs.IpcMode": {
23637 "assembly": "@aws-cdk/aws-ecs",
23638 "docs": {
23639 "stability": "stable",
23640 "summary": "The IPC resource namespace to use for the containers in the task."
23641 },
23642 "fqn": "@aws-cdk/aws-ecs.IpcMode",
23643 "kind": "enum",
23644 "locationInModule": {
23645 "filename": "lib/base/task-definition.ts",
23646 "line": 793
23647 },
23648 "members": [
23649 {
23650 "docs": {
23651 "stability": "stable",
23652 "summary": "If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance."
23653 },
23654 "name": "NONE"
23655 },
23656 {
23657 "docs": {
23658 "stability": "stable",
23659 "summary": "If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance."
23660 },
23661 "name": "HOST"
23662 },
23663 {
23664 "docs": {
23665 "stability": "stable",
23666 "summary": "If task is specified, all containers within the specified task share the same IPC resources."
23667 },
23668 "name": "TASK"
23669 }
23670 ],
23671 "name": "IpcMode",
23672 "symbolId": "lib/base/task-definition:IpcMode"
23673 },
23674 "@aws-cdk/aws-ecs.JournaldLogDriver": {
23675 "assembly": "@aws-cdk/aws-ecs",
23676 "base": "@aws-cdk/aws-ecs.LogDriver",
23677 "docs": {
23678 "stability": "stable",
23679 "summary": "A log driver that sends log information to journald Logs.",
23680 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst journaldLogDriver = new ecs.JournaldLogDriver(/* all optional props */ {\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n tag: 'tag',\n});",
23681 "custom": {
23682 "exampleMetadata": "fixture=_generated"
23683 }
23684 },
23685 "fqn": "@aws-cdk/aws-ecs.JournaldLogDriver",
23686 "initializer": {
23687 "docs": {
23688 "stability": "stable",
23689 "summary": "Constructs a new instance of the JournaldLogDriver class."
23690 },
23691 "locationInModule": {
23692 "filename": "lib/log-drivers/journald-log-driver.ts",
23693 "line": 26
23694 },
23695 "parameters": [
23696 {
23697 "docs": {
23698 "summary": "the journald log driver configuration options."
23699 },
23700 "name": "props",
23701 "optional": true,
23702 "type": {
23703 "fqn": "@aws-cdk/aws-ecs.JournaldLogDriverProps"
23704 }
23705 }
23706 ]
23707 },
23708 "kind": "class",
23709 "locationInModule": {
23710 "filename": "lib/log-drivers/journald-log-driver.ts",
23711 "line": 20
23712 },
23713 "methods": [
23714 {
23715 "docs": {
23716 "stability": "stable",
23717 "summary": "Called when the log driver is configured on a container."
23718 },
23719 "locationInModule": {
23720 "filename": "lib/log-drivers/journald-log-driver.ts",
23721 "line": 33
23722 },
23723 "name": "bind",
23724 "overrides": "@aws-cdk/aws-ecs.LogDriver",
23725 "parameters": [
23726 {
23727 "name": "_scope",
23728 "type": {
23729 "fqn": "@aws-cdk/core.Construct"
23730 }
23731 },
23732 {
23733 "name": "_containerDefinition",
23734 "type": {
23735 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
23736 }
23737 }
23738 ],
23739 "returns": {
23740 "type": {
23741 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
23742 }
23743 }
23744 }
23745 ],
23746 "name": "JournaldLogDriver",
23747 "symbolId": "lib/log-drivers/journald-log-driver:JournaldLogDriver"
23748 },
23749 "@aws-cdk/aws-ecs.JournaldLogDriverProps": {
23750 "assembly": "@aws-cdk/aws-ecs",
23751 "datatype": true,
23752 "docs": {
23753 "remarks": "[Source](https://docs.docker.com/config/containers/logging/journald/)",
23754 "stability": "stable",
23755 "summary": "Specifies the journald log driver configuration options.",
23756 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst journaldLogDriverProps: ecs.JournaldLogDriverProps = {\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n tag: 'tag',\n};",
23757 "custom": {
23758 "exampleMetadata": "fixture=_generated"
23759 }
23760 },
23761 "fqn": "@aws-cdk/aws-ecs.JournaldLogDriverProps",
23762 "interfaces": [
23763 "@aws-cdk/aws-ecs.BaseLogDriverProps"
23764 ],
23765 "kind": "interface",
23766 "locationInModule": {
23767 "filename": "lib/log-drivers/journald-log-driver.ts",
23768 "line": 15
23769 },
23770 "name": "JournaldLogDriverProps",
23771 "symbolId": "lib/log-drivers/journald-log-driver:JournaldLogDriverProps"
23772 },
23773 "@aws-cdk/aws-ecs.JsonFileLogDriver": {
23774 "assembly": "@aws-cdk/aws-ecs",
23775 "base": "@aws-cdk/aws-ecs.LogDriver",
23776 "docs": {
23777 "stability": "stable",
23778 "summary": "A log driver that sends log information to json-file Logs.",
23779 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst jsonFileLogDriver = new ecs.JsonFileLogDriver(/* all optional props */ {\n compress: false,\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n maxFile: 123,\n maxSize: 'maxSize',\n tag: 'tag',\n});",
23780 "custom": {
23781 "exampleMetadata": "fixture=_generated"
23782 }
23783 },
23784 "fqn": "@aws-cdk/aws-ecs.JsonFileLogDriver",
23785 "initializer": {
23786 "docs": {
23787 "stability": "stable",
23788 "summary": "Constructs a new instance of the JsonFileLogDriver class."
23789 },
23790 "locationInModule": {
23791 "filename": "lib/log-drivers/json-file-log-driver.ts",
23792 "line": 50
23793 },
23794 "parameters": [
23795 {
23796 "docs": {
23797 "summary": "the json-file log driver configuration options."
23798 },
23799 "name": "props",
23800 "optional": true,
23801 "type": {
23802 "fqn": "@aws-cdk/aws-ecs.JsonFileLogDriverProps"
23803 }
23804 }
23805 ]
23806 },
23807 "kind": "class",
23808 "locationInModule": {
23809 "filename": "lib/log-drivers/json-file-log-driver.ts",
23810 "line": 44
23811 },
23812 "methods": [
23813 {
23814 "docs": {
23815 "stability": "stable",
23816 "summary": "Called when the log driver is configured on a container."
23817 },
23818 "locationInModule": {
23819 "filename": "lib/log-drivers/json-file-log-driver.ts",
23820 "line": 62
23821 },
23822 "name": "bind",
23823 "overrides": "@aws-cdk/aws-ecs.LogDriver",
23824 "parameters": [
23825 {
23826 "name": "_scope",
23827 "type": {
23828 "fqn": "@aws-cdk/core.Construct"
23829 }
23830 },
23831 {
23832 "name": "_containerDefinition",
23833 "type": {
23834 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
23835 }
23836 }
23837 ],
23838 "returns": {
23839 "type": {
23840 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
23841 }
23842 }
23843 }
23844 ],
23845 "name": "JsonFileLogDriver",
23846 "symbolId": "lib/log-drivers/json-file-log-driver:JsonFileLogDriver"
23847 },
23848 "@aws-cdk/aws-ecs.JsonFileLogDriverProps": {
23849 "assembly": "@aws-cdk/aws-ecs",
23850 "datatype": true,
23851 "docs": {
23852 "remarks": "[Source](https://docs.docker.com/config/containers/logging/json-file/)",
23853 "stability": "stable",
23854 "summary": "Specifies the json-file log driver configuration options.",
23855 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst jsonFileLogDriverProps: ecs.JsonFileLogDriverProps = {\n compress: false,\n env: ['env'],\n envRegex: 'envRegex',\n labels: ['labels'],\n maxFile: 123,\n maxSize: 'maxSize',\n tag: 'tag',\n};",
23856 "custom": {
23857 "exampleMetadata": "fixture=_generated"
23858 }
23859 },
23860 "fqn": "@aws-cdk/aws-ecs.JsonFileLogDriverProps",
23861 "interfaces": [
23862 "@aws-cdk/aws-ecs.BaseLogDriverProps"
23863 ],
23864 "kind": "interface",
23865 "locationInModule": {
23866 "filename": "lib/log-drivers/json-file-log-driver.ts",
23867 "line": 15
23868 },
23869 "name": "JsonFileLogDriverProps",
23870 "properties": [
23871 {
23872 "abstract": true,
23873 "docs": {
23874 "default": "- false",
23875 "stability": "stable",
23876 "summary": "Toggles compression for rotated logs."
23877 },
23878 "immutable": true,
23879 "locationInModule": {
23880 "filename": "lib/log-drivers/json-file-log-driver.ts",
23881 "line": 38
23882 },
23883 "name": "compress",
23884 "optional": true,
23885 "type": {
23886 "primitive": "boolean"
23887 }
23888 },
23889 {
23890 "abstract": true,
23891 "docs": {
23892 "default": "- 1",
23893 "remarks": "If rolling the logs creates\nexcess files, the oldest file is removed. Only effective when max-size is also set.\nA positive integer.",
23894 "stability": "stable",
23895 "summary": "The maximum number of log files that can be present."
23896 },
23897 "immutable": true,
23898 "locationInModule": {
23899 "filename": "lib/log-drivers/json-file-log-driver.ts",
23900 "line": 31
23901 },
23902 "name": "maxFile",
23903 "optional": true,
23904 "type": {
23905 "primitive": "number"
23906 }
23907 },
23908 {
23909 "abstract": true,
23910 "docs": {
23911 "default": "- -1 (unlimited)",
23912 "remarks": "A positive integer plus a modifier\nrepresenting the unit of measure (k, m, or g).",
23913 "stability": "stable",
23914 "summary": "The maximum size of the log before it is rolled."
23915 },
23916 "immutable": true,
23917 "locationInModule": {
23918 "filename": "lib/log-drivers/json-file-log-driver.ts",
23919 "line": 22
23920 },
23921 "name": "maxSize",
23922 "optional": true,
23923 "type": {
23924 "primitive": "string"
23925 }
23926 }
23927 ],
23928 "symbolId": "lib/log-drivers/json-file-log-driver:JsonFileLogDriverProps"
23929 },
23930 "@aws-cdk/aws-ecs.LaunchType": {
23931 "assembly": "@aws-cdk/aws-ecs",
23932 "docs": {
23933 "stability": "stable",
23934 "summary": "The launch type of an ECS service."
23935 },
23936 "fqn": "@aws-cdk/aws-ecs.LaunchType",
23937 "kind": "enum",
23938 "locationInModule": {
23939 "filename": "lib/base/base-service.ts",
23940 "line": 1070
23941 },
23942 "members": [
23943 {
23944 "docs": {
23945 "stability": "stable",
23946 "summary": "The service will be launched using the EC2 launch type."
23947 },
23948 "name": "EC2"
23949 },
23950 {
23951 "docs": {
23952 "stability": "stable",
23953 "summary": "The service will be launched using the FARGATE launch type."
23954 },
23955 "name": "FARGATE"
23956 },
23957 {
23958 "docs": {
23959 "stability": "stable",
23960 "summary": "The service will be launched using the EXTERNAL launch type."
23961 },
23962 "name": "EXTERNAL"
23963 }
23964 ],
23965 "name": "LaunchType",
23966 "symbolId": "lib/base/base-service:LaunchType"
23967 },
23968 "@aws-cdk/aws-ecs.LinuxParameters": {
23969 "assembly": "@aws-cdk/aws-ecs",
23970 "base": "@aws-cdk/core.Construct",
23971 "docs": {
23972 "stability": "stable",
23973 "summary": "Linux-specific options that are applied to the container.",
23974 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst linuxParameters = new ecs.LinuxParameters(this, 'MyLinuxParameters', /* all optional props */ {\n initProcessEnabled: false,\n sharedMemorySize: 123,\n});",
23975 "custom": {
23976 "exampleMetadata": "fixture=_generated"
23977 }
23978 },
23979 "fqn": "@aws-cdk/aws-ecs.LinuxParameters",
23980 "initializer": {
23981 "docs": {
23982 "stability": "stable",
23983 "summary": "Constructs a new instance of the LinuxParameters class."
23984 },
23985 "locationInModule": {
23986 "filename": "lib/linux-parameters.ts",
23987 "line": 65
23988 },
23989 "parameters": [
23990 {
23991 "name": "scope",
23992 "type": {
23993 "fqn": "constructs.Construct"
23994 }
23995 },
23996 {
23997 "name": "id",
23998 "type": {
23999 "primitive": "string"
24000 }
24001 },
24002 {
24003 "name": "props",
24004 "optional": true,
24005 "type": {
24006 "fqn": "@aws-cdk/aws-ecs.LinuxParametersProps"
24007 }
24008 }
24009 ]
24010 },
24011 "kind": "class",
24012 "locationInModule": {
24013 "filename": "lib/linux-parameters.ts",
24014 "line": 31
24015 },
24016 "methods": [
24017 {
24018 "docs": {
24019 "remarks": "Only works with EC2 launch type.",
24020 "stability": "stable",
24021 "summary": "Adds one or more Linux capabilities to the Docker configuration of a container."
24022 },
24023 "locationInModule": {
24024 "filename": "lib/linux-parameters.ts",
24025 "line": 77
24026 },
24027 "name": "addCapabilities",
24028 "parameters": [
24029 {
24030 "name": "cap",
24031 "type": {
24032 "fqn": "@aws-cdk/aws-ecs.Capability"
24033 },
24034 "variadic": true
24035 }
24036 ],
24037 "variadic": true
24038 },
24039 {
24040 "docs": {
24041 "stability": "stable",
24042 "summary": "Adds one or more host devices to a container."
24043 },
24044 "locationInModule": {
24045 "filename": "lib/linux-parameters.ts",
24046 "line": 93
24047 },
24048 "name": "addDevices",
24049 "parameters": [
24050 {
24051 "name": "device",
24052 "type": {
24053 "fqn": "@aws-cdk/aws-ecs.Device"
24054 },
24055 "variadic": true
24056 }
24057 ],
24058 "variadic": true
24059 },
24060 {
24061 "docs": {
24062 "remarks": "Only works with EC2 launch type.",
24063 "stability": "stable",
24064 "summary": "Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container."
24065 },
24066 "locationInModule": {
24067 "filename": "lib/linux-parameters.ts",
24068 "line": 102
24069 },
24070 "name": "addTmpfs",
24071 "parameters": [
24072 {
24073 "name": "tmpfs",
24074 "type": {
24075 "fqn": "@aws-cdk/aws-ecs.Tmpfs"
24076 },
24077 "variadic": true
24078 }
24079 ],
24080 "variadic": true
24081 },
24082 {
24083 "docs": {
24084 "remarks": "Only works with EC2 launch type.",
24085 "stability": "stable",
24086 "summary": "Removes one or more Linux capabilities to the Docker configuration of a container."
24087 },
24088 "locationInModule": {
24089 "filename": "lib/linux-parameters.ts",
24090 "line": 86
24091 },
24092 "name": "dropCapabilities",
24093 "parameters": [
24094 {
24095 "name": "cap",
24096 "type": {
24097 "fqn": "@aws-cdk/aws-ecs.Capability"
24098 },
24099 "variadic": true
24100 }
24101 ],
24102 "variadic": true
24103 },
24104 {
24105 "docs": {
24106 "stability": "stable",
24107 "summary": "Renders the Linux parameters to a CloudFormation object."
24108 },
24109 "locationInModule": {
24110 "filename": "lib/linux-parameters.ts",
24111 "line": 109
24112 },
24113 "name": "renderLinuxParameters",
24114 "returns": {
24115 "type": {
24116 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.LinuxParametersProperty"
24117 }
24118 }
24119 }
24120 ],
24121 "name": "LinuxParameters",
24122 "symbolId": "lib/linux-parameters:LinuxParameters"
24123 },
24124 "@aws-cdk/aws-ecs.LinuxParametersProps": {
24125 "assembly": "@aws-cdk/aws-ecs",
24126 "datatype": true,
24127 "docs": {
24128 "stability": "stable",
24129 "summary": "The properties for defining Linux-specific options that are applied to the container.",
24130 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst linuxParametersProps: ecs.LinuxParametersProps = {\n initProcessEnabled: false,\n sharedMemorySize: 123,\n};",
24131 "custom": {
24132 "exampleMetadata": "fixture=_generated"
24133 }
24134 },
24135 "fqn": "@aws-cdk/aws-ecs.LinuxParametersProps",
24136 "kind": "interface",
24137 "locationInModule": {
24138 "filename": "lib/linux-parameters.ts",
24139 "line": 12
24140 },
24141 "name": "LinuxParametersProps",
24142 "properties": [
24143 {
24144 "abstract": true,
24145 "docs": {
24146 "default": "false",
24147 "stability": "stable",
24148 "summary": "Specifies whether to run an init process inside the container that forwards signals and reaps processes."
24149 },
24150 "immutable": true,
24151 "locationInModule": {
24152 "filename": "lib/linux-parameters.ts",
24153 "line": 18
24154 },
24155 "name": "initProcessEnabled",
24156 "optional": true,
24157 "type": {
24158 "primitive": "boolean"
24159 }
24160 },
24161 {
24162 "abstract": true,
24163 "docs": {
24164 "default": "No shared memory.",
24165 "stability": "stable",
24166 "summary": "The value for the size (in MiB) of the /dev/shm volume."
24167 },
24168 "immutable": true,
24169 "locationInModule": {
24170 "filename": "lib/linux-parameters.ts",
24171 "line": 25
24172 },
24173 "name": "sharedMemorySize",
24174 "optional": true,
24175 "type": {
24176 "primitive": "number"
24177 }
24178 }
24179 ],
24180 "symbolId": "lib/linux-parameters:LinuxParametersProps"
24181 },
24182 "@aws-cdk/aws-ecs.ListenerConfig": {
24183 "abstract": true,
24184 "assembly": "@aws-cdk/aws-ecs",
24185 "docs": {
24186 "custom": {
24187 "exampleMetadata": "infused"
24188 },
24189 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);",
24190 "stability": "stable",
24191 "summary": "Base class for configuring listener when registering targets."
24192 },
24193 "fqn": "@aws-cdk/aws-ecs.ListenerConfig",
24194 "initializer": {
24195 "docs": {
24196 "stability": "stable"
24197 }
24198 },
24199 "kind": "class",
24200 "locationInModule": {
24201 "filename": "lib/base/base-service.ts",
24202 "line": 230
24203 },
24204 "methods": [
24205 {
24206 "docs": {
24207 "stability": "stable",
24208 "summary": "Create a config for adding target group to ALB listener."
24209 },
24210 "locationInModule": {
24211 "filename": "lib/base/base-service.ts",
24212 "line": 234
24213 },
24214 "name": "applicationListener",
24215 "parameters": [
24216 {
24217 "name": "listener",
24218 "type": {
24219 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.ApplicationListener"
24220 }
24221 },
24222 {
24223 "name": "props",
24224 "optional": true,
24225 "type": {
24226 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.AddApplicationTargetsProps"
24227 }
24228 }
24229 ],
24230 "returns": {
24231 "type": {
24232 "fqn": "@aws-cdk/aws-ecs.ListenerConfig"
24233 }
24234 },
24235 "static": true
24236 },
24237 {
24238 "docs": {
24239 "stability": "stable",
24240 "summary": "Create a config for adding target group to NLB listener."
24241 },
24242 "locationInModule": {
24243 "filename": "lib/base/base-service.ts",
24244 "line": 241
24245 },
24246 "name": "networkListener",
24247 "parameters": [
24248 {
24249 "name": "listener",
24250 "type": {
24251 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.NetworkListener"
24252 }
24253 },
24254 {
24255 "name": "props",
24256 "optional": true,
24257 "type": {
24258 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.AddNetworkTargetsProps"
24259 }
24260 }
24261 ],
24262 "returns": {
24263 "type": {
24264 "fqn": "@aws-cdk/aws-ecs.ListenerConfig"
24265 }
24266 },
24267 "static": true
24268 },
24269 {
24270 "abstract": true,
24271 "docs": {
24272 "stability": "stable",
24273 "summary": "Create and attach a target group to listener."
24274 },
24275 "locationInModule": {
24276 "filename": "lib/base/base-service.ts",
24277 "line": 248
24278 },
24279 "name": "addTargets",
24280 "parameters": [
24281 {
24282 "name": "id",
24283 "type": {
24284 "primitive": "string"
24285 }
24286 },
24287 {
24288 "name": "target",
24289 "type": {
24290 "fqn": "@aws-cdk/aws-ecs.LoadBalancerTargetOptions"
24291 }
24292 },
24293 {
24294 "name": "service",
24295 "type": {
24296 "fqn": "@aws-cdk/aws-ecs.BaseService"
24297 }
24298 }
24299 ]
24300 }
24301 ],
24302 "name": "ListenerConfig",
24303 "symbolId": "lib/base/base-service:ListenerConfig"
24304 },
24305 "@aws-cdk/aws-ecs.LoadBalancerTargetOptions": {
24306 "assembly": "@aws-cdk/aws-ecs",
24307 "datatype": true,
24308 "docs": {
24309 "custom": {
24310 "exampleMetadata": "infused"
24311 },
24312 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elb.LoadBalancer(this, 'LB', { vpc });\nlb.addListener({ externalPort: 80 });\nlb.addTarget(service.loadBalancerTarget({\n containerName: 'MyContainer',\n containerPort: 80,\n}));",
24313 "remarks": "The port mapping for it must already have been created through addPortMapping().",
24314 "stability": "stable",
24315 "summary": "Properties for defining an ECS target."
24316 },
24317 "fqn": "@aws-cdk/aws-ecs.LoadBalancerTargetOptions",
24318 "kind": "interface",
24319 "locationInModule": {
24320 "filename": "lib/base/task-definition.ts",
24321 "line": 931
24322 },
24323 "name": "LoadBalancerTargetOptions",
24324 "properties": [
24325 {
24326 "abstract": true,
24327 "docs": {
24328 "stability": "stable",
24329 "summary": "The name of the container."
24330 },
24331 "immutable": true,
24332 "locationInModule": {
24333 "filename": "lib/base/task-definition.ts",
24334 "line": 935
24335 },
24336 "name": "containerName",
24337 "type": {
24338 "primitive": "string"
24339 }
24340 },
24341 {
24342 "abstract": true,
24343 "docs": {
24344 "default": "- Container port of the first added port mapping.",
24345 "remarks": "Only applicable when using application/network load balancers.",
24346 "stability": "stable",
24347 "summary": "The port number of the container."
24348 },
24349 "immutable": true,
24350 "locationInModule": {
24351 "filename": "lib/base/task-definition.ts",
24352 "line": 942
24353 },
24354 "name": "containerPort",
24355 "optional": true,
24356 "type": {
24357 "primitive": "number"
24358 }
24359 },
24360 {
24361 "abstract": true,
24362 "docs": {
24363 "default": "Protocol.TCP",
24364 "remarks": "Only applicable when using application load balancers.",
24365 "stability": "stable",
24366 "summary": "The protocol used for the port mapping."
24367 },
24368 "immutable": true,
24369 "locationInModule": {
24370 "filename": "lib/base/task-definition.ts",
24371 "line": 949
24372 },
24373 "name": "protocol",
24374 "optional": true,
24375 "type": {
24376 "fqn": "@aws-cdk/aws-ecs.Protocol"
24377 }
24378 }
24379 ],
24380 "symbolId": "lib/base/task-definition:LoadBalancerTargetOptions"
24381 },
24382 "@aws-cdk/aws-ecs.LogDriver": {
24383 "abstract": true,
24384 "assembly": "@aws-cdk/aws-ecs",
24385 "docs": {
24386 "custom": {
24387 "exampleMetadata": "infused"
24388 },
24389 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.splunk({\n token: SecretValue.secretsManager('my-splunk-token'),\n url: 'my-splunk-url',\n }),\n});",
24390 "stability": "stable",
24391 "summary": "The base class for log drivers."
24392 },
24393 "fqn": "@aws-cdk/aws-ecs.LogDriver",
24394 "initializer": {
24395 "docs": {
24396 "stability": "stable"
24397 }
24398 },
24399 "kind": "class",
24400 "locationInModule": {
24401 "filename": "lib/log-drivers/log-driver.ts",
24402 "line": 12
24403 },
24404 "methods": [
24405 {
24406 "docs": {
24407 "stability": "stable",
24408 "summary": "Creates a log driver configuration that sends log information to CloudWatch Logs."
24409 },
24410 "locationInModule": {
24411 "filename": "lib/log-drivers/log-driver.ts",
24412 "line": 16
24413 },
24414 "name": "awsLogs",
24415 "parameters": [
24416 {
24417 "name": "props",
24418 "type": {
24419 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverProps"
24420 }
24421 }
24422 ],
24423 "returns": {
24424 "type": {
24425 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24426 }
24427 },
24428 "static": true
24429 },
24430 {
24431 "abstract": true,
24432 "docs": {
24433 "stability": "stable",
24434 "summary": "Called when the log driver is configured on a container."
24435 },
24436 "locationInModule": {
24437 "filename": "lib/log-drivers/log-driver.ts",
24438 "line": 23
24439 },
24440 "name": "bind",
24441 "parameters": [
24442 {
24443 "name": "scope",
24444 "type": {
24445 "fqn": "@aws-cdk/core.Construct"
24446 }
24447 },
24448 {
24449 "name": "containerDefinition",
24450 "type": {
24451 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
24452 }
24453 }
24454 ],
24455 "returns": {
24456 "type": {
24457 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
24458 }
24459 }
24460 }
24461 ],
24462 "name": "LogDriver",
24463 "symbolId": "lib/log-drivers/log-driver:LogDriver"
24464 },
24465 "@aws-cdk/aws-ecs.LogDriverConfig": {
24466 "assembly": "@aws-cdk/aws-ecs",
24467 "datatype": true,
24468 "docs": {
24469 "stability": "stable",
24470 "summary": "The configuration to use when creating a log driver.",
24471 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst logDriverConfig: ecs.LogDriverConfig = {\n logDriver: 'logDriver',\n\n // the properties below are optional\n options: {\n optionsKey: 'options',\n },\n secretOptions: [{\n name: 'name',\n valueFrom: 'valueFrom',\n }],\n};",
24472 "custom": {
24473 "exampleMetadata": "fixture=_generated"
24474 }
24475 },
24476 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig",
24477 "kind": "interface",
24478 "locationInModule": {
24479 "filename": "lib/log-drivers/log-driver.ts",
24480 "line": 29
24481 },
24482 "name": "LogDriverConfig",
24483 "properties": [
24484 {
24485 "abstract": true,
24486 "docs": {
24487 "remarks": "The valid values listed for this parameter are log drivers\nthat the Amazon ECS container agent can communicate with by default.\n\nFor tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens.\nFor tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,\nlogentries,syslog, splunk, and awsfirelens.\n\nFor more information about using the awslogs log driver, see\n[Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)\nin the Amazon Elastic Container Service Developer Guide.\n\nFor more information about using the awsfirelens log driver, see\n[Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)\nin the Amazon Elastic Container Service Developer Guide.",
24488 "stability": "stable",
24489 "summary": "The log driver to use for the container."
24490 },
24491 "immutable": true,
24492 "locationInModule": {
24493 "filename": "lib/log-drivers/log-driver.ts",
24494 "line": 46
24495 },
24496 "name": "logDriver",
24497 "type": {
24498 "primitive": "string"
24499 }
24500 },
24501 {
24502 "abstract": true,
24503 "docs": {
24504 "stability": "stable",
24505 "summary": "The configuration options to send to the log driver."
24506 },
24507 "immutable": true,
24508 "locationInModule": {
24509 "filename": "lib/log-drivers/log-driver.ts",
24510 "line": 51
24511 },
24512 "name": "options",
24513 "optional": true,
24514 "type": {
24515 "collection": {
24516 "elementtype": {
24517 "primitive": "string"
24518 },
24519 "kind": "map"
24520 }
24521 }
24522 },
24523 {
24524 "abstract": true,
24525 "docs": {
24526 "default": "- No secret options provided.",
24527 "stability": "stable",
24528 "summary": "The secrets to pass to the log configuration."
24529 },
24530 "immutable": true,
24531 "locationInModule": {
24532 "filename": "lib/log-drivers/log-driver.ts",
24533 "line": 57
24534 },
24535 "name": "secretOptions",
24536 "optional": true,
24537 "type": {
24538 "collection": {
24539 "elementtype": {
24540 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.SecretProperty"
24541 },
24542 "kind": "array"
24543 }
24544 }
24545 }
24546 ],
24547 "symbolId": "lib/log-drivers/log-driver:LogDriverConfig"
24548 },
24549 "@aws-cdk/aws-ecs.LogDrivers": {
24550 "assembly": "@aws-cdk/aws-ecs",
24551 "docs": {
24552 "custom": {
24553 "exampleMetadata": "infused"
24554 },
24555 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.awsLogs({ streamPrefix: 'EventDemo' }),\n});",
24556 "stability": "stable",
24557 "summary": "The base class for log drivers."
24558 },
24559 "fqn": "@aws-cdk/aws-ecs.LogDrivers",
24560 "initializer": {
24561 "docs": {
24562 "stability": "stable"
24563 }
24564 },
24565 "kind": "class",
24566 "locationInModule": {
24567 "filename": "lib/log-drivers/log-drivers.ts",
24568 "line": 14
24569 },
24570 "methods": [
24571 {
24572 "docs": {
24573 "stability": "stable",
24574 "summary": "Creates a log driver configuration that sends log information to CloudWatch Logs."
24575 },
24576 "locationInModule": {
24577 "filename": "lib/log-drivers/log-drivers.ts",
24578 "line": 18
24579 },
24580 "name": "awsLogs",
24581 "parameters": [
24582 {
24583 "name": "props",
24584 "type": {
24585 "fqn": "@aws-cdk/aws-ecs.AwsLogDriverProps"
24586 }
24587 }
24588 ],
24589 "returns": {
24590 "type": {
24591 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24592 }
24593 },
24594 "static": true
24595 },
24596 {
24597 "docs": {
24598 "remarks": "For detail configurations, please refer to Amazon ECS FireLens Examples:\nhttps://github.com/aws-samples/amazon-ecs-firelens-examples",
24599 "stability": "stable",
24600 "summary": "Creates a log driver configuration that sends log information to firelens log router."
24601 },
24602 "locationInModule": {
24603 "filename": "lib/log-drivers/log-drivers.ts",
24604 "line": 69
24605 },
24606 "name": "firelens",
24607 "parameters": [
24608 {
24609 "name": "props",
24610 "type": {
24611 "fqn": "@aws-cdk/aws-ecs.FireLensLogDriverProps"
24612 }
24613 }
24614 ],
24615 "returns": {
24616 "type": {
24617 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24618 }
24619 },
24620 "static": true
24621 },
24622 {
24623 "docs": {
24624 "stability": "stable",
24625 "summary": "Creates a log driver configuration that sends log information to fluentd Logs."
24626 },
24627 "locationInModule": {
24628 "filename": "lib/log-drivers/log-drivers.ts",
24629 "line": 25
24630 },
24631 "name": "fluentd",
24632 "parameters": [
24633 {
24634 "name": "props",
24635 "optional": true,
24636 "type": {
24637 "fqn": "@aws-cdk/aws-ecs.FluentdLogDriverProps"
24638 }
24639 }
24640 ],
24641 "returns": {
24642 "type": {
24643 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24644 }
24645 },
24646 "static": true
24647 },
24648 {
24649 "docs": {
24650 "stability": "stable",
24651 "summary": "Creates a log driver configuration that sends log information to gelf Logs."
24652 },
24653 "locationInModule": {
24654 "filename": "lib/log-drivers/log-drivers.ts",
24655 "line": 32
24656 },
24657 "name": "gelf",
24658 "parameters": [
24659 {
24660 "name": "props",
24661 "type": {
24662 "fqn": "@aws-cdk/aws-ecs.GelfLogDriverProps"
24663 }
24664 }
24665 ],
24666 "returns": {
24667 "type": {
24668 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24669 }
24670 },
24671 "static": true
24672 },
24673 {
24674 "docs": {
24675 "stability": "stable",
24676 "summary": "Creates a log driver configuration that sends log information to journald Logs."
24677 },
24678 "locationInModule": {
24679 "filename": "lib/log-drivers/log-drivers.ts",
24680 "line": 39
24681 },
24682 "name": "journald",
24683 "parameters": [
24684 {
24685 "name": "props",
24686 "optional": true,
24687 "type": {
24688 "fqn": "@aws-cdk/aws-ecs.JournaldLogDriverProps"
24689 }
24690 }
24691 ],
24692 "returns": {
24693 "type": {
24694 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24695 }
24696 },
24697 "static": true
24698 },
24699 {
24700 "docs": {
24701 "stability": "stable",
24702 "summary": "Creates a log driver configuration that sends log information to json-file Logs."
24703 },
24704 "locationInModule": {
24705 "filename": "lib/log-drivers/log-drivers.ts",
24706 "line": 46
24707 },
24708 "name": "jsonFile",
24709 "parameters": [
24710 {
24711 "name": "props",
24712 "optional": true,
24713 "type": {
24714 "fqn": "@aws-cdk/aws-ecs.JsonFileLogDriverProps"
24715 }
24716 }
24717 ],
24718 "returns": {
24719 "type": {
24720 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24721 }
24722 },
24723 "static": true
24724 },
24725 {
24726 "docs": {
24727 "stability": "stable",
24728 "summary": "Creates a log driver configuration that sends log information to splunk Logs."
24729 },
24730 "locationInModule": {
24731 "filename": "lib/log-drivers/log-drivers.ts",
24732 "line": 53
24733 },
24734 "name": "splunk",
24735 "parameters": [
24736 {
24737 "name": "props",
24738 "type": {
24739 "fqn": "@aws-cdk/aws-ecs.SplunkLogDriverProps"
24740 }
24741 }
24742 ],
24743 "returns": {
24744 "type": {
24745 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24746 }
24747 },
24748 "static": true
24749 },
24750 {
24751 "docs": {
24752 "stability": "stable",
24753 "summary": "Creates a log driver configuration that sends log information to syslog Logs."
24754 },
24755 "locationInModule": {
24756 "filename": "lib/log-drivers/log-drivers.ts",
24757 "line": 60
24758 },
24759 "name": "syslog",
24760 "parameters": [
24761 {
24762 "name": "props",
24763 "optional": true,
24764 "type": {
24765 "fqn": "@aws-cdk/aws-ecs.SyslogLogDriverProps"
24766 }
24767 }
24768 ],
24769 "returns": {
24770 "type": {
24771 "fqn": "@aws-cdk/aws-ecs.LogDriver"
24772 }
24773 },
24774 "static": true
24775 }
24776 ],
24777 "name": "LogDrivers",
24778 "symbolId": "lib/log-drivers/log-drivers:LogDrivers"
24779 },
24780 "@aws-cdk/aws-ecs.MachineImageType": {
24781 "assembly": "@aws-cdk/aws-ecs",
24782 "docs": {
24783 "custom": {
24784 "exampleMetadata": "infused"
24785 },
24786 "example": "declare const cluster: ecs.Cluster;\n\ncluster.addCapacity('graviton-cluster', {\n minCapacity: 2,\n instanceType: new ec2.InstanceType('c6g.large'),\n machineImageType: ecs.MachineImageType.BOTTLEROCKET,\n});",
24787 "stability": "stable",
24788 "summary": "The machine image type."
24789 },
24790 "fqn": "@aws-cdk/aws-ecs.MachineImageType",
24791 "kind": "enum",
24792 "locationInModule": {
24793 "filename": "lib/cluster.ts",
24794 "line": 86
24795 },
24796 "members": [
24797 {
24798 "docs": {
24799 "stability": "stable",
24800 "summary": "Amazon ECS-optimized Amazon Linux 2 AMI."
24801 },
24802 "name": "AMAZON_LINUX_2"
24803 },
24804 {
24805 "docs": {
24806 "stability": "stable",
24807 "summary": "Bottlerocket AMI."
24808 },
24809 "name": "BOTTLEROCKET"
24810 }
24811 ],
24812 "name": "MachineImageType",
24813 "symbolId": "lib/cluster:MachineImageType"
24814 },
24815 "@aws-cdk/aws-ecs.MemoryUtilizationScalingProps": {
24816 "assembly": "@aws-cdk/aws-ecs",
24817 "datatype": true,
24818 "docs": {
24819 "custom": {
24820 "exampleMetadata": "infused"
24821 },
24822 "example": "declare const cluster: ecs.Cluster;\nconst loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {\n cluster,\n memoryLimitMiB: 1024,\n desiredCount: 1,\n cpu: 512,\n taskImageOptions: {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n },\n});\n\nconst scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({\n minCapacity: 1,\n maxCapacity: 20,\n});\n\nscalableTarget.scaleOnCpuUtilization('CpuScaling', {\n targetUtilizationPercent: 50,\n});\n\nscalableTarget.scaleOnMemoryUtilization('MemoryScaling', {\n targetUtilizationPercent: 50,\n});",
24823 "stability": "stable",
24824 "summary": "The properties for enabling scaling based on memory utilization."
24825 },
24826 "fqn": "@aws-cdk/aws-ecs.MemoryUtilizationScalingProps",
24827 "interfaces": [
24828 "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps"
24829 ],
24830 "kind": "interface",
24831 "locationInModule": {
24832 "filename": "lib/base/scalable-task-count.ts",
24833 "line": 113
24834 },
24835 "name": "MemoryUtilizationScalingProps",
24836 "properties": [
24837 {
24838 "abstract": true,
24839 "docs": {
24840 "stability": "stable",
24841 "summary": "The target value for memory utilization across all tasks in the service."
24842 },
24843 "immutable": true,
24844 "locationInModule": {
24845 "filename": "lib/base/scalable-task-count.ts",
24846 "line": 117
24847 },
24848 "name": "targetUtilizationPercent",
24849 "type": {
24850 "primitive": "number"
24851 }
24852 }
24853 ],
24854 "symbolId": "lib/base/scalable-task-count:MemoryUtilizationScalingProps"
24855 },
24856 "@aws-cdk/aws-ecs.MountPoint": {
24857 "assembly": "@aws-cdk/aws-ecs",
24858 "datatype": true,
24859 "docs": {
24860 "stability": "stable",
24861 "summary": "The details of data volume mount points for a container.",
24862 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst mountPoint: ecs.MountPoint = {\n containerPath: 'containerPath',\n readOnly: false,\n sourceVolume: 'sourceVolume',\n};",
24863 "custom": {
24864 "exampleMetadata": "fixture=_generated"
24865 }
24866 },
24867 "fqn": "@aws-cdk/aws-ecs.MountPoint",
24868 "kind": "interface",
24869 "locationInModule": {
24870 "filename": "lib/container-definition.ts",
24871 "line": 1060
24872 },
24873 "name": "MountPoint",
24874 "properties": [
24875 {
24876 "abstract": true,
24877 "docs": {
24878 "stability": "stable",
24879 "summary": "The path on the container to mount the host volume at."
24880 },
24881 "immutable": true,
24882 "locationInModule": {
24883 "filename": "lib/container-definition.ts",
24884 "line": 1064
24885 },
24886 "name": "containerPath",
24887 "type": {
24888 "primitive": "string"
24889 }
24890 },
24891 {
24892 "abstract": true,
24893 "docs": {
24894 "remarks": "If this value is true, the container has read-only access to the volume.\nIf this value is false, then the container can write to the volume.",
24895 "stability": "stable",
24896 "summary": "Specifies whether to give the container read-only access to the volume."
24897 },
24898 "immutable": true,
24899 "locationInModule": {
24900 "filename": "lib/container-definition.ts",
24901 "line": 1071
24902 },
24903 "name": "readOnly",
24904 "type": {
24905 "primitive": "boolean"
24906 }
24907 },
24908 {
24909 "abstract": true,
24910 "docs": {
24911 "remarks": "Must be a volume name referenced in the name parameter of task definition volume.",
24912 "stability": "stable",
24913 "summary": "The name of the volume to mount."
24914 },
24915 "immutable": true,
24916 "locationInModule": {
24917 "filename": "lib/container-definition.ts",
24918 "line": 1077
24919 },
24920 "name": "sourceVolume",
24921 "type": {
24922 "primitive": "string"
24923 }
24924 }
24925 ],
24926 "symbolId": "lib/container-definition:MountPoint"
24927 },
24928 "@aws-cdk/aws-ecs.NetworkMode": {
24929 "assembly": "@aws-cdk/aws-ecs",
24930 "docs": {
24931 "custom": {
24932 "exampleMetadata": "infused"
24933 },
24934 "example": "const ec2TaskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef', {\n networkMode: ecs.NetworkMode.BRIDGE,\n});\n\nconst container = ec2TaskDefinition.addContainer(\"WebContainer\", {\n // Use an image from DockerHub\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n // ... other options here ...\n});",
24935 "stability": "stable",
24936 "summary": "The networking mode to use for the containers in the task."
24937 },
24938 "fqn": "@aws-cdk/aws-ecs.NetworkMode",
24939 "kind": "enum",
24940 "locationInModule": {
24941 "filename": "lib/base/task-definition.ts",
24942 "line": 757
24943 },
24944 "members": [
24945 {
24946 "docs": {
24947 "stability": "stable",
24948 "summary": "The task's containers do not have external connectivity and port mappings can't be specified in the container definition."
24949 },
24950 "name": "NONE"
24951 },
24952 {
24953 "docs": {
24954 "stability": "stable",
24955 "summary": "The task utilizes Docker's built-in virtual network which runs inside each container instance."
24956 },
24957 "name": "BRIDGE"
24958 },
24959 {
24960 "docs": {
24961 "stability": "stable",
24962 "summary": "The task is allocated an elastic network interface."
24963 },
24964 "name": "AWS_VPC"
24965 },
24966 {
24967 "docs": {
24968 "remarks": "In this mode, you can't run multiple instantiations of the same task on a\nsingle container instance when port mappings are used.",
24969 "stability": "stable",
24970 "summary": "The task bypasses Docker's built-in virtual network and maps container ports directly to the EC2 instance's network interface directly."
24971 },
24972 "name": "HOST"
24973 },
24974 {
24975 "docs": {
24976 "remarks": "This is the only supported network mode for Windows containers. For more information, see\n[Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#network_mode).",
24977 "stability": "stable",
24978 "summary": "The task utilizes NAT network mode required by Windows containers."
24979 },
24980 "name": "NAT"
24981 }
24982 ],
24983 "name": "NetworkMode",
24984 "symbolId": "lib/base/task-definition:NetworkMode"
24985 },
24986 "@aws-cdk/aws-ecs.OperatingSystemFamily": {
24987 "assembly": "@aws-cdk/aws-ecs",
24988 "docs": {
24989 "custom": {
24990 "exampleMetadata": "infused"
24991 },
24992 "example": "// Create a Task Definition for the Windows container to start\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,\n cpuArchitecture: ecs.CpuArchitecture.X86_64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('windowsservercore', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),\n});",
24993 "stability": "stable",
24994 "summary": "The operating system for Fargate Runtime Platform."
24995 },
24996 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily",
24997 "kind": "class",
24998 "locationInModule": {
24999 "filename": "lib/runtime-platform.ts",
25000 "line": 35
25001 },
25002 "methods": [
25003 {
25004 "docs": {
25005 "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-operatingsystemfamily for all available operating system family.",
25006 "stability": "stable",
25007 "summary": "Other operating system family."
25008 },
25009 "locationInModule": {
25010 "filename": "lib/runtime-platform.ts",
25011 "line": 84
25012 },
25013 "name": "of",
25014 "parameters": [
25015 {
25016 "docs": {
25017 "summary": "operating system family."
25018 },
25019 "name": "family",
25020 "type": {
25021 "primitive": "string"
25022 }
25023 }
25024 ],
25025 "returns": {
25026 "type": {
25027 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25028 }
25029 },
25030 "static": true
25031 }
25032 ],
25033 "name": "OperatingSystemFamily",
25034 "properties": [
25035 {
25036 "const": true,
25037 "docs": {
25038 "stability": "stable",
25039 "summary": "LINUX."
25040 },
25041 "immutable": true,
25042 "locationInModule": {
25043 "filename": "lib/runtime-platform.ts",
25044 "line": 39
25045 },
25046 "name": "LINUX",
25047 "static": true,
25048 "type": {
25049 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25050 }
25051 },
25052 {
25053 "const": true,
25054 "docs": {
25055 "stability": "stable",
25056 "summary": "WINDOWS_SERVER_2004_CORE."
25057 },
25058 "immutable": true,
25059 "locationInModule": {
25060 "filename": "lib/runtime-platform.ts",
25061 "line": 44
25062 },
25063 "name": "WINDOWS_SERVER_2004_CORE",
25064 "static": true,
25065 "type": {
25066 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25067 }
25068 },
25069 {
25070 "const": true,
25071 "docs": {
25072 "stability": "stable",
25073 "summary": "WINDOWS_SERVER_2016_FULL."
25074 },
25075 "immutable": true,
25076 "locationInModule": {
25077 "filename": "lib/runtime-platform.ts",
25078 "line": 49
25079 },
25080 "name": "WINDOWS_SERVER_2016_FULL",
25081 "static": true,
25082 "type": {
25083 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25084 }
25085 },
25086 {
25087 "const": true,
25088 "docs": {
25089 "stability": "stable",
25090 "summary": "WINDOWS_SERVER_2019_CORE."
25091 },
25092 "immutable": true,
25093 "locationInModule": {
25094 "filename": "lib/runtime-platform.ts",
25095 "line": 54
25096 },
25097 "name": "WINDOWS_SERVER_2019_CORE",
25098 "static": true,
25099 "type": {
25100 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25101 }
25102 },
25103 {
25104 "const": true,
25105 "docs": {
25106 "stability": "stable",
25107 "summary": "WINDOWS_SERVER_2019_FULL."
25108 },
25109 "immutable": true,
25110 "locationInModule": {
25111 "filename": "lib/runtime-platform.ts",
25112 "line": 59
25113 },
25114 "name": "WINDOWS_SERVER_2019_FULL",
25115 "static": true,
25116 "type": {
25117 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25118 }
25119 },
25120 {
25121 "const": true,
25122 "docs": {
25123 "stability": "stable",
25124 "summary": "WINDOWS_SERVER_2022_CORE."
25125 },
25126 "immutable": true,
25127 "locationInModule": {
25128 "filename": "lib/runtime-platform.ts",
25129 "line": 64
25130 },
25131 "name": "WINDOWS_SERVER_2022_CORE",
25132 "static": true,
25133 "type": {
25134 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25135 }
25136 },
25137 {
25138 "const": true,
25139 "docs": {
25140 "stability": "stable",
25141 "summary": "WINDOWS_SERVER_2022_FULL."
25142 },
25143 "immutable": true,
25144 "locationInModule": {
25145 "filename": "lib/runtime-platform.ts",
25146 "line": 69
25147 },
25148 "name": "WINDOWS_SERVER_2022_FULL",
25149 "static": true,
25150 "type": {
25151 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25152 }
25153 },
25154 {
25155 "const": true,
25156 "docs": {
25157 "stability": "stable",
25158 "summary": "WINDOWS_SERVER_20H2_CORE."
25159 },
25160 "immutable": true,
25161 "locationInModule": {
25162 "filename": "lib/runtime-platform.ts",
25163 "line": 74
25164 },
25165 "name": "WINDOWS_SERVER_20H2_CORE",
25166 "static": true,
25167 "type": {
25168 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25169 }
25170 }
25171 ],
25172 "symbolId": "lib/runtime-platform:OperatingSystemFamily"
25173 },
25174 "@aws-cdk/aws-ecs.PidMode": {
25175 "assembly": "@aws-cdk/aws-ecs",
25176 "docs": {
25177 "stability": "stable",
25178 "summary": "The process namespace to use for the containers in the task."
25179 },
25180 "fqn": "@aws-cdk/aws-ecs.PidMode",
25181 "kind": "enum",
25182 "locationInModule": {
25183 "filename": "lib/base/task-definition.ts",
25184 "line": 815
25185 },
25186 "members": [
25187 {
25188 "docs": {
25189 "stability": "stable",
25190 "summary": "If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance."
25191 },
25192 "name": "HOST"
25193 },
25194 {
25195 "docs": {
25196 "stability": "stable",
25197 "summary": "If task is specified, all containers within the specified task share the same process namespace."
25198 },
25199 "name": "TASK"
25200 }
25201 ],
25202 "name": "PidMode",
25203 "symbolId": "lib/base/task-definition:PidMode"
25204 },
25205 "@aws-cdk/aws-ecs.PlacementConstraint": {
25206 "assembly": "@aws-cdk/aws-ecs",
25207 "docs": {
25208 "custom": {
25209 "exampleMetadata": "infused"
25210 },
25211 "example": "const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {\n isDefault: true,\n});\n\nconst cluster = new ecs.Cluster(this, 'Ec2Cluster', { vpc });\ncluster.addCapacity('DefaultAutoScalingGroup', {\n instanceType: new ec2.InstanceType('t2.micro'),\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },\n});\n\nconst taskDefinition = new ecs.TaskDefinition(this, 'TD', {\n compatibility: ecs.Compatibility.EC2,\n});\n\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('foo/bar'),\n memoryLimitMiB: 256,\n});\n\nconst runTask = new tasks.EcsRunTask(this, 'Run', {\n integrationPattern: sfn.IntegrationPattern.RUN_JOB,\n cluster,\n taskDefinition,\n launchTarget: new tasks.EcsEc2LaunchTarget({\n placementStrategies: [\n ecs.PlacementStrategy.spreadAcrossInstances(),\n ecs.PlacementStrategy.packedByCpu(),\n ecs.PlacementStrategy.randomly(),\n ],\n placementConstraints: [\n ecs.PlacementConstraint.memberOf('blieptuut'),\n ],\n }),\n});",
25212 "remarks": "Tasks will only be placed on instances that match these rules.",
25213 "stability": "stable",
25214 "summary": "The placement constraints to use for tasks in the service. For more information, see [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)."
25215 },
25216 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint",
25217 "kind": "class",
25218 "locationInModule": {
25219 "filename": "lib/placement.ts",
25220 "line": 101
25221 },
25222 "methods": [
25223 {
25224 "docs": {
25225 "stability": "stable",
25226 "summary": "Use distinctInstance to ensure that each task in a particular group is running on a different container instance."
25227 },
25228 "locationInModule": {
25229 "filename": "lib/placement.ts",
25230 "line": 105
25231 },
25232 "name": "distinctInstances",
25233 "returns": {
25234 "type": {
25235 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
25236 }
25237 },
25238 "static": true
25239 },
25240 {
25241 "docs": {
25242 "remarks": "Multiple expressions can be specified. For more information, see\n[Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).\n\nYou can specify multiple expressions in one call. The tasks will only be placed on instances matching all expressions.",
25243 "see": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html",
25244 "stability": "stable",
25245 "summary": "Use memberOf to restrict the selection to a group of valid candidates specified by a query expression."
25246 },
25247 "locationInModule": {
25248 "filename": "lib/placement.ts",
25249 "line": 119
25250 },
25251 "name": "memberOf",
25252 "parameters": [
25253 {
25254 "name": "expressions",
25255 "type": {
25256 "primitive": "string"
25257 },
25258 "variadic": true
25259 }
25260 ],
25261 "returns": {
25262 "type": {
25263 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
25264 }
25265 },
25266 "static": true,
25267 "variadic": true
25268 },
25269 {
25270 "docs": {
25271 "stability": "stable",
25272 "summary": "Return the placement JSON."
25273 },
25274 "locationInModule": {
25275 "filename": "lib/placement.ts",
25276 "line": 132
25277 },
25278 "name": "toJson",
25279 "returns": {
25280 "type": {
25281 "collection": {
25282 "elementtype": {
25283 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementConstraintProperty"
25284 },
25285 "kind": "array"
25286 }
25287 }
25288 }
25289 }
25290 ],
25291 "name": "PlacementConstraint",
25292 "symbolId": "lib/placement:PlacementConstraint"
25293 },
25294 "@aws-cdk/aws-ecs.PlacementStrategy": {
25295 "assembly": "@aws-cdk/aws-ecs",
25296 "docs": {
25297 "custom": {
25298 "exampleMetadata": "infused"
25299 },
25300 "example": "const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {\n isDefault: true,\n});\n\nconst cluster = new ecs.Cluster(this, 'Ec2Cluster', { vpc });\ncluster.addCapacity('DefaultAutoScalingGroup', {\n instanceType: new ec2.InstanceType('t2.micro'),\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },\n});\n\nconst taskDefinition = new ecs.TaskDefinition(this, 'TD', {\n compatibility: ecs.Compatibility.EC2,\n});\n\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('foo/bar'),\n memoryLimitMiB: 256,\n});\n\nconst runTask = new tasks.EcsRunTask(this, 'Run', {\n integrationPattern: sfn.IntegrationPattern.RUN_JOB,\n cluster,\n taskDefinition,\n launchTarget: new tasks.EcsEc2LaunchTarget({\n placementStrategies: [\n ecs.PlacementStrategy.spreadAcrossInstances(),\n ecs.PlacementStrategy.packedByCpu(),\n ecs.PlacementStrategy.randomly(),\n ],\n placementConstraints: [\n ecs.PlacementConstraint.memberOf('blieptuut'),\n ],\n }),\n});",
25301 "remarks": "Tasks will preferentially be placed on instances that match these rules.",
25302 "stability": "stable",
25303 "summary": "The placement strategies to use for tasks in the service. For more information, see [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)."
25304 },
25305 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy",
25306 "kind": "class",
25307 "locationInModule": {
25308 "filename": "lib/placement.ts",
25309 "line": 25
25310 },
25311 "methods": [
25312 {
25313 "docs": {
25314 "stability": "stable",
25315 "summary": "Places tasks on the container instances with the least available capacity of the specified resource."
25316 },
25317 "locationInModule": {
25318 "filename": "lib/placement.ts",
25319 "line": 70
25320 },
25321 "name": "packedBy",
25322 "parameters": [
25323 {
25324 "name": "resource",
25325 "type": {
25326 "fqn": "@aws-cdk/aws-ecs.BinPackResource"
25327 }
25328 }
25329 ],
25330 "returns": {
25331 "type": {
25332 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25333 }
25334 },
25335 "static": true
25336 },
25337 {
25338 "docs": {
25339 "remarks": "This minimizes the number of instances in use.",
25340 "stability": "stable",
25341 "summary": "Places tasks on container instances with the least available amount of CPU capacity."
25342 },
25343 "locationInModule": {
25344 "filename": "lib/placement.ts",
25345 "line": 54
25346 },
25347 "name": "packedByCpu",
25348 "returns": {
25349 "type": {
25350 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25351 }
25352 },
25353 "static": true
25354 },
25355 {
25356 "docs": {
25357 "remarks": "This minimizes the number of instances in use.",
25358 "stability": "stable",
25359 "summary": "Places tasks on container instances with the least available amount of memory capacity."
25360 },
25361 "locationInModule": {
25362 "filename": "lib/placement.ts",
25363 "line": 63
25364 },
25365 "name": "packedByMemory",
25366 "returns": {
25367 "type": {
25368 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25369 }
25370 },
25371 "static": true
25372 },
25373 {
25374 "docs": {
25375 "stability": "stable",
25376 "summary": "Places tasks randomly."
25377 },
25378 "locationInModule": {
25379 "filename": "lib/placement.ts",
25380 "line": 77
25381 },
25382 "name": "randomly",
25383 "returns": {
25384 "type": {
25385 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25386 }
25387 },
25388 "static": true
25389 },
25390 {
25391 "docs": {
25392 "default": "attributes instanceId",
25393 "remarks": "You can use one of the built-in attributes found on `BuiltInAttributes`\nor supply your own custom instance attributes. If more than one attribute\nis supplied, spreading is done in order.",
25394 "stability": "stable",
25395 "summary": "Places tasks evenly based on the specified value."
25396 },
25397 "locationInModule": {
25398 "filename": "lib/placement.ts",
25399 "line": 42
25400 },
25401 "name": "spreadAcross",
25402 "parameters": [
25403 {
25404 "name": "fields",
25405 "type": {
25406 "primitive": "string"
25407 },
25408 "variadic": true
25409 }
25410 ],
25411 "returns": {
25412 "type": {
25413 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25414 }
25415 },
25416 "static": true,
25417 "variadic": true
25418 },
25419 {
25420 "docs": {
25421 "stability": "stable",
25422 "summary": "Places tasks evenly across all container instances in the cluster."
25423 },
25424 "locationInModule": {
25425 "filename": "lib/placement.ts",
25426 "line": 29
25427 },
25428 "name": "spreadAcrossInstances",
25429 "returns": {
25430 "type": {
25431 "fqn": "@aws-cdk/aws-ecs.PlacementStrategy"
25432 }
25433 },
25434 "static": true
25435 },
25436 {
25437 "docs": {
25438 "stability": "stable",
25439 "summary": "Return the placement JSON."
25440 },
25441 "locationInModule": {
25442 "filename": "lib/placement.ts",
25443 "line": 90
25444 },
25445 "name": "toJson",
25446 "returns": {
25447 "type": {
25448 "collection": {
25449 "elementtype": {
25450 "fqn": "@aws-cdk/aws-ecs.CfnService.PlacementStrategyProperty"
25451 },
25452 "kind": "array"
25453 }
25454 }
25455 }
25456 }
25457 ],
25458 "name": "PlacementStrategy",
25459 "symbolId": "lib/placement:PlacementStrategy"
25460 },
25461 "@aws-cdk/aws-ecs.PortMapping": {
25462 "assembly": "@aws-cdk/aws-ecs",
25463 "datatype": true,
25464 "docs": {
25465 "custom": {
25466 "exampleMetadata": "infused"
25467 },
25468 "example": "declare const container: ecs.ContainerDefinition;\n\ncontainer.addPortMappings({\n containerPort: 3000,\n});",
25469 "stability": "stable",
25470 "summary": "Port mappings allow containers to access ports on the host container instance to send or receive traffic."
25471 },
25472 "fqn": "@aws-cdk/aws-ecs.PortMapping",
25473 "kind": "interface",
25474 "locationInModule": {
25475 "filename": "lib/container-definition.ts",
25476 "line": 977
25477 },
25478 "name": "PortMapping",
25479 "properties": [
25480 {
25481 "abstract": true,
25482 "docs": {
25483 "remarks": "If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.\nIf you are using containers in a task with the bridge network mode and you specify a container port and not a host port,\nyour container automatically receives a host port in the ephemeral port range.\n\nFor more information, see hostPort.\nPort mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.",
25484 "stability": "stable",
25485 "summary": "The port number on the container that is bound to the user-specified or automatically assigned host port."
25486 },
25487 "immutable": true,
25488 "locationInModule": {
25489 "filename": "lib/container-definition.ts",
25490 "line": 988
25491 },
25492 "name": "containerPort",
25493 "type": {
25494 "primitive": "number"
25495 }
25496 },
25497 {
25498 "abstract": true,
25499 "docs": {
25500 "remarks": "If you are using containers in a task with the awsvpc or host network mode,\nthe hostPort can either be left blank or set to the same value as the containerPort.\n\nIf you are using containers in a task with the bridge network mode,\nyou can specify a non-reserved host port for your container port mapping, or\nyou can omit the hostPort (or set it to 0) while specifying a containerPort and\nyour container automatically receives a port in the ephemeral port range for\nyour container instance operating system and Docker version.",
25501 "stability": "stable",
25502 "summary": "The port number on the container instance to reserve for your container."
25503 },
25504 "immutable": true,
25505 "locationInModule": {
25506 "filename": "lib/container-definition.ts",
25507 "line": 1002
25508 },
25509 "name": "hostPort",
25510 "optional": true,
25511 "type": {
25512 "primitive": "number"
25513 }
25514 },
25515 {
25516 "abstract": true,
25517 "docs": {
25518 "default": "TCP",
25519 "remarks": "Valid values are Protocol.TCP and Protocol.UDP.",
25520 "stability": "stable",
25521 "summary": "The protocol used for the port mapping."
25522 },
25523 "immutable": true,
25524 "locationInModule": {
25525 "filename": "lib/container-definition.ts",
25526 "line": 1009
25527 },
25528 "name": "protocol",
25529 "optional": true,
25530 "type": {
25531 "fqn": "@aws-cdk/aws-ecs.Protocol"
25532 }
25533 }
25534 ],
25535 "symbolId": "lib/container-definition:PortMapping"
25536 },
25537 "@aws-cdk/aws-ecs.PropagatedTagSource": {
25538 "assembly": "@aws-cdk/aws-ecs",
25539 "docs": {
25540 "stability": "stable",
25541 "summary": "Propagate tags from either service or task definition."
25542 },
25543 "fqn": "@aws-cdk/aws-ecs.PropagatedTagSource",
25544 "kind": "enum",
25545 "locationInModule": {
25546 "filename": "lib/base/base-service.ts",
25547 "line": 1111
25548 },
25549 "members": [
25550 {
25551 "docs": {
25552 "stability": "stable",
25553 "summary": "Propagate tags from service."
25554 },
25555 "name": "SERVICE"
25556 },
25557 {
25558 "docs": {
25559 "stability": "stable",
25560 "summary": "Propagate tags from task definition."
25561 },
25562 "name": "TASK_DEFINITION"
25563 },
25564 {
25565 "docs": {
25566 "stability": "stable",
25567 "summary": "Do not propagate."
25568 },
25569 "name": "NONE"
25570 }
25571 ],
25572 "name": "PropagatedTagSource",
25573 "symbolId": "lib/base/base-service:PropagatedTagSource"
25574 },
25575 "@aws-cdk/aws-ecs.Protocol": {
25576 "assembly": "@aws-cdk/aws-ecs",
25577 "docs": {
25578 "custom": {
25579 "exampleMetadata": "infused"
25580 },
25581 "example": "declare const taskDefinition: ecs.TaskDefinition;\ndeclare const cluster: ecs.Cluster;\n\n// Add a container to the task definition\nconst specificContainer = taskDefinition.addContainer('Container', {\n image: ecs.ContainerImage.fromRegistry('/aws/aws-example-app'),\n memoryLimitMiB: 2048,\n});\n\n// Add a port mapping\nspecificContainer.addPortMappings({\n containerPort: 7600,\n protocol: ecs.Protocol.TCP,\n});\n\nnew ecs.Ec2Service(this, 'Service', {\n cluster,\n taskDefinition,\n cloudMapOptions: {\n // Create SRV records - useful for bridge networking\n dnsRecordType: cloudmap.DnsRecordType.SRV,\n // Targets port TCP port 7600 `specificContainer`\n container: specificContainer,\n containerPort: 7600,\n },\n});",
25582 "stability": "stable",
25583 "summary": "Network protocol."
25584 },
25585 "fqn": "@aws-cdk/aws-ecs.Protocol",
25586 "kind": "enum",
25587 "locationInModule": {
25588 "filename": "lib/container-definition.ts",
25589 "line": 1015
25590 },
25591 "members": [
25592 {
25593 "docs": {
25594 "stability": "stable",
25595 "summary": "TCP."
25596 },
25597 "name": "TCP"
25598 },
25599 {
25600 "docs": {
25601 "stability": "stable",
25602 "summary": "UDP."
25603 },
25604 "name": "UDP"
25605 }
25606 ],
25607 "name": "Protocol",
25608 "symbolId": "lib/container-definition:Protocol"
25609 },
25610 "@aws-cdk/aws-ecs.ProxyConfiguration": {
25611 "abstract": true,
25612 "assembly": "@aws-cdk/aws-ecs",
25613 "docs": {
25614 "stability": "stable",
25615 "summary": "The base class for proxy configurations."
25616 },
25617 "fqn": "@aws-cdk/aws-ecs.ProxyConfiguration",
25618 "initializer": {
25619 "docs": {
25620 "stability": "stable"
25621 }
25622 },
25623 "kind": "class",
25624 "locationInModule": {
25625 "filename": "lib/proxy-configuration/proxy-configuration.ts",
25626 "line": 11
25627 },
25628 "methods": [
25629 {
25630 "abstract": true,
25631 "docs": {
25632 "stability": "stable",
25633 "summary": "Called when the proxy configuration is configured on a task definition."
25634 },
25635 "locationInModule": {
25636 "filename": "lib/proxy-configuration/proxy-configuration.ts",
25637 "line": 15
25638 },
25639 "name": "bind",
25640 "parameters": [
25641 {
25642 "name": "_scope",
25643 "type": {
25644 "fqn": "@aws-cdk/core.Construct"
25645 }
25646 },
25647 {
25648 "name": "_taskDefinition",
25649 "type": {
25650 "fqn": "@aws-cdk/aws-ecs.TaskDefinition"
25651 }
25652 }
25653 ],
25654 "returns": {
25655 "type": {
25656 "fqn": "@aws-cdk/aws-ecs.CfnTaskDefinition.ProxyConfigurationProperty"
25657 }
25658 }
25659 }
25660 ],
25661 "name": "ProxyConfiguration",
25662 "symbolId": "lib/proxy-configuration/proxy-configuration:ProxyConfiguration"
25663 },
25664 "@aws-cdk/aws-ecs.ProxyConfigurations": {
25665 "assembly": "@aws-cdk/aws-ecs",
25666 "docs": {
25667 "stability": "stable",
25668 "summary": "The base class for proxy configurations.",
25669 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst proxyConfigurations = new ecs.ProxyConfigurations();",
25670 "custom": {
25671 "exampleMetadata": "fixture=_generated"
25672 }
25673 },
25674 "fqn": "@aws-cdk/aws-ecs.ProxyConfigurations",
25675 "initializer": {
25676 "docs": {
25677 "stability": "stable"
25678 }
25679 },
25680 "kind": "class",
25681 "locationInModule": {
25682 "filename": "lib/proxy-configuration/proxy-configurations.ts",
25683 "line": 7
25684 },
25685 "methods": [
25686 {
25687 "docs": {
25688 "stability": "stable",
25689 "summary": "Constructs a new instance of the ProxyConfiguration class."
25690 },
25691 "locationInModule": {
25692 "filename": "lib/proxy-configuration/proxy-configurations.ts",
25693 "line": 11
25694 },
25695 "name": "appMeshProxyConfiguration",
25696 "parameters": [
25697 {
25698 "name": "props",
25699 "type": {
25700 "fqn": "@aws-cdk/aws-ecs.AppMeshProxyConfigurationConfigProps"
25701 }
25702 }
25703 ],
25704 "returns": {
25705 "type": {
25706 "fqn": "@aws-cdk/aws-ecs.ProxyConfiguration"
25707 }
25708 },
25709 "static": true
25710 }
25711 ],
25712 "name": "ProxyConfigurations",
25713 "symbolId": "lib/proxy-configuration/proxy-configurations:ProxyConfigurations"
25714 },
25715 "@aws-cdk/aws-ecs.RepositoryImage": {
25716 "assembly": "@aws-cdk/aws-ecs",
25717 "base": "@aws-cdk/aws-ecs.ContainerImage",
25718 "docs": {
25719 "remarks": "For images hosted in Amazon ECR, see\n[EcrImage](https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html).",
25720 "stability": "stable",
25721 "summary": "An image hosted in a public or private repository.",
25722 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecr_assets from '@aws-cdk/aws-ecr-assets';\nimport * as ecs from '@aws-cdk/aws-ecs';\n\ndeclare const dockerImageAsset: ecr_assets.DockerImageAsset;\nconst repositoryImage = ecs.RepositoryImage.fromDockerImageAsset(dockerImageAsset);",
25723 "custom": {
25724 "exampleMetadata": "fixture=_generated"
25725 }
25726 },
25727 "fqn": "@aws-cdk/aws-ecs.RepositoryImage",
25728 "initializer": {
25729 "docs": {
25730 "stability": "stable",
25731 "summary": "Constructs a new instance of the RepositoryImage class."
25732 },
25733 "locationInModule": {
25734 "filename": "lib/images/repository.ts",
25735 "line": 36
25736 },
25737 "parameters": [
25738 {
25739 "name": "imageName",
25740 "type": {
25741 "primitive": "string"
25742 }
25743 },
25744 {
25745 "name": "props",
25746 "optional": true,
25747 "type": {
25748 "fqn": "@aws-cdk/aws-ecs.RepositoryImageProps"
25749 }
25750 }
25751 ]
25752 },
25753 "kind": "class",
25754 "locationInModule": {
25755 "filename": "lib/images/repository.ts",
25756 "line": 31
25757 },
25758 "methods": [
25759 {
25760 "docs": {
25761 "stability": "stable",
25762 "summary": "Called when the image is used by a ContainerDefinition."
25763 },
25764 "locationInModule": {
25765 "filename": "lib/images/repository.ts",
25766 "line": 40
25767 },
25768 "name": "bind",
25769 "overrides": "@aws-cdk/aws-ecs.ContainerImage",
25770 "parameters": [
25771 {
25772 "name": "scope",
25773 "type": {
25774 "fqn": "@aws-cdk/core.Construct"
25775 }
25776 },
25777 {
25778 "name": "containerDefinition",
25779 "type": {
25780 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
25781 }
25782 }
25783 ],
25784 "returns": {
25785 "type": {
25786 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig"
25787 }
25788 }
25789 }
25790 ],
25791 "name": "RepositoryImage",
25792 "symbolId": "lib/images/repository:RepositoryImage"
25793 },
25794 "@aws-cdk/aws-ecs.RepositoryImageProps": {
25795 "assembly": "@aws-cdk/aws-ecs",
25796 "datatype": true,
25797 "docs": {
25798 "stability": "stable",
25799 "summary": "The properties for an image hosted in a public or private repository.",
25800 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as secretsmanager from '@aws-cdk/aws-secretsmanager';\n\ndeclare const secret: secretsmanager.Secret;\nconst repositoryImageProps: ecs.RepositoryImageProps = {\n credentials: secret,\n};",
25801 "custom": {
25802 "exampleMetadata": "fixture=_generated"
25803 }
25804 },
25805 "fqn": "@aws-cdk/aws-ecs.RepositoryImageProps",
25806 "kind": "interface",
25807 "locationInModule": {
25808 "filename": "lib/images/repository.ts",
25809 "line": 19
25810 },
25811 "name": "RepositoryImageProps",
25812 "properties": [
25813 {
25814 "abstract": true,
25815 "docs": {
25816 "remarks": "The supported value is the full ARN of an AWS Secrets Manager secret.",
25817 "stability": "stable",
25818 "summary": "The secret to expose to the container that contains the credentials for the image repository."
25819 },
25820 "immutable": true,
25821 "locationInModule": {
25822 "filename": "lib/images/repository.ts",
25823 "line": 24
25824 },
25825 "name": "credentials",
25826 "optional": true,
25827 "type": {
25828 "fqn": "@aws-cdk/aws-secretsmanager.ISecret"
25829 }
25830 }
25831 ],
25832 "symbolId": "lib/images/repository:RepositoryImageProps"
25833 },
25834 "@aws-cdk/aws-ecs.RequestCountScalingProps": {
25835 "assembly": "@aws-cdk/aws-ecs",
25836 "datatype": true,
25837 "docs": {
25838 "custom": {
25839 "exampleMetadata": "infused"
25840 },
25841 "example": "declare const target: elbv2.ApplicationTargetGroup;\ndeclare const service: ecs.BaseService;\nconst scaling = service.autoScaleTaskCount({ maxCapacity: 10 });\nscaling.scaleOnCpuUtilization('CpuScaling', {\n targetUtilizationPercent: 50,\n});\n\nscaling.scaleOnRequestCount('RequestScaling', {\n requestsPerTarget: 10000,\n targetGroup: target,\n});",
25842 "stability": "stable",
25843 "summary": "The properties for enabling scaling based on Application Load Balancer (ALB) request counts."
25844 },
25845 "fqn": "@aws-cdk/aws-ecs.RequestCountScalingProps",
25846 "interfaces": [
25847 "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps"
25848 ],
25849 "kind": "interface",
25850 "locationInModule": {
25851 "filename": "lib/base/scalable-task-count.ts",
25852 "line": 123
25853 },
25854 "name": "RequestCountScalingProps",
25855 "properties": [
25856 {
25857 "abstract": true,
25858 "docs": {
25859 "stability": "stable",
25860 "summary": "The number of ALB requests per target."
25861 },
25862 "immutable": true,
25863 "locationInModule": {
25864 "filename": "lib/base/scalable-task-count.ts",
25865 "line": 127
25866 },
25867 "name": "requestsPerTarget",
25868 "type": {
25869 "primitive": "number"
25870 }
25871 },
25872 {
25873 "abstract": true,
25874 "docs": {
25875 "stability": "stable",
25876 "summary": "The ALB target group name."
25877 },
25878 "immutable": true,
25879 "locationInModule": {
25880 "filename": "lib/base/scalable-task-count.ts",
25881 "line": 132
25882 },
25883 "name": "targetGroup",
25884 "type": {
25885 "fqn": "@aws-cdk/aws-elasticloadbalancingv2.ApplicationTargetGroup"
25886 }
25887 }
25888 ],
25889 "symbolId": "lib/base/scalable-task-count:RequestCountScalingProps"
25890 },
25891 "@aws-cdk/aws-ecs.RuntimePlatform": {
25892 "assembly": "@aws-cdk/aws-ecs",
25893 "datatype": true,
25894 "docs": {
25895 "custom": {
25896 "exampleMetadata": "infused"
25897 },
25898 "example": "// Create a Task Definition for the Windows container to start\nconst taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n runtimePlatform: {\n operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,\n cpuArchitecture: ecs.CpuArchitecture.X86_64,\n },\n cpu: 1024,\n memoryLimitMiB: 2048,\n});\n\ntaskDefinition.addContainer('windowsservercore', {\n logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),\n portMappings: [{ containerPort: 80 }],\n image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),\n});",
25899 "stability": "stable",
25900 "summary": "The interface for Runtime Platform."
25901 },
25902 "fqn": "@aws-cdk/aws-ecs.RuntimePlatform",
25903 "kind": "interface",
25904 "locationInModule": {
25905 "filename": "lib/runtime-platform.ts",
25906 "line": 97
25907 },
25908 "name": "RuntimePlatform",
25909 "properties": [
25910 {
25911 "abstract": true,
25912 "docs": {
25913 "default": "- Undefined.",
25914 "stability": "stable",
25915 "summary": "The CpuArchitecture for Fargate Runtime Platform."
25916 },
25917 "immutable": true,
25918 "locationInModule": {
25919 "filename": "lib/runtime-platform.ts",
25920 "line": 103
25921 },
25922 "name": "cpuArchitecture",
25923 "optional": true,
25924 "type": {
25925 "fqn": "@aws-cdk/aws-ecs.CpuArchitecture"
25926 }
25927 },
25928 {
25929 "abstract": true,
25930 "docs": {
25931 "default": "- Undefined.",
25932 "stability": "stable",
25933 "summary": "The operating system for Fargate Runtime Platform."
25934 },
25935 "immutable": true,
25936 "locationInModule": {
25937 "filename": "lib/runtime-platform.ts",
25938 "line": 110
25939 },
25940 "name": "operatingSystemFamily",
25941 "optional": true,
25942 "type": {
25943 "fqn": "@aws-cdk/aws-ecs.OperatingSystemFamily"
25944 }
25945 }
25946 ],
25947 "symbolId": "lib/runtime-platform:RuntimePlatform"
25948 },
25949 "@aws-cdk/aws-ecs.S3EnvironmentFile": {
25950 "assembly": "@aws-cdk/aws-ecs",
25951 "base": "@aws-cdk/aws-ecs.EnvironmentFile",
25952 "docs": {
25953 "stability": "stable",
25954 "summary": "Environment file from S3.",
25955 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as s3 from '@aws-cdk/aws-s3';\n\ndeclare const bucket: s3.Bucket;\nconst s3EnvironmentFile = new ecs.S3EnvironmentFile(bucket, 'key', /* all optional props */ 'objectVersion');",
25956 "custom": {
25957 "exampleMetadata": "fixture=_generated"
25958 }
25959 },
25960 "fqn": "@aws-cdk/aws-ecs.S3EnvironmentFile",
25961 "initializer": {
25962 "docs": {
25963 "stability": "stable"
25964 },
25965 "locationInModule": {
25966 "filename": "lib/environment-file.ts",
25967 "line": 83
25968 },
25969 "parameters": [
25970 {
25971 "name": "bucket",
25972 "type": {
25973 "fqn": "@aws-cdk/aws-s3.IBucket"
25974 }
25975 },
25976 {
25977 "name": "key",
25978 "type": {
25979 "primitive": "string"
25980 }
25981 },
25982 {
25983 "name": "objectVersion",
25984 "optional": true,
25985 "type": {
25986 "primitive": "string"
25987 }
25988 }
25989 ]
25990 },
25991 "kind": "class",
25992 "locationInModule": {
25993 "filename": "lib/environment-file.ts",
25994 "line": 80
25995 },
25996 "methods": [
25997 {
25998 "docs": {
25999 "stability": "stable",
26000 "summary": "Called when the container is initialized to allow this object to bind to the stack."
26001 },
26002 "locationInModule": {
26003 "filename": "lib/environment-file.ts",
26004 "line": 93
26005 },
26006 "name": "bind",
26007 "overrides": "@aws-cdk/aws-ecs.EnvironmentFile",
26008 "parameters": [
26009 {
26010 "name": "_scope",
26011 "type": {
26012 "fqn": "@aws-cdk/core.Construct"
26013 }
26014 }
26015 ],
26016 "returns": {
26017 "type": {
26018 "fqn": "@aws-cdk/aws-ecs.EnvironmentFileConfig"
26019 }
26020 }
26021 }
26022 ],
26023 "name": "S3EnvironmentFile",
26024 "symbolId": "lib/environment-file:S3EnvironmentFile"
26025 },
26026 "@aws-cdk/aws-ecs.ScalableTaskCount": {
26027 "assembly": "@aws-cdk/aws-ecs",
26028 "base": "@aws-cdk/aws-applicationautoscaling.BaseScalableAttribute",
26029 "docs": {
26030 "custom": {
26031 "exampleMetadata": "infused"
26032 },
26033 "example": "declare const cluster: ecs.Cluster;\nconst loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {\n cluster,\n memoryLimitMiB: 1024,\n desiredCount: 1,\n cpu: 512,\n taskImageOptions: {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n },\n});\n\nconst scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({\n minCapacity: 1,\n maxCapacity: 20,\n});\n\nscalableTarget.scaleOnCpuUtilization('CpuScaling', {\n targetUtilizationPercent: 50,\n});\n\nscalableTarget.scaleOnMemoryUtilization('MemoryScaling', {\n targetUtilizationPercent: 50,\n});",
26034 "stability": "stable",
26035 "summary": "The scalable attribute representing task count."
26036 },
26037 "fqn": "@aws-cdk/aws-ecs.ScalableTaskCount",
26038 "initializer": {
26039 "docs": {
26040 "stability": "stable",
26041 "summary": "Constructs a new instance of the ScalableTaskCount class."
26042 },
26043 "locationInModule": {
26044 "filename": "lib/base/scalable-task-count.ts",
26045 "line": 21
26046 },
26047 "parameters": [
26048 {
26049 "name": "scope",
26050 "type": {
26051 "fqn": "constructs.Construct"
26052 }
26053 },
26054 {
26055 "name": "id",
26056 "type": {
26057 "primitive": "string"
26058 }
26059 },
26060 {
26061 "name": "props",
26062 "type": {
26063 "fqn": "@aws-cdk/aws-ecs.ScalableTaskCountProps"
26064 }
26065 }
26066 ]
26067 },
26068 "kind": "class",
26069 "locationInModule": {
26070 "filename": "lib/base/scalable-task-count.ts",
26071 "line": 16
26072 },
26073 "methods": [
26074 {
26075 "docs": {
26076 "stability": "stable",
26077 "summary": "Scales in or out to achieve a target CPU utilization."
26078 },
26079 "locationInModule": {
26080 "filename": "lib/base/scalable-task-count.ts",
26081 "line": 42
26082 },
26083 "name": "scaleOnCpuUtilization",
26084 "parameters": [
26085 {
26086 "name": "id",
26087 "type": {
26088 "primitive": "string"
26089 }
26090 },
26091 {
26092 "name": "props",
26093 "type": {
26094 "fqn": "@aws-cdk/aws-ecs.CpuUtilizationScalingProps"
26095 }
26096 }
26097 ]
26098 },
26099 {
26100 "docs": {
26101 "stability": "stable",
26102 "summary": "Scales in or out to achieve a target memory utilization."
26103 },
26104 "locationInModule": {
26105 "filename": "lib/base/scalable-task-count.ts",
26106 "line": 56
26107 },
26108 "name": "scaleOnMemoryUtilization",
26109 "parameters": [
26110 {
26111 "name": "id",
26112 "type": {
26113 "primitive": "string"
26114 }
26115 },
26116 {
26117 "name": "props",
26118 "type": {
26119 "fqn": "@aws-cdk/aws-ecs.MemoryUtilizationScalingProps"
26120 }
26121 }
26122 ]
26123 },
26124 {
26125 "docs": {
26126 "stability": "stable",
26127 "summary": "Scales in or out based on a specified metric value."
26128 },
26129 "locationInModule": {
26130 "filename": "lib/base/scalable-task-count.ts",
26131 "line": 35
26132 },
26133 "name": "scaleOnMetric",
26134 "parameters": [
26135 {
26136 "name": "id",
26137 "type": {
26138 "primitive": "string"
26139 }
26140 },
26141 {
26142 "name": "props",
26143 "type": {
26144 "fqn": "@aws-cdk/aws-applicationautoscaling.BasicStepScalingPolicyProps"
26145 }
26146 }
26147 ]
26148 },
26149 {
26150 "docs": {
26151 "stability": "stable",
26152 "summary": "Scales in or out to achieve a target Application Load Balancer request count per target."
26153 },
26154 "locationInModule": {
26155 "filename": "lib/base/scalable-task-count.ts",
26156 "line": 70
26157 },
26158 "name": "scaleOnRequestCount",
26159 "parameters": [
26160 {
26161 "name": "id",
26162 "type": {
26163 "primitive": "string"
26164 }
26165 },
26166 {
26167 "name": "props",
26168 "type": {
26169 "fqn": "@aws-cdk/aws-ecs.RequestCountScalingProps"
26170 }
26171 }
26172 ]
26173 },
26174 {
26175 "docs": {
26176 "stability": "stable",
26177 "summary": "Scales in or out based on a specified scheduled time."
26178 },
26179 "locationInModule": {
26180 "filename": "lib/base/scalable-task-count.ts",
26181 "line": 28
26182 },
26183 "name": "scaleOnSchedule",
26184 "parameters": [
26185 {
26186 "name": "id",
26187 "type": {
26188 "primitive": "string"
26189 }
26190 },
26191 {
26192 "name": "props",
26193 "type": {
26194 "fqn": "@aws-cdk/aws-applicationautoscaling.ScalingSchedule"
26195 }
26196 }
26197 ]
26198 },
26199 {
26200 "docs": {
26201 "stability": "stable",
26202 "summary": "Scales in or out to achieve a target on a custom metric."
26203 },
26204 "locationInModule": {
26205 "filename": "lib/base/scalable-task-count.ts",
26206 "line": 88
26207 },
26208 "name": "scaleToTrackCustomMetric",
26209 "parameters": [
26210 {
26211 "name": "id",
26212 "type": {
26213 "primitive": "string"
26214 }
26215 },
26216 {
26217 "name": "props",
26218 "type": {
26219 "fqn": "@aws-cdk/aws-ecs.TrackCustomMetricProps"
26220 }
26221 }
26222 ]
26223 }
26224 ],
26225 "name": "ScalableTaskCount",
26226 "symbolId": "lib/base/scalable-task-count:ScalableTaskCount"
26227 },
26228 "@aws-cdk/aws-ecs.ScalableTaskCountProps": {
26229 "assembly": "@aws-cdk/aws-ecs",
26230 "datatype": true,
26231 "docs": {
26232 "stability": "stable",
26233 "summary": "The properties of a scalable attribute representing task count.",
26234 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as appscaling from '@aws-cdk/aws-applicationautoscaling';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst scalableTaskCountProps: ecs.ScalableTaskCountProps = {\n dimension: 'dimension',\n maxCapacity: 123,\n resourceId: 'resourceId',\n role: role,\n serviceNamespace: appscaling.ServiceNamespace.ECS,\n\n // the properties below are optional\n minCapacity: 123,\n};",
26235 "custom": {
26236 "exampleMetadata": "fixture=_generated"
26237 }
26238 },
26239 "fqn": "@aws-cdk/aws-ecs.ScalableTaskCountProps",
26240 "interfaces": [
26241 "@aws-cdk/aws-applicationautoscaling.BaseScalableAttributeProps"
26242 ],
26243 "kind": "interface",
26244 "locationInModule": {
26245 "filename": "lib/base/scalable-task-count.ts",
26246 "line": 9
26247 },
26248 "name": "ScalableTaskCountProps",
26249 "symbolId": "lib/base/scalable-task-count:ScalableTaskCountProps"
26250 },
26251 "@aws-cdk/aws-ecs.Scope": {
26252 "assembly": "@aws-cdk/aws-ecs",
26253 "docs": {
26254 "remarks": "Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops.\nDocker volumes that are scoped as shared persist after the task stops.",
26255 "stability": "stable",
26256 "summary": "The scope for the Docker volume that determines its lifecycle."
26257 },
26258 "fqn": "@aws-cdk/aws-ecs.Scope",
26259 "kind": "enum",
26260 "locationInModule": {
26261 "filename": "lib/base/task-definition.ts",
26262 "line": 1055
26263 },
26264 "members": [
26265 {
26266 "docs": {
26267 "stability": "stable",
26268 "summary": "Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops."
26269 },
26270 "name": "TASK"
26271 },
26272 {
26273 "docs": {
26274 "stability": "stable",
26275 "summary": "Docker volumes that are scoped as shared persist after the task stops."
26276 },
26277 "name": "SHARED"
26278 }
26279 ],
26280 "name": "Scope",
26281 "symbolId": "lib/base/task-definition:Scope"
26282 },
26283 "@aws-cdk/aws-ecs.ScratchSpace": {
26284 "assembly": "@aws-cdk/aws-ecs",
26285 "datatype": true,
26286 "docs": {
26287 "stability": "stable",
26288 "summary": "The temporary disk space mounted to the container.",
26289 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst scratchSpace: ecs.ScratchSpace = {\n containerPath: 'containerPath',\n name: 'name',\n readOnly: false,\n sourcePath: 'sourcePath',\n};",
26290 "custom": {
26291 "exampleMetadata": "fixture=_generated"
26292 }
26293 },
26294 "fqn": "@aws-cdk/aws-ecs.ScratchSpace",
26295 "kind": "interface",
26296 "locationInModule": {
26297 "filename": "lib/container-definition.ts",
26298 "line": 1038
26299 },
26300 "name": "ScratchSpace",
26301 "properties": [
26302 {
26303 "abstract": true,
26304 "docs": {
26305 "stability": "stable",
26306 "summary": "The path on the container to mount the scratch volume at."
26307 },
26308 "immutable": true,
26309 "locationInModule": {
26310 "filename": "lib/container-definition.ts",
26311 "line": 1042
26312 },
26313 "name": "containerPath",
26314 "type": {
26315 "primitive": "string"
26316 }
26317 },
26318 {
26319 "abstract": true,
26320 "docs": {
26321 "remarks": "Must be a volume name referenced in the name parameter of task definition volume.",
26322 "stability": "stable",
26323 "summary": "The name of the scratch volume to mount."
26324 },
26325 "immutable": true,
26326 "locationInModule": {
26327 "filename": "lib/container-definition.ts",
26328 "line": 1054
26329 },
26330 "name": "name",
26331 "type": {
26332 "primitive": "string"
26333 }
26334 },
26335 {
26336 "abstract": true,
26337 "docs": {
26338 "remarks": "If this value is true, the container has read-only access to the scratch volume.\nIf this value is false, then the container can write to the scratch volume.",
26339 "stability": "stable",
26340 "summary": "Specifies whether to give the container read-only access to the scratch volume."
26341 },
26342 "immutable": true,
26343 "locationInModule": {
26344 "filename": "lib/container-definition.ts",
26345 "line": 1049
26346 },
26347 "name": "readOnly",
26348 "type": {
26349 "primitive": "boolean"
26350 }
26351 },
26352 {
26353 "abstract": true,
26354 "docs": {
26355 "stability": "stable"
26356 },
26357 "immutable": true,
26358 "locationInModule": {
26359 "filename": "lib/container-definition.ts",
26360 "line": 1050
26361 },
26362 "name": "sourcePath",
26363 "type": {
26364 "primitive": "string"
26365 }
26366 }
26367 ],
26368 "symbolId": "lib/container-definition:ScratchSpace"
26369 },
26370 "@aws-cdk/aws-ecs.Secret": {
26371 "abstract": true,
26372 "assembly": "@aws-cdk/aws-ecs",
26373 "docs": {
26374 "custom": {
26375 "exampleMetadata": "infused"
26376 },
26377 "example": "declare const secret: secretsmanager.Secret;\ndeclare const dbSecret: secretsmanager.Secret;\ndeclare const parameter: ssm.StringParameter;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const s3Bucket: s3.Bucket;\n\nconst newContainer = taskDefinition.addContainer('container', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n environment: { // clear text, not for sensitive data\n STAGE: 'prod',\n },\n environmentFiles: [ // list of environment files hosted either on local disk or S3\n ecs.EnvironmentFile.fromAsset('./demo-env-file.env'),\n ecs.EnvironmentFile.fromBucket(s3Bucket, 'assets/demo-env-file.env'),\n ],\n secrets: { // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store at container start-up.\n SECRET: ecs.Secret.fromSecretsManager(secret),\n DB_PASSWORD: ecs.Secret.fromSecretsManager(dbSecret, 'password'), // Reference a specific JSON field, (requires platform version 1.4.0 or later for Fargate tasks)\n API_KEY: ecs.Secret.fromSecretsManagerVersion(secret, { versionId: '12345' }, 'apiKey'), // Reference a specific version of the secret by its version id or version stage (requires platform version 1.4.0 or later for Fargate tasks)\n PARAMETER: ecs.Secret.fromSsmParameter(parameter),\n },\n});\nnewContainer.addEnvironment('QUEUE_NAME', 'MyQueue');",
26378 "stability": "stable",
26379 "summary": "A secret environment variable."
26380 },
26381 "fqn": "@aws-cdk/aws-ecs.Secret",
26382 "initializer": {
26383 "docs": {
26384 "stability": "stable"
26385 }
26386 },
26387 "kind": "class",
26388 "locationInModule": {
26389 "filename": "lib/container-definition.ts",
26390 "line": 38
26391 },
26392 "methods": [
26393 {
26394 "docs": {
26395 "stability": "stable",
26396 "summary": "Creates a environment variable value from a secret stored in AWS Secrets Manager."
26397 },
26398 "locationInModule": {
26399 "filename": "lib/container-definition.ts",
26400 "line": 60
26401 },
26402 "name": "fromSecretsManager",
26403 "parameters": [
26404 {
26405 "docs": {
26406 "summary": "the secret stored in AWS Secrets Manager."
26407 },
26408 "name": "secret",
26409 "type": {
26410 "fqn": "@aws-cdk/aws-secretsmanager.ISecret"
26411 }
26412 },
26413 {
26414 "docs": {
26415 "remarks": "Only values in JSON format are supported.\nIf you do not specify a JSON field, then the full content of the secret is\nused.",
26416 "summary": "the name of the field with the value that you want to set as the environment variable value."
26417 },
26418 "name": "field",
26419 "optional": true,
26420 "type": {
26421 "primitive": "string"
26422 }
26423 }
26424 ],
26425 "returns": {
26426 "type": {
26427 "fqn": "@aws-cdk/aws-ecs.Secret"
26428 }
26429 },
26430 "static": true
26431 },
26432 {
26433 "docs": {
26434 "stability": "stable",
26435 "summary": "Creates a environment variable value from a secret stored in AWS Secrets Manager."
26436 },
26437 "locationInModule": {
26438 "filename": "lib/container-definition.ts",
26439 "line": 79
26440 },
26441 "name": "fromSecretsManagerVersion",
26442 "parameters": [
26443 {
26444 "docs": {
26445 "summary": "the secret stored in AWS Secrets Manager."
26446 },
26447 "name": "secret",
26448 "type": {
26449 "fqn": "@aws-cdk/aws-secretsmanager.ISecret"
26450 }
26451 },
26452 {
26453 "docs": {
26454 "summary": "the version information to reference the secret."
26455 },
26456 "name": "versionInfo",
26457 "type": {
26458 "fqn": "@aws-cdk/aws-ecs.SecretVersionInfo"
26459 }
26460 },
26461 {
26462 "docs": {
26463 "remarks": "Only values in JSON format are supported.\nIf you do not specify a JSON field, then the full content of the secret is\nused.",
26464 "summary": "the name of the field with the value that you want to set as the environment variable value."
26465 },
26466 "name": "field",
26467 "optional": true,
26468 "type": {
26469 "primitive": "string"
26470 }
26471 }
26472 ],
26473 "returns": {
26474 "type": {
26475 "fqn": "@aws-cdk/aws-ecs.Secret"
26476 }
26477 },
26478 "static": true
26479 },
26480 {
26481 "docs": {
26482 "stability": "stable",
26483 "summary": "Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store."
26484 },
26485 "locationInModule": {
26486 "filename": "lib/container-definition.ts",
26487 "line": 43
26488 },
26489 "name": "fromSsmParameter",
26490 "parameters": [
26491 {
26492 "name": "parameter",
26493 "type": {
26494 "fqn": "@aws-cdk/aws-ssm.IParameter"
26495 }
26496 }
26497 ],
26498 "returns": {
26499 "type": {
26500 "fqn": "@aws-cdk/aws-ecs.Secret"
26501 }
26502 },
26503 "static": true
26504 },
26505 {
26506 "abstract": true,
26507 "docs": {
26508 "stability": "stable",
26509 "summary": "Grants reading the secret to a principal."
26510 },
26511 "locationInModule": {
26512 "filename": "lib/container-definition.ts",
26513 "line": 100
26514 },
26515 "name": "grantRead",
26516 "parameters": [
26517 {
26518 "name": "grantee",
26519 "type": {
26520 "fqn": "@aws-cdk/aws-iam.IGrantable"
26521 }
26522 }
26523 ],
26524 "returns": {
26525 "type": {
26526 "fqn": "@aws-cdk/aws-iam.Grant"
26527 }
26528 }
26529 }
26530 ],
26531 "name": "Secret",
26532 "properties": [
26533 {
26534 "abstract": true,
26535 "docs": {
26536 "stability": "stable",
26537 "summary": "The ARN of the secret."
26538 },
26539 "immutable": true,
26540 "locationInModule": {
26541 "filename": "lib/container-definition.ts",
26542 "line": 90
26543 },
26544 "name": "arn",
26545 "type": {
26546 "primitive": "string"
26547 }
26548 },
26549 {
26550 "abstract": true,
26551 "docs": {
26552 "stability": "stable",
26553 "summary": "Whether this secret uses a specific JSON field."
26554 },
26555 "immutable": true,
26556 "locationInModule": {
26557 "filename": "lib/container-definition.ts",
26558 "line": 95
26559 },
26560 "name": "hasField",
26561 "optional": true,
26562 "type": {
26563 "primitive": "boolean"
26564 }
26565 }
26566 ],
26567 "symbolId": "lib/container-definition:Secret"
26568 },
26569 "@aws-cdk/aws-ecs.SecretVersionInfo": {
26570 "assembly": "@aws-cdk/aws-ecs",
26571 "datatype": true,
26572 "docs": {
26573 "custom": {
26574 "exampleMetadata": "infused"
26575 },
26576 "example": "declare const secret: secretsmanager.Secret;\ndeclare const dbSecret: secretsmanager.Secret;\ndeclare const parameter: ssm.StringParameter;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const s3Bucket: s3.Bucket;\n\nconst newContainer = taskDefinition.addContainer('container', {\n image: ecs.ContainerImage.fromRegistry(\"amazon/amazon-ecs-sample\"),\n memoryLimitMiB: 1024,\n environment: { // clear text, not for sensitive data\n STAGE: 'prod',\n },\n environmentFiles: [ // list of environment files hosted either on local disk or S3\n ecs.EnvironmentFile.fromAsset('./demo-env-file.env'),\n ecs.EnvironmentFile.fromBucket(s3Bucket, 'assets/demo-env-file.env'),\n ],\n secrets: { // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store at container start-up.\n SECRET: ecs.Secret.fromSecretsManager(secret),\n DB_PASSWORD: ecs.Secret.fromSecretsManager(dbSecret, 'password'), // Reference a specific JSON field, (requires platform version 1.4.0 or later for Fargate tasks)\n API_KEY: ecs.Secret.fromSecretsManagerVersion(secret, { versionId: '12345' }, 'apiKey'), // Reference a specific version of the secret by its version id or version stage (requires platform version 1.4.0 or later for Fargate tasks)\n PARAMETER: ecs.Secret.fromSsmParameter(parameter),\n },\n});\nnewContainer.addEnvironment('QUEUE_NAME', 'MyQueue');",
26577 "stability": "stable",
26578 "summary": "Specify the secret's version id or version stage."
26579 },
26580 "fqn": "@aws-cdk/aws-ecs.SecretVersionInfo",
26581 "kind": "interface",
26582 "locationInModule": {
26583 "filename": "lib/container-definition.ts",
26584 "line": 20
26585 },
26586 "name": "SecretVersionInfo",
26587 "properties": [
26588 {
26589 "abstract": true,
26590 "docs": {
26591 "default": "- use default version id",
26592 "stability": "stable",
26593 "summary": "version id of the secret."
26594 },
26595 "immutable": true,
26596 "locationInModule": {
26597 "filename": "lib/container-definition.ts",
26598 "line": 26
26599 },
26600 "name": "versionId",
26601 "optional": true,
26602 "type": {
26603 "primitive": "string"
26604 }
26605 },
26606 {
26607 "abstract": true,
26608 "docs": {
26609 "default": "- use default version stage",
26610 "stability": "stable",
26611 "summary": "version stage of the secret."
26612 },
26613 "immutable": true,
26614 "locationInModule": {
26615 "filename": "lib/container-definition.ts",
26616 "line": 32
26617 },
26618 "name": "versionStage",
26619 "optional": true,
26620 "type": {
26621 "primitive": "string"
26622 }
26623 }
26624 ],
26625 "symbolId": "lib/container-definition:SecretVersionInfo"
26626 },
26627 "@aws-cdk/aws-ecs.SplunkLogDriver": {
26628 "assembly": "@aws-cdk/aws-ecs",
26629 "base": "@aws-cdk/aws-ecs.LogDriver",
26630 "docs": {
26631 "stability": "stable",
26632 "summary": "A log driver that sends log information to splunk Logs.",
26633 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const secret: ecs.Secret;\ndeclare const secretValue: cdk.SecretValue;\nconst splunkLogDriver = new ecs.SplunkLogDriver({\n url: 'url',\n\n // the properties below are optional\n caName: 'caName',\n caPath: 'caPath',\n env: ['env'],\n envRegex: 'envRegex',\n format: ecs.SplunkLogFormat.INLINE,\n gzip: false,\n gzipLevel: 123,\n index: 'index',\n insecureSkipVerify: 'insecureSkipVerify',\n labels: ['labels'],\n secretToken: secret,\n source: 'source',\n sourceType: 'sourceType',\n tag: 'tag',\n token: secretValue,\n verifyConnection: false,\n});",
26634 "custom": {
26635 "exampleMetadata": "fixture=_generated"
26636 }
26637 },
26638 "fqn": "@aws-cdk/aws-ecs.SplunkLogDriver",
26639 "initializer": {
26640 "docs": {
26641 "stability": "stable",
26642 "summary": "Constructs a new instance of the SplunkLogDriver class."
26643 },
26644 "locationInModule": {
26645 "filename": "lib/log-drivers/splunk-log-driver.ts",
26646 "line": 139
26647 },
26648 "parameters": [
26649 {
26650 "docs": {
26651 "summary": "the splunk log driver configuration options."
26652 },
26653 "name": "props",
26654 "type": {
26655 "fqn": "@aws-cdk/aws-ecs.SplunkLogDriverProps"
26656 }
26657 }
26658 ]
26659 },
26660 "kind": "class",
26661 "locationInModule": {
26662 "filename": "lib/log-drivers/splunk-log-driver.ts",
26663 "line": 133
26664 },
26665 "methods": [
26666 {
26667 "docs": {
26668 "stability": "stable",
26669 "summary": "Called when the log driver is configured on a container."
26670 },
26671 "locationInModule": {
26672 "filename": "lib/log-drivers/splunk-log-driver.ts",
26673 "line": 153
26674 },
26675 "name": "bind",
26676 "overrides": "@aws-cdk/aws-ecs.LogDriver",
26677 "parameters": [
26678 {
26679 "name": "_scope",
26680 "type": {
26681 "fqn": "@aws-cdk/core.Construct"
26682 }
26683 },
26684 {
26685 "name": "_containerDefinition",
26686 "type": {
26687 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
26688 }
26689 }
26690 ],
26691 "returns": {
26692 "type": {
26693 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
26694 }
26695 }
26696 }
26697 ],
26698 "name": "SplunkLogDriver",
26699 "symbolId": "lib/log-drivers/splunk-log-driver:SplunkLogDriver"
26700 },
26701 "@aws-cdk/aws-ecs.SplunkLogDriverProps": {
26702 "assembly": "@aws-cdk/aws-ecs",
26703 "datatype": true,
26704 "docs": {
26705 "custom": {
26706 "exampleMetadata": "infused"
26707 },
26708 "example": "// Create a Task Definition for the container to start\nconst taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('example-image'),\n memoryLimitMiB: 256,\n logging: ecs.LogDrivers.splunk({\n token: SecretValue.secretsManager('my-splunk-token'),\n url: 'my-splunk-url',\n }),\n});",
26709 "remarks": "[Source](https://docs.docker.com/config/containers/logging/splunk/)",
26710 "stability": "stable",
26711 "summary": "Specifies the splunk log driver configuration options."
26712 },
26713 "fqn": "@aws-cdk/aws-ecs.SplunkLogDriverProps",
26714 "interfaces": [
26715 "@aws-cdk/aws-ecs.BaseLogDriverProps"
26716 ],
26717 "kind": "interface",
26718 "locationInModule": {
26719 "filename": "lib/log-drivers/splunk-log-driver.ts",
26720 "line": 25
26721 },
26722 "name": "SplunkLogDriverProps",
26723 "properties": [
26724 {
26725 "abstract": true,
26726 "docs": {
26727 "stability": "stable",
26728 "summary": "Path to your Splunk Enterprise, self-service Splunk Cloud instance, or Splunk Cloud managed cluster (including port and scheme used by HTTP Event Collector) in one of the following formats: https://your_splunk_instance:8088 or https://input-prd-p-XXXXXXX.cloud.splunk.com:8088 or https://http-inputs-XXXXXXXX.splunkcloud.com."
26729 },
26730 "immutable": true,
26731 "locationInModule": {
26732 "filename": "lib/log-drivers/splunk-log-driver.ts",
26733 "line": 55
26734 },
26735 "name": "url",
26736 "type": {
26737 "primitive": "string"
26738 }
26739 },
26740 {
26741 "abstract": true,
26742 "docs": {
26743 "default": "- The hostname of the splunk-url",
26744 "stability": "stable",
26745 "summary": "Name to use for validating server certificate."
26746 },
26747 "immutable": true,
26748 "locationInModule": {
26749 "filename": "lib/log-drivers/splunk-log-driver.ts",
26750 "line": 90
26751 },
26752 "name": "caName",
26753 "optional": true,
26754 "type": {
26755 "primitive": "string"
26756 }
26757 },
26758 {
26759 "abstract": true,
26760 "docs": {
26761 "default": "- caPath not set.",
26762 "stability": "stable",
26763 "summary": "Path to root certificate."
26764 },
26765 "immutable": true,
26766 "locationInModule": {
26767 "filename": "lib/log-drivers/splunk-log-driver.ts",
26768 "line": 83
26769 },
26770 "name": "caPath",
26771 "optional": true,
26772 "type": {
26773 "primitive": "string"
26774 }
26775 },
26776 {
26777 "abstract": true,
26778 "docs": {
26779 "default": "- inline",
26780 "remarks": "Can be inline, json or raw.",
26781 "stability": "stable",
26782 "summary": "Message format."
26783 },
26784 "immutable": true,
26785 "locationInModule": {
26786 "filename": "lib/log-drivers/splunk-log-driver.ts",
26787 "line": 104
26788 },
26789 "name": "format",
26790 "optional": true,
26791 "type": {
26792 "fqn": "@aws-cdk/aws-ecs.SplunkLogFormat"
26793 }
26794 },
26795 {
26796 "abstract": true,
26797 "docs": {
26798 "default": "- false",
26799 "stability": "stable",
26800 "summary": "Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance."
26801 },
26802 "immutable": true,
26803 "locationInModule": {
26804 "filename": "lib/log-drivers/splunk-log-driver.ts",
26805 "line": 119
26806 },
26807 "name": "gzip",
26808 "optional": true,
26809 "type": {
26810 "primitive": "boolean"
26811 }
26812 },
26813 {
26814 "abstract": true,
26815 "docs": {
26816 "default": "- -1 (Default Compression)",
26817 "remarks": "Valid values are -1 (default), 0 (no compression),\n1 (best speed) ... 9 (best compression).",
26818 "stability": "stable",
26819 "summary": "Set compression level for gzip."
26820 },
26821 "immutable": true,
26822 "locationInModule": {
26823 "filename": "lib/log-drivers/splunk-log-driver.ts",
26824 "line": 127
26825 },
26826 "name": "gzipLevel",
26827 "optional": true,
26828 "type": {
26829 "primitive": "number"
26830 }
26831 },
26832 {
26833 "abstract": true,
26834 "docs": {
26835 "default": "- index not set.",
26836 "stability": "stable",
26837 "summary": "Event index."
26838 },
26839 "immutable": true,
26840 "locationInModule": {
26841 "filename": "lib/log-drivers/splunk-log-driver.ts",
26842 "line": 76
26843 },
26844 "name": "index",
26845 "optional": true,
26846 "type": {
26847 "primitive": "string"
26848 }
26849 },
26850 {
26851 "abstract": true,
26852 "docs": {
26853 "default": "- insecureSkipVerify not set.",
26854 "stability": "stable",
26855 "summary": "Ignore server certificate validation."
26856 },
26857 "immutable": true,
26858 "locationInModule": {
26859 "filename": "lib/log-drivers/splunk-log-driver.ts",
26860 "line": 97
26861 },
26862 "name": "insecureSkipVerify",
26863 "optional": true,
26864 "type": {
26865 "primitive": "string"
26866 }
26867 },
26868 {
26869 "abstract": true,
26870 "docs": {
26871 "default": "- If secret token is not provided, then the value provided in `token` will be used.",
26872 "remarks": "The splunk-token is added to the SecretOptions property of the Log Driver Configuration. So the secret value will not be\nresolved or viewable as plain text.\n\nPlease provide at least one of `token` or `secretToken`.",
26873 "stability": "stable",
26874 "summary": "Splunk HTTP Event Collector token (Secret)."
26875 },
26876 "immutable": true,
26877 "locationInModule": {
26878 "filename": "lib/log-drivers/splunk-log-driver.ts",
26879 "line": 47
26880 },
26881 "name": "secretToken",
26882 "optional": true,
26883 "type": {
26884 "fqn": "@aws-cdk/aws-ecs.Secret"
26885 }
26886 },
26887 {
26888 "abstract": true,
26889 "docs": {
26890 "default": "- source not set.",
26891 "stability": "stable",
26892 "summary": "Event source."
26893 },
26894 "immutable": true,
26895 "locationInModule": {
26896 "filename": "lib/log-drivers/splunk-log-driver.ts",
26897 "line": 62
26898 },
26899 "name": "source",
26900 "optional": true,
26901 "type": {
26902 "primitive": "string"
26903 }
26904 },
26905 {
26906 "abstract": true,
26907 "docs": {
26908 "default": "- sourceType not set.",
26909 "stability": "stable",
26910 "summary": "Event source type."
26911 },
26912 "immutable": true,
26913 "locationInModule": {
26914 "filename": "lib/log-drivers/splunk-log-driver.ts",
26915 "line": 69
26916 },
26917 "name": "sourceType",
26918 "optional": true,
26919 "type": {
26920 "primitive": "string"
26921 }
26922 },
26923 {
26924 "abstract": true,
26925 "docs": {
26926 "default": "- token not provided.",
26927 "deprecated": "Use {@link SplunkLogDriverProps.secretToken} instead.",
26928 "remarks": "The splunk-token is added to the Options property of the Log Driver Configuration. So the secret value will be resolved and\nviewable in plain text in the console.\n\nPlease provide at least one of `token` or `secretToken`.",
26929 "stability": "deprecated",
26930 "summary": "Splunk HTTP Event Collector token."
26931 },
26932 "immutable": true,
26933 "locationInModule": {
26934 "filename": "lib/log-drivers/splunk-log-driver.ts",
26935 "line": 36
26936 },
26937 "name": "token",
26938 "optional": true,
26939 "type": {
26940 "fqn": "@aws-cdk/core.SecretValue"
26941 }
26942 },
26943 {
26944 "abstract": true,
26945 "docs": {
26946 "default": "- true",
26947 "stability": "stable",
26948 "summary": "Verify on start, that docker can connect to Splunk server."
26949 },
26950 "immutable": true,
26951 "locationInModule": {
26952 "filename": "lib/log-drivers/splunk-log-driver.ts",
26953 "line": 111
26954 },
26955 "name": "verifyConnection",
26956 "optional": true,
26957 "type": {
26958 "primitive": "boolean"
26959 }
26960 }
26961 ],
26962 "symbolId": "lib/log-drivers/splunk-log-driver:SplunkLogDriverProps"
26963 },
26964 "@aws-cdk/aws-ecs.SplunkLogFormat": {
26965 "assembly": "@aws-cdk/aws-ecs",
26966 "docs": {
26967 "stability": "stable",
26968 "summary": "Log Message Format."
26969 },
26970 "fqn": "@aws-cdk/aws-ecs.SplunkLogFormat",
26971 "kind": "enum",
26972 "locationInModule": {
26973 "filename": "lib/log-drivers/splunk-log-driver.ts",
26974 "line": 14
26975 },
26976 "members": [
26977 {
26978 "docs": {
26979 "stability": "stable"
26980 },
26981 "name": "INLINE"
26982 },
26983 {
26984 "docs": {
26985 "stability": "stable"
26986 },
26987 "name": "JSON"
26988 },
26989 {
26990 "docs": {
26991 "stability": "stable"
26992 },
26993 "name": "RAW"
26994 }
26995 ],
26996 "name": "SplunkLogFormat",
26997 "symbolId": "lib/log-drivers/splunk-log-driver:SplunkLogFormat"
26998 },
26999 "@aws-cdk/aws-ecs.SyslogLogDriver": {
27000 "assembly": "@aws-cdk/aws-ecs",
27001 "base": "@aws-cdk/aws-ecs.LogDriver",
27002 "docs": {
27003 "stability": "stable",
27004 "summary": "A log driver that sends log information to syslog Logs.",
27005 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst syslogLogDriver = new ecs.SyslogLogDriver(/* all optional props */ {\n address: 'address',\n env: ['env'],\n envRegex: 'envRegex',\n facility: 'facility',\n format: 'format',\n labels: ['labels'],\n tag: 'tag',\n tlsCaCert: 'tlsCaCert',\n tlsCert: 'tlsCert',\n tlsKey: 'tlsKey',\n tlsSkipVerify: false,\n});",
27006 "custom": {
27007 "exampleMetadata": "fixture=_generated"
27008 }
27009 },
27010 "fqn": "@aws-cdk/aws-ecs.SyslogLogDriver",
27011 "initializer": {
27012 "docs": {
27013 "stability": "stable",
27014 "summary": "Constructs a new instance of the SyslogLogDriver class."
27015 },
27016 "locationInModule": {
27017 "filename": "lib/log-drivers/syslog-log-driver.ts",
27018 "line": 85
27019 },
27020 "parameters": [
27021 {
27022 "docs": {
27023 "summary": "the syslog log driver configuration options."
27024 },
27025 "name": "props",
27026 "optional": true,
27027 "type": {
27028 "fqn": "@aws-cdk/aws-ecs.SyslogLogDriverProps"
27029 }
27030 }
27031 ]
27032 },
27033 "kind": "class",
27034 "locationInModule": {
27035 "filename": "lib/log-drivers/syslog-log-driver.ts",
27036 "line": 79
27037 },
27038 "methods": [
27039 {
27040 "docs": {
27041 "stability": "stable",
27042 "summary": "Called when the log driver is configured on a container."
27043 },
27044 "locationInModule": {
27045 "filename": "lib/log-drivers/syslog-log-driver.ts",
27046 "line": 92
27047 },
27048 "name": "bind",
27049 "overrides": "@aws-cdk/aws-ecs.LogDriver",
27050 "parameters": [
27051 {
27052 "name": "_scope",
27053 "type": {
27054 "fqn": "@aws-cdk/core.Construct"
27055 }
27056 },
27057 {
27058 "name": "_containerDefinition",
27059 "type": {
27060 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27061 }
27062 }
27063 ],
27064 "returns": {
27065 "type": {
27066 "fqn": "@aws-cdk/aws-ecs.LogDriverConfig"
27067 }
27068 }
27069 }
27070 ],
27071 "name": "SyslogLogDriver",
27072 "symbolId": "lib/log-drivers/syslog-log-driver:SyslogLogDriver"
27073 },
27074 "@aws-cdk/aws-ecs.SyslogLogDriverProps": {
27075 "assembly": "@aws-cdk/aws-ecs",
27076 "datatype": true,
27077 "docs": {
27078 "remarks": "[Source](https://docs.docker.com/config/containers/logging/syslog/)",
27079 "stability": "stable",
27080 "summary": "Specifies the syslog log driver configuration options.",
27081 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst syslogLogDriverProps: ecs.SyslogLogDriverProps = {\n address: 'address',\n env: ['env'],\n envRegex: 'envRegex',\n facility: 'facility',\n format: 'format',\n labels: ['labels'],\n tag: 'tag',\n tlsCaCert: 'tlsCaCert',\n tlsCert: 'tlsCert',\n tlsKey: 'tlsKey',\n tlsSkipVerify: false,\n};",
27082 "custom": {
27083 "exampleMetadata": "fixture=_generated"
27084 }
27085 },
27086 "fqn": "@aws-cdk/aws-ecs.SyslogLogDriverProps",
27087 "interfaces": [
27088 "@aws-cdk/aws-ecs.BaseLogDriverProps"
27089 ],
27090 "kind": "interface",
27091 "locationInModule": {
27092 "filename": "lib/log-drivers/syslog-log-driver.ts",
27093 "line": 15
27094 },
27095 "name": "SyslogLogDriverProps",
27096 "properties": [
27097 {
27098 "abstract": true,
27099 "docs": {
27100 "default": "- If the transport is tcp, udp, or tcp+tls, the default port is 514.",
27101 "remarks": "The URI specifier may be\n[tcp|udp|tcp+tls]://host:port, unix://path, or unixgram://path.",
27102 "stability": "stable",
27103 "summary": "The address of an external syslog server."
27104 },
27105 "immutable": true,
27106 "locationInModule": {
27107 "filename": "lib/log-drivers/syslog-log-driver.ts",
27108 "line": 22
27109 },
27110 "name": "address",
27111 "optional": true,
27112 "type": {
27113 "primitive": "string"
27114 }
27115 },
27116 {
27117 "abstract": true,
27118 "docs": {
27119 "default": "- facility not set",
27120 "remarks": "Can be the number or name for any valid\nsyslog facility. See the syslog documentation:\nhttps://tools.ietf.org/html/rfc5424#section-6.2.1.",
27121 "stability": "stable",
27122 "summary": "The syslog facility to use."
27123 },
27124 "immutable": true,
27125 "locationInModule": {
27126 "filename": "lib/log-drivers/syslog-log-driver.ts",
27127 "line": 31
27128 },
27129 "name": "facility",
27130 "optional": true,
27131 "type": {
27132 "primitive": "string"
27133 }
27134 },
27135 {
27136 "abstract": true,
27137 "docs": {
27138 "default": "- format not set",
27139 "remarks": "If not specified the local UNIX syslog\nformat is used, without a specified hostname. Specify rfc3164 for the RFC-3164\ncompatible format, rfc5424 for RFC-5424 compatible format, or rfc5424micro\nfor RFC-5424 compatible format with microsecond timestamp resolution.",
27140 "stability": "stable",
27141 "summary": "The syslog message format to use."
27142 },
27143 "immutable": true,
27144 "locationInModule": {
27145 "filename": "lib/log-drivers/syslog-log-driver.ts",
27146 "line": 73
27147 },
27148 "name": "format",
27149 "optional": true,
27150 "type": {
27151 "primitive": "string"
27152 }
27153 },
27154 {
27155 "abstract": true,
27156 "docs": {
27157 "default": "- tlsCaCert not set",
27158 "remarks": "Ignored\nif the address protocol is not tcp+tls.",
27159 "stability": "stable",
27160 "summary": "The absolute path to the trust certificates signed by the CA."
27161 },
27162 "immutable": true,
27163 "locationInModule": {
27164 "filename": "lib/log-drivers/syslog-log-driver.ts",
27165 "line": 39
27166 },
27167 "name": "tlsCaCert",
27168 "optional": true,
27169 "type": {
27170 "primitive": "string"
27171 }
27172 },
27173 {
27174 "abstract": true,
27175 "docs": {
27176 "default": "- tlsCert not set",
27177 "remarks": "Ignored if the address\nprotocol is not tcp+tls.",
27178 "stability": "stable",
27179 "summary": "The absolute path to the TLS certificate file."
27180 },
27181 "immutable": true,
27182 "locationInModule": {
27183 "filename": "lib/log-drivers/syslog-log-driver.ts",
27184 "line": 47
27185 },
27186 "name": "tlsCert",
27187 "optional": true,
27188 "type": {
27189 "primitive": "string"
27190 }
27191 },
27192 {
27193 "abstract": true,
27194 "docs": {
27195 "default": "- tlsKey not set",
27196 "remarks": "Ignored if the address protocol\nis not tcp+tls.",
27197 "stability": "stable",
27198 "summary": "The absolute path to the TLS key file."
27199 },
27200 "immutable": true,
27201 "locationInModule": {
27202 "filename": "lib/log-drivers/syslog-log-driver.ts",
27203 "line": 55
27204 },
27205 "name": "tlsKey",
27206 "optional": true,
27207 "type": {
27208 "primitive": "string"
27209 }
27210 },
27211 {
27212 "abstract": true,
27213 "docs": {
27214 "default": "- false",
27215 "remarks": "Ignored if the address protocol is not tcp+tls.",
27216 "stability": "stable",
27217 "summary": "If set to true, TLS verification is skipped when connecting to the syslog daemon."
27218 },
27219 "immutable": true,
27220 "locationInModule": {
27221 "filename": "lib/log-drivers/syslog-log-driver.ts",
27222 "line": 63
27223 },
27224 "name": "tlsSkipVerify",
27225 "optional": true,
27226 "type": {
27227 "primitive": "boolean"
27228 }
27229 }
27230 ],
27231 "symbolId": "lib/log-drivers/syslog-log-driver:SyslogLogDriverProps"
27232 },
27233 "@aws-cdk/aws-ecs.SystemControl": {
27234 "assembly": "@aws-cdk/aws-ecs",
27235 "datatype": true,
27236 "docs": {
27237 "stability": "stable",
27238 "summary": "Kernel parameters to set in the container.",
27239 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst systemControl: ecs.SystemControl = {\n namespace: 'namespace',\n value: 'value',\n};",
27240 "custom": {
27241 "exampleMetadata": "fixture=_generated"
27242 }
27243 },
27244 "fqn": "@aws-cdk/aws-ecs.SystemControl",
27245 "kind": "interface",
27246 "locationInModule": {
27247 "filename": "lib/container-definition.ts",
27248 "line": 1116
27249 },
27250 "name": "SystemControl",
27251 "properties": [
27252 {
27253 "abstract": true,
27254 "docs": {
27255 "stability": "stable",
27256 "summary": "The namespaced kernel parameter for which to set a value."
27257 },
27258 "immutable": true,
27259 "locationInModule": {
27260 "filename": "lib/container-definition.ts",
27261 "line": 1120
27262 },
27263 "name": "namespace",
27264 "type": {
27265 "primitive": "string"
27266 }
27267 },
27268 {
27269 "abstract": true,
27270 "docs": {
27271 "stability": "stable",
27272 "summary": "The value for the namespaced kernel parameter specified in namespace."
27273 },
27274 "immutable": true,
27275 "locationInModule": {
27276 "filename": "lib/container-definition.ts",
27277 "line": 1125
27278 },
27279 "name": "value",
27280 "type": {
27281 "primitive": "string"
27282 }
27283 }
27284 ],
27285 "symbolId": "lib/container-definition:SystemControl"
27286 },
27287 "@aws-cdk/aws-ecs.TagParameterContainerImage": {
27288 "assembly": "@aws-cdk/aws-ecs",
27289 "base": "@aws-cdk/aws-ecs.ContainerImage",
27290 "docs": {
27291 "custom": {
27292 "exampleMetadata": "lit=test/integ.pipeline-ecs-separate-source.lit.ts infused"
27293 },
27294 "example": "\n/**\n * These are the construction properties for {@link EcsAppStack}.\n * They extend the standard Stack properties,\n * but also require providing the ContainerImage that the service will use.\n * That Image will be provided from the Stack containing the CodePipeline.\n */\nexport interface EcsAppStackProps extends cdk.StackProps {\n readonly image: ecs.ContainerImage;\n}\n\n/**\n * This is the Stack containing a simple ECS Service that uses the provided ContainerImage.\n */\nexport class EcsAppStack extends cdk.Stack {\n constructor(scope: Construct, id: string, props: EcsAppStackProps) {\n super(scope, id, props);\n\n const taskDefinition = new ecs.TaskDefinition(this, 'TaskDefinition', {\n compatibility: ecs.Compatibility.FARGATE,\n cpu: '1024',\n memoryMiB: '2048',\n });\n taskDefinition.addContainer('AppContainer', {\n image: props.image,\n });\n new ecs.FargateService(this, 'EcsService', {\n taskDefinition,\n cluster: new ecs.Cluster(this, 'Cluster', {\n vpc: new ec2.Vpc(this, 'Vpc', {\n maxAzs: 1,\n }),\n }),\n });\n }\n}\n\n/**\n * This is the Stack containing the CodePipeline definition that deploys an ECS Service.\n */\nexport class PipelineStack extends cdk.Stack {\n public readonly tagParameterContainerImage: ecs.TagParameterContainerImage;\n\n constructor(scope: Construct, id: string, props?: cdk.StackProps) {\n super(scope, id, props);\n\n /* ********** ECS part **************** */\n\n // this is the ECR repository where the built Docker image will be pushed\n const appEcrRepo = new ecr.Repository(this, 'EcsDeployRepository');\n // the build that creates the Docker image, and pushes it to the ECR repo\n const appCodeDockerBuild = new codebuild.PipelineProject(this, 'AppCodeDockerImageBuildAndPushProject', {\n environment: {\n // we need to run Docker\n privileged: true,\n },\n buildSpec: codebuild.BuildSpec.fromObject({\n version: '0.2',\n phases: {\n build: {\n commands: [\n // login to ECR first\n '$(aws ecr get-login --region $AWS_DEFAULT_REGION --no-include-email)',\n // if your application needs any build steps, they would be invoked here\n\n // build the image, and tag it with the commit hash\n // (CODEBUILD_RESOLVED_SOURCE_VERSION is a special environment variable available in CodeBuild)\n 'docker build -t $REPOSITORY_URI:$CODEBUILD_RESOLVED_SOURCE_VERSION .',\n ],\n },\n post_build: {\n commands: [\n // push the built image into the ECR repository\n 'docker push $REPOSITORY_URI:$CODEBUILD_RESOLVED_SOURCE_VERSION',\n // save the declared tag as an environment variable,\n // that is then exported below in the 'exported-variables' section as a CodePipeline Variable\n 'export imageTag=$CODEBUILD_RESOLVED_SOURCE_VERSION',\n ],\n },\n },\n env: {\n // save the imageTag environment variable as a CodePipeline Variable\n 'exported-variables': [\n 'imageTag',\n ],\n },\n }),\n environmentVariables: {\n REPOSITORY_URI: {\n value: appEcrRepo.repositoryUri,\n },\n },\n });\n // needed for `docker push`\n appEcrRepo.grantPullPush(appCodeDockerBuild);\n // create the ContainerImage used for the ECS application Stack\n this.tagParameterContainerImage = new ecs.TagParameterContainerImage(appEcrRepo);\n\n const cdkCodeBuild = new codebuild.PipelineProject(this, 'CdkCodeBuildProject', {\n buildSpec: codebuild.BuildSpec.fromObject({\n version: '0.2',\n phases: {\n install: {\n commands: [\n 'npm install',\n ],\n },\n build: {\n commands: [\n // synthesize the CDK code for the ECS application Stack\n 'npx cdk synth --verbose',\n ],\n },\n },\n artifacts: {\n // store the entire Cloud Assembly as the output artifact\n 'base-directory': 'cdk.out',\n 'files': '**/*',\n },\n }),\n });\n\n /* ********** Pipeline part **************** */\n\n const appCodeSourceOutput = new codepipeline.Artifact();\n const cdkCodeSourceOutput = new codepipeline.Artifact();\n const cdkCodeBuildOutput = new codepipeline.Artifact();\n const appCodeBuildAction = new codepipeline_actions.CodeBuildAction({\n actionName: 'AppCodeDockerImageBuildAndPush',\n project: appCodeDockerBuild,\n input: appCodeSourceOutput,\n });\n new codepipeline.Pipeline(this, 'CodePipelineDeployingEcsApplication', {\n artifactBucket: new s3.Bucket(this, 'ArtifactBucket', {\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n }),\n stages: [\n {\n stageName: 'Source',\n actions: [\n // this is the Action that takes the source of your application code\n new codepipeline_actions.CodeCommitSourceAction({\n actionName: 'AppCodeSource',\n repository: new codecommit.Repository(this, 'AppCodeSourceRepository', { repositoryName: 'AppCodeSourceRepository' }),\n output: appCodeSourceOutput,\n }),\n // this is the Action that takes the source of your CDK code\n // (which would probably include this Pipeline code as well)\n new codepipeline_actions.CodeCommitSourceAction({\n actionName: 'CdkCodeSource',\n repository: new codecommit.Repository(this, 'CdkCodeSourceRepository', { repositoryName: 'CdkCodeSourceRepository' }),\n output: cdkCodeSourceOutput,\n }),\n ],\n },\n {\n stageName: 'Build',\n actions: [\n appCodeBuildAction,\n new codepipeline_actions.CodeBuildAction({\n actionName: 'CdkCodeBuildAndSynth',\n project: cdkCodeBuild,\n input: cdkCodeSourceOutput,\n outputs: [cdkCodeBuildOutput],\n }),\n ],\n },\n {\n stageName: 'Deploy',\n actions: [\n new codepipeline_actions.CloudFormationCreateUpdateStackAction({\n actionName: 'CFN_Deploy',\n stackName: 'SampleEcsStackDeployedFromCodePipeline',\n // this name has to be the same name as used below in the CDK code for the application Stack\n templatePath: cdkCodeBuildOutput.atPath('EcsStackDeployedInPipeline.template.json'),\n adminPermissions: true,\n parameterOverrides: {\n // read the tag pushed to the ECR repository from the CodePipeline Variable saved by the application build step,\n // and pass it as the CloudFormation Parameter for the tag\n [this.tagParameterContainerImage.tagParameterName]: appCodeBuildAction.variable('imageTag'),\n },\n }),\n ],\n },\n ],\n });\n }\n}\n\nconst app = new cdk.App();\n\n// the CodePipeline Stack needs to be created first\nconst pipelineStack = new PipelineStack(app, 'aws-cdk-pipeline-ecs-separate-sources');\n// we supply the image to the ECS application Stack from the CodePipeline Stack\nnew EcsAppStack(app, 'EcsStackDeployedInPipeline', {\n image: pipelineStack.tagParameterContainerImage,\n});",
27295 "remarks": "This allows providing this tag through the Parameter at deploy time,\nfor example in a CodePipeline that pushes a new tag of the image to the repository during a build step,\nand then provides that new tag through the CloudFormation Parameter in the deploy step.",
27296 "see": "#tagParameterName",
27297 "stability": "stable",
27298 "summary": "A special type of {@link ContainerImage} that uses an ECR repository for the image, but a CloudFormation Parameter for the tag of the image in that repository."
27299 },
27300 "fqn": "@aws-cdk/aws-ecs.TagParameterContainerImage",
27301 "initializer": {
27302 "docs": {
27303 "stability": "stable"
27304 },
27305 "locationInModule": {
27306 "filename": "lib/images/tag-parameter-container-image.ts",
27307 "line": 23
27308 },
27309 "parameters": [
27310 {
27311 "name": "repository",
27312 "type": {
27313 "fqn": "@aws-cdk/aws-ecr.IRepository"
27314 }
27315 }
27316 ]
27317 },
27318 "kind": "class",
27319 "locationInModule": {
27320 "filename": "lib/images/tag-parameter-container-image.ts",
27321 "line": 19
27322 },
27323 "methods": [
27324 {
27325 "docs": {
27326 "stability": "stable",
27327 "summary": "Called when the image is used by a ContainerDefinition."
27328 },
27329 "locationInModule": {
27330 "filename": "lib/images/tag-parameter-container-image.ts",
27331 "line": 28
27332 },
27333 "name": "bind",
27334 "overrides": "@aws-cdk/aws-ecs.ContainerImage",
27335 "parameters": [
27336 {
27337 "name": "scope",
27338 "type": {
27339 "fqn": "@aws-cdk/core.Construct"
27340 }
27341 },
27342 {
27343 "name": "containerDefinition",
27344 "type": {
27345 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27346 }
27347 }
27348 ],
27349 "returns": {
27350 "type": {
27351 "fqn": "@aws-cdk/aws-ecs.ContainerImageConfig"
27352 }
27353 }
27354 }
27355 ],
27356 "name": "TagParameterContainerImage",
27357 "properties": [
27358 {
27359 "docs": {
27360 "stability": "stable",
27361 "summary": "Returns the name of the CloudFormation Parameter that represents the tag of the image in the ECR repository."
27362 },
27363 "immutable": true,
27364 "locationInModule": {
27365 "filename": "lib/images/tag-parameter-container-image.ts",
27366 "line": 41
27367 },
27368 "name": "tagParameterName",
27369 "type": {
27370 "primitive": "string"
27371 }
27372 },
27373 {
27374 "docs": {
27375 "stability": "stable",
27376 "summary": "Returns the value of the CloudFormation Parameter that represents the tag of the image in the ECR repository."
27377 },
27378 "immutable": true,
27379 "locationInModule": {
27380 "filename": "lib/images/tag-parameter-container-image.ts",
27381 "line": 57
27382 },
27383 "name": "tagParameterValue",
27384 "type": {
27385 "primitive": "string"
27386 }
27387 }
27388 ],
27389 "symbolId": "lib/images/tag-parameter-container-image:TagParameterContainerImage"
27390 },
27391 "@aws-cdk/aws-ecs.TaskDefinition": {
27392 "assembly": "@aws-cdk/aws-ecs",
27393 "base": "@aws-cdk/core.Resource",
27394 "docs": {
27395 "custom": {
27396 "exampleMetadata": "infused"
27397 },
27398 "example": "declare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const vpc: ec2.Vpc;\nconst service = new ecs.FargateService(this, 'Service', { cluster, taskDefinition });\n\nconst lb = new elbv2.ApplicationLoadBalancer(this, 'LB', { vpc, internetFacing: true });\nconst listener = lb.addListener('Listener', { port: 80 });\nservice.registerLoadBalancerTargets(\n {\n containerName: 'web',\n containerPort: 80,\n newTargetGroupId: 'ECS',\n listener: ecs.ListenerConfig.applicationListener(listener, {\n protocol: elbv2.ApplicationProtocol.HTTPS\n }),\n },\n);",
27399 "stability": "stable",
27400 "summary": "The base class for all task definitions."
27401 },
27402 "fqn": "@aws-cdk/aws-ecs.TaskDefinition",
27403 "initializer": {
27404 "docs": {
27405 "stability": "stable",
27406 "summary": "Constructs a new instance of the TaskDefinition class."
27407 },
27408 "locationInModule": {
27409 "filename": "lib/base/task-definition.ts",
27410 "line": 387
27411 },
27412 "parameters": [
27413 {
27414 "name": "scope",
27415 "type": {
27416 "fqn": "constructs.Construct"
27417 }
27418 },
27419 {
27420 "name": "id",
27421 "type": {
27422 "primitive": "string"
27423 }
27424 },
27425 {
27426 "name": "props",
27427 "type": {
27428 "fqn": "@aws-cdk/aws-ecs.TaskDefinitionProps"
27429 }
27430 }
27431 ]
27432 },
27433 "interfaces": [
27434 "@aws-cdk/aws-ecs.ITaskDefinition"
27435 ],
27436 "kind": "class",
27437 "locationInModule": {
27438 "filename": "lib/base/task-definition.ts",
27439 "line": 292
27440 },
27441 "methods": [
27442 {
27443 "docs": {
27444 "remarks": "The task will have a compatibility of EC2+Fargate.",
27445 "stability": "stable",
27446 "summary": "Imports a task definition from the specified task definition ARN."
27447 },
27448 "locationInModule": {
27449 "filename": "lib/base/task-definition.ts",
27450 "line": 299
27451 },
27452 "name": "fromTaskDefinitionArn",
27453 "parameters": [
27454 {
27455 "name": "scope",
27456 "type": {
27457 "fqn": "constructs.Construct"
27458 }
27459 },
27460 {
27461 "name": "id",
27462 "type": {
27463 "primitive": "string"
27464 }
27465 },
27466 {
27467 "name": "taskDefinitionArn",
27468 "type": {
27469 "primitive": "string"
27470 }
27471 }
27472 ],
27473 "returns": {
27474 "type": {
27475 "fqn": "@aws-cdk/aws-ecs.ITaskDefinition"
27476 }
27477 },
27478 "static": true
27479 },
27480 {
27481 "docs": {
27482 "stability": "stable",
27483 "summary": "Create a task definition from a task definition reference."
27484 },
27485 "locationInModule": {
27486 "filename": "lib/base/task-definition.ts",
27487 "line": 306
27488 },
27489 "name": "fromTaskDefinitionAttributes",
27490 "parameters": [
27491 {
27492 "name": "scope",
27493 "type": {
27494 "fqn": "constructs.Construct"
27495 }
27496 },
27497 {
27498 "name": "id",
27499 "type": {
27500 "primitive": "string"
27501 }
27502 },
27503 {
27504 "name": "attrs",
27505 "type": {
27506 "fqn": "@aws-cdk/aws-ecs.TaskDefinitionAttributes"
27507 }
27508 }
27509 ],
27510 "returns": {
27511 "type": {
27512 "fqn": "@aws-cdk/aws-ecs.ITaskDefinition"
27513 }
27514 },
27515 "static": true
27516 },
27517 {
27518 "docs": {
27519 "stability": "stable",
27520 "summary": "Adds a new container to the task definition."
27521 },
27522 "locationInModule": {
27523 "filename": "lib/base/task-definition.ts",
27524 "line": 589
27525 },
27526 "name": "addContainer",
27527 "parameters": [
27528 {
27529 "name": "id",
27530 "type": {
27531 "primitive": "string"
27532 }
27533 },
27534 {
27535 "name": "props",
27536 "type": {
27537 "fqn": "@aws-cdk/aws-ecs.ContainerDefinitionOptions"
27538 }
27539 }
27540 ],
27541 "returns": {
27542 "type": {
27543 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27544 }
27545 }
27546 },
27547 {
27548 "docs": {
27549 "remarks": "Extension can be used to apply a packaged modification to\na task definition.",
27550 "stability": "stable",
27551 "summary": "Adds the specified extension to the task definition."
27552 },
27553 "locationInModule": {
27554 "filename": "lib/base/task-definition.ts",
27555 "line": 642
27556 },
27557 "name": "addExtension",
27558 "parameters": [
27559 {
27560 "name": "extension",
27561 "type": {
27562 "fqn": "@aws-cdk/aws-ecs.ITaskDefinitionExtension"
27563 }
27564 }
27565 ]
27566 },
27567 {
27568 "docs": {
27569 "stability": "stable",
27570 "summary": "Adds a firelens log router to the task definition."
27571 },
27572 "locationInModule": {
27573 "filename": "lib/base/task-definition.ts",
27574 "line": 596
27575 },
27576 "name": "addFirelensLogRouter",
27577 "parameters": [
27578 {
27579 "name": "id",
27580 "type": {
27581 "primitive": "string"
27582 }
27583 },
27584 {
27585 "name": "props",
27586 "type": {
27587 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouterDefinitionOptions"
27588 }
27589 }
27590 ],
27591 "returns": {
27592 "type": {
27593 "fqn": "@aws-cdk/aws-ecs.FirelensLogRouter"
27594 }
27595 }
27596 },
27597 {
27598 "docs": {
27599 "stability": "stable",
27600 "summary": "Adds an inference accelerator to the task definition."
27601 },
27602 "locationInModule": {
27603 "filename": "lib/base/task-definition.ts",
27604 "line": 649
27605 },
27606 "name": "addInferenceAccelerator",
27607 "parameters": [
27608 {
27609 "name": "inferenceAccelerator",
27610 "type": {
27611 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator"
27612 }
27613 }
27614 ]
27615 },
27616 {
27617 "docs": {
27618 "stability": "stable",
27619 "summary": "Adds the specified placement constraint to the task definition."
27620 },
27621 "locationInModule": {
27622 "filename": "lib/base/task-definition.ts",
27623 "line": 629
27624 },
27625 "name": "addPlacementConstraint",
27626 "parameters": [
27627 {
27628 "name": "constraint",
27629 "type": {
27630 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
27631 }
27632 }
27633 ]
27634 },
27635 {
27636 "docs": {
27637 "stability": "stable",
27638 "summary": "Adds a policy statement to the task execution IAM role."
27639 },
27640 "locationInModule": {
27641 "filename": "lib/base/task-definition.ts",
27642 "line": 582
27643 },
27644 "name": "addToExecutionRolePolicy",
27645 "parameters": [
27646 {
27647 "name": "statement",
27648 "type": {
27649 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
27650 }
27651 }
27652 ]
27653 },
27654 {
27655 "docs": {
27656 "stability": "stable",
27657 "summary": "Adds a policy statement to the task IAM role."
27658 },
27659 "locationInModule": {
27660 "filename": "lib/base/task-definition.ts",
27661 "line": 575
27662 },
27663 "name": "addToTaskRolePolicy",
27664 "parameters": [
27665 {
27666 "name": "statement",
27667 "type": {
27668 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
27669 }
27670 }
27671 ]
27672 },
27673 {
27674 "docs": {
27675 "stability": "stable",
27676 "summary": "Adds a volume to the task definition."
27677 },
27678 "locationInModule": {
27679 "filename": "lib/base/task-definition.ts",
27680 "line": 622
27681 },
27682 "name": "addVolume",
27683 "parameters": [
27684 {
27685 "name": "volume",
27686 "type": {
27687 "fqn": "@aws-cdk/aws-ecs.Volume"
27688 }
27689 }
27690 ]
27691 },
27692 {
27693 "docs": {
27694 "stability": "stable",
27695 "summary": "Returns the container that match the provided containerName."
27696 },
27697 "locationInModule": {
27698 "filename": "lib/base/task-definition.ts",
27699 "line": 700
27700 },
27701 "name": "findContainer",
27702 "parameters": [
27703 {
27704 "name": "containerName",
27705 "type": {
27706 "primitive": "string"
27707 }
27708 }
27709 ],
27710 "returns": {
27711 "optional": true,
27712 "type": {
27713 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27714 }
27715 }
27716 },
27717 {
27718 "docs": {
27719 "stability": "stable",
27720 "summary": "Creates the task execution IAM role if it doesn't already exist."
27721 },
27722 "locationInModule": {
27723 "filename": "lib/base/task-definition.ts",
27724 "line": 659
27725 },
27726 "name": "obtainExecutionRole",
27727 "returns": {
27728 "type": {
27729 "fqn": "@aws-cdk/aws-iam.IRole"
27730 }
27731 }
27732 },
27733 {
27734 "docs": {
27735 "stability": "stable",
27736 "summary": "Validates the task definition."
27737 },
27738 "locationInModule": {
27739 "filename": "lib/base/task-definition.ts",
27740 "line": 681
27741 },
27742 "name": "validate",
27743 "overrides": "@aws-cdk/core.Construct",
27744 "protected": true,
27745 "returns": {
27746 "type": {
27747 "collection": {
27748 "elementtype": {
27749 "primitive": "string"
27750 },
27751 "kind": "array"
27752 }
27753 }
27754 }
27755 }
27756 ],
27757 "name": "TaskDefinition",
27758 "properties": [
27759 {
27760 "docs": {
27761 "stability": "stable",
27762 "summary": "The task launch type compatibility requirement."
27763 },
27764 "immutable": true,
27765 "locationInModule": {
27766 "filename": "lib/base/task-definition.ts",
27767 "line": 349
27768 },
27769 "name": "compatibility",
27770 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27771 "type": {
27772 "fqn": "@aws-cdk/aws-ecs.Compatibility"
27773 }
27774 },
27775 {
27776 "docs": {
27777 "stability": "stable",
27778 "summary": "The container definitions."
27779 },
27780 "immutable": true,
27781 "locationInModule": {
27782 "filename": "lib/base/task-definition.ts",
27783 "line": 361
27784 },
27785 "name": "containers",
27786 "protected": true,
27787 "type": {
27788 "collection": {
27789 "elementtype": {
27790 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27791 },
27792 "kind": "array"
27793 }
27794 }
27795 },
27796 {
27797 "docs": {
27798 "remarks": "A family groups multiple versions of a task definition.",
27799 "stability": "stable",
27800 "summary": "The name of a family that this task definition is registered to."
27801 },
27802 "immutable": true,
27803 "locationInModule": {
27804 "filename": "lib/base/task-definition.ts",
27805 "line": 319
27806 },
27807 "name": "family",
27808 "type": {
27809 "primitive": "string"
27810 }
27811 },
27812 {
27813 "docs": {
27814 "stability": "stable",
27815 "summary": "Public getter method to access list of inference accelerators attached to the instance."
27816 },
27817 "immutable": true,
27818 "locationInModule": {
27819 "filename": "lib/base/task-definition.ts",
27820 "line": 493
27821 },
27822 "name": "inferenceAccelerators",
27823 "type": {
27824 "collection": {
27825 "elementtype": {
27826 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator"
27827 },
27828 "kind": "array"
27829 }
27830 }
27831 },
27832 {
27833 "docs": {
27834 "stability": "stable",
27835 "summary": "Return true if the task definition can be run on an EC2 cluster."
27836 },
27837 "immutable": true,
27838 "locationInModule": {
27839 "filename": "lib/base/task-definition.ts",
27840 "line": 270
27841 },
27842 "name": "isEc2Compatible",
27843 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27844 "type": {
27845 "primitive": "boolean"
27846 }
27847 },
27848 {
27849 "docs": {
27850 "stability": "stable",
27851 "summary": "Return true if the task definition can be run on a ECS anywhere cluster."
27852 },
27853 "immutable": true,
27854 "locationInModule": {
27855 "filename": "lib/base/task-definition.ts",
27856 "line": 284
27857 },
27858 "name": "isExternalCompatible",
27859 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27860 "type": {
27861 "primitive": "boolean"
27862 }
27863 },
27864 {
27865 "docs": {
27866 "stability": "stable",
27867 "summary": "Return true if the task definition can be run on a Fargate cluster."
27868 },
27869 "immutable": true,
27870 "locationInModule": {
27871 "filename": "lib/base/task-definition.ts",
27872 "line": 277
27873 },
27874 "name": "isFargateCompatible",
27875 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27876 "type": {
27877 "primitive": "boolean"
27878 }
27879 },
27880 {
27881 "docs": {
27882 "stability": "stable",
27883 "summary": "The networking mode to use for the containers in the task."
27884 },
27885 "immutable": true,
27886 "locationInModule": {
27887 "filename": "lib/base/task-definition.ts",
27888 "line": 335
27889 },
27890 "name": "networkMode",
27891 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27892 "type": {
27893 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
27894 }
27895 },
27896 {
27897 "docs": {
27898 "custom": {
27899 "attribute": "true"
27900 },
27901 "stability": "stable",
27902 "summary": "The full Amazon Resource Name (ARN) of the task definition."
27903 },
27904 "immutable": true,
27905 "locationInModule": {
27906 "filename": "lib/base/task-definition.ts",
27907 "line": 325
27908 },
27909 "name": "taskDefinitionArn",
27910 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27911 "type": {
27912 "primitive": "string"
27913 }
27914 },
27915 {
27916 "docs": {
27917 "stability": "stable",
27918 "summary": "The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf."
27919 },
27920 "immutable": true,
27921 "locationInModule": {
27922 "filename": "lib/base/task-definition.ts",
27923 "line": 330
27924 },
27925 "name": "taskRole",
27926 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27927 "type": {
27928 "fqn": "@aws-cdk/aws-iam.IRole"
27929 }
27930 },
27931 {
27932 "docs": {
27933 "remarks": "Only supported in Fargate platform version 1.4.0 or later.",
27934 "stability": "stable",
27935 "summary": "The amount (in GiB) of ephemeral storage to be allocated to the task."
27936 },
27937 "immutable": true,
27938 "locationInModule": {
27939 "filename": "lib/base/task-definition.ts",
27940 "line": 356
27941 },
27942 "name": "ephemeralStorageGiB",
27943 "optional": true,
27944 "type": {
27945 "primitive": "number"
27946 }
27947 },
27948 {
27949 "docs": {
27950 "stability": "stable",
27951 "summary": "Execution role for this task definition."
27952 },
27953 "immutable": true,
27954 "locationInModule": {
27955 "filename": "lib/base/task-definition.ts",
27956 "line": 486
27957 },
27958 "name": "executionRole",
27959 "optional": true,
27960 "overrides": "@aws-cdk/aws-ecs.ITaskDefinition",
27961 "type": {
27962 "fqn": "@aws-cdk/aws-iam.IRole"
27963 }
27964 },
27965 {
27966 "docs": {
27967 "stability": "stable",
27968 "summary": "Whether this task definition has at least a container that references a specific JSON field of a secret stored in Secrets Manager."
27969 },
27970 "immutable": true,
27971 "locationInModule": {
27972 "filename": "lib/base/task-definition.ts",
27973 "line": 674
27974 },
27975 "name": "referencesSecretJsonField",
27976 "optional": true,
27977 "type": {
27978 "primitive": "boolean"
27979 }
27980 },
27981 {
27982 "docs": {
27983 "remarks": "Load balancers will send traffic to this container. The first\nessential container that is added to this task will become the default\ncontainer.",
27984 "stability": "stable",
27985 "summary": "Default container for this task."
27986 },
27987 "locationInModule": {
27988 "filename": "lib/base/task-definition.ts",
27989 "line": 344
27990 },
27991 "name": "defaultContainer",
27992 "optional": true,
27993 "type": {
27994 "fqn": "@aws-cdk/aws-ecs.ContainerDefinition"
27995 }
27996 }
27997 ],
27998 "symbolId": "lib/base/task-definition:TaskDefinition"
27999 },
28000 "@aws-cdk/aws-ecs.TaskDefinitionAttributes": {
28001 "assembly": "@aws-cdk/aws-ecs",
28002 "datatype": true,
28003 "docs": {
28004 "stability": "stable",
28005 "summary": "A reference to an existing task definition.",
28006 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const role: iam.Role;\nconst taskDefinitionAttributes: ecs.TaskDefinitionAttributes = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n compatibility: ecs.Compatibility.EC2,\n networkMode: ecs.NetworkMode.NONE,\n taskRole: role,\n};",
28007 "custom": {
28008 "exampleMetadata": "fixture=_generated"
28009 }
28010 },
28011 "fqn": "@aws-cdk/aws-ecs.TaskDefinitionAttributes",
28012 "interfaces": [
28013 "@aws-cdk/aws-ecs.CommonTaskDefinitionAttributes"
28014 ],
28015 "kind": "interface",
28016 "locationInModule": {
28017 "filename": "lib/base/task-definition.ts",
28018 "line": 250
28019 },
28020 "name": "TaskDefinitionAttributes",
28021 "properties": [
28022 {
28023 "abstract": true,
28024 "docs": {
28025 "default": "Compatibility.EC2_AND_FARGATE",
28026 "stability": "stable",
28027 "summary": "What launch types this task definition should be compatible with."
28028 },
28029 "immutable": true,
28030 "locationInModule": {
28031 "filename": "lib/base/task-definition.ts",
28032 "line": 256
28033 },
28034 "name": "compatibility",
28035 "optional": true,
28036 "type": {
28037 "fqn": "@aws-cdk/aws-ecs.Compatibility"
28038 }
28039 }
28040 ],
28041 "symbolId": "lib/base/task-definition:TaskDefinitionAttributes"
28042 },
28043 "@aws-cdk/aws-ecs.TaskDefinitionProps": {
28044 "assembly": "@aws-cdk/aws-ecs",
28045 "datatype": true,
28046 "docs": {
28047 "custom": {
28048 "exampleMetadata": "infused"
28049 },
28050 "example": "const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {\n isDefault: true,\n});\n\nconst cluster = new ecs.Cluster(this, 'Ec2Cluster', { vpc });\ncluster.addCapacity('DefaultAutoScalingGroup', {\n instanceType: new ec2.InstanceType('t2.micro'),\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },\n});\n\nconst taskDefinition = new ecs.TaskDefinition(this, 'TD', {\n compatibility: ecs.Compatibility.EC2,\n});\n\ntaskDefinition.addContainer('TheContainer', {\n image: ecs.ContainerImage.fromRegistry('foo/bar'),\n memoryLimitMiB: 256,\n});\n\nconst runTask = new tasks.EcsRunTask(this, 'Run', {\n integrationPattern: sfn.IntegrationPattern.RUN_JOB,\n cluster,\n taskDefinition,\n launchTarget: new tasks.EcsEc2LaunchTarget({\n placementStrategies: [\n ecs.PlacementStrategy.spreadAcrossInstances(),\n ecs.PlacementStrategy.packedByCpu(),\n ecs.PlacementStrategy.randomly(),\n ],\n placementConstraints: [\n ecs.PlacementConstraint.memberOf('blieptuut'),\n ],\n }),\n});",
28051 "stability": "stable",
28052 "summary": "The properties for task definitions."
28053 },
28054 "fqn": "@aws-cdk/aws-ecs.TaskDefinitionProps",
28055 "interfaces": [
28056 "@aws-cdk/aws-ecs.CommonTaskDefinitionProps"
28057 ],
28058 "kind": "interface",
28059 "locationInModule": {
28060 "filename": "lib/base/task-definition.ts",
28061 "line": 108
28062 },
28063 "name": "TaskDefinitionProps",
28064 "properties": [
28065 {
28066 "abstract": true,
28067 "docs": {
28068 "stability": "stable",
28069 "summary": "The task launch type compatiblity requirement."
28070 },
28071 "immutable": true,
28072 "locationInModule": {
28073 "filename": "lib/base/task-definition.ts",
28074 "line": 133
28075 },
28076 "name": "compatibility",
28077 "type": {
28078 "fqn": "@aws-cdk/aws-ecs.Compatibility"
28079 }
28080 },
28081 {
28082 "abstract": true,
28083 "docs": {
28084 "default": "- CPU units are not specified.",
28085 "remarks": "If you are using the EC2 launch type, this field is optional and any value can be used.\nIf you are using the Fargate launch type, this field is required and you must use one of the following values,\nwhich determines your range of valid values for the memory parameter:\n\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n\n512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n\n1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n\n2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n\n4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)",
28086 "stability": "stable",
28087 "summary": "The number of cpu units used by the task."
28088 },
28089 "immutable": true,
28090 "locationInModule": {
28091 "filename": "lib/base/task-definition.ts",
28092 "line": 154
28093 },
28094 "name": "cpu",
28095 "optional": true,
28096 "type": {
28097 "primitive": "string"
28098 }
28099 },
28100 {
28101 "abstract": true,
28102 "docs": {
28103 "default": "- Undefined, in which case, the task will receive 20GiB ephemeral storage.",
28104 "remarks": "Only supported in Fargate platform version 1.4.0 or later.",
28105 "stability": "stable",
28106 "summary": "The amount (in GiB) of ephemeral storage to be allocated to the task."
28107 },
28108 "immutable": true,
28109 "locationInModule": {
28110 "filename": "lib/base/task-definition.ts",
28111 "line": 211
28112 },
28113 "name": "ephemeralStorageGiB",
28114 "optional": true,
28115 "type": {
28116 "primitive": "number"
28117 }
28118 },
28119 {
28120 "abstract": true,
28121 "docs": {
28122 "default": "- No inference accelerators.",
28123 "remarks": "Not supported in Fargate.",
28124 "stability": "stable",
28125 "summary": "The inference accelerators to use for the containers in the task."
28126 },
28127 "immutable": true,
28128 "locationInModule": {
28129 "filename": "lib/base/task-definition.ts",
28130 "line": 202
28131 },
28132 "name": "inferenceAccelerators",
28133 "optional": true,
28134 "type": {
28135 "collection": {
28136 "elementtype": {
28137 "fqn": "@aws-cdk/aws-ecs.InferenceAccelerator"
28138 },
28139 "kind": "array"
28140 }
28141 }
28142 },
28143 {
28144 "abstract": true,
28145 "docs": {
28146 "default": "- IpcMode used by the task is not specified",
28147 "remarks": "Not supported in Fargate and Windows containers.",
28148 "stability": "stable",
28149 "summary": "The IPC resource namespace to use for the containers in the task."
28150 },
28151 "immutable": true,
28152 "locationInModule": {
28153 "filename": "lib/base/task-definition.ts",
28154 "line": 184
28155 },
28156 "name": "ipcMode",
28157 "optional": true,
28158 "type": {
28159 "fqn": "@aws-cdk/aws-ecs.IpcMode"
28160 }
28161 },
28162 {
28163 "abstract": true,
28164 "docs": {
28165 "default": "- Memory used by task is not specified.",
28166 "remarks": "If using the EC2 launch type, this field is optional and any value can be used.\nIf using the Fargate launch type, this field is required and you must use one of the following values,\nwhich determines your range of valid values for the cpu parameter:\n\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)\n\n1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)\n\n2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)\n\nBetween 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)\n\nBetween 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)",
28167 "stability": "stable",
28168 "summary": "The amount (in MiB) of memory used by the task."
28169 },
28170 "immutable": true,
28171 "locationInModule": {
28172 "filename": "lib/base/task-definition.ts",
28173 "line": 175
28174 },
28175 "name": "memoryMiB",
28176 "optional": true,
28177 "type": {
28178 "primitive": "string"
28179 }
28180 },
28181 {
28182 "abstract": true,
28183 "docs": {
28184 "default": "- NetworkMode.Bridge for EC2 & External tasks, AwsVpc for Fargate tasks.",
28185 "remarks": "On Fargate, the only supported networking mode is AwsVpc.",
28186 "stability": "stable",
28187 "summary": "The networking mode to use for the containers in the task."
28188 },
28189 "immutable": true,
28190 "locationInModule": {
28191 "filename": "lib/base/task-definition.ts",
28192 "line": 116
28193 },
28194 "name": "networkMode",
28195 "optional": true,
28196 "type": {
28197 "fqn": "@aws-cdk/aws-ecs.NetworkMode"
28198 }
28199 },
28200 {
28201 "abstract": true,
28202 "docs": {
28203 "default": "- PidMode used by the task is not specified",
28204 "remarks": "Not supported in Fargate and Windows containers.",
28205 "stability": "stable",
28206 "summary": "The process namespace to use for the containers in the task."
28207 },
28208 "immutable": true,
28209 "locationInModule": {
28210 "filename": "lib/base/task-definition.ts",
28211 "line": 193
28212 },
28213 "name": "pidMode",
28214 "optional": true,
28215 "type": {
28216 "fqn": "@aws-cdk/aws-ecs.PidMode"
28217 }
28218 },
28219 {
28220 "abstract": true,
28221 "docs": {
28222 "default": "- No placement constraints.",
28223 "remarks": "You can specify a maximum of 10 constraints per task (this limit includes\nconstraints in the task definition and those specified at run time).\n\nNot supported in Fargate.",
28224 "stability": "stable",
28225 "summary": "The placement constraints to use for tasks in the service."
28226 },
28227 "immutable": true,
28228 "locationInModule": {
28229 "filename": "lib/base/task-definition.ts",
28230 "line": 128
28231 },
28232 "name": "placementConstraints",
28233 "optional": true,
28234 "type": {
28235 "collection": {
28236 "elementtype": {
28237 "fqn": "@aws-cdk/aws-ecs.PlacementConstraint"
28238 },
28239 "kind": "array"
28240 }
28241 }
28242 },
28243 {
28244 "abstract": true,
28245 "docs": {
28246 "default": "- Undefined.",
28247 "remarks": "A runtimePlatform is supported only for tasks using the Fargate launch type.",
28248 "stability": "stable",
28249 "summary": "The operating system that your task definitions are running on."
28250 },
28251 "immutable": true,
28252 "locationInModule": {
28253 "filename": "lib/base/task-definition.ts",
28254 "line": 220
28255 },
28256 "name": "runtimePlatform",
28257 "optional": true,
28258 "type": {
28259 "fqn": "@aws-cdk/aws-ecs.RuntimePlatform"
28260 }
28261 }
28262 ],
28263 "symbolId": "lib/base/task-definition:TaskDefinitionProps"
28264 },
28265 "@aws-cdk/aws-ecs.Tmpfs": {
28266 "assembly": "@aws-cdk/aws-ecs",
28267 "datatype": true,
28268 "docs": {
28269 "stability": "stable",
28270 "summary": "The details of a tmpfs mount for a container.",
28271 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst tmpfs: ecs.Tmpfs = {\n containerPath: 'containerPath',\n size: 123,\n\n // the properties below are optional\n mountOptions: [ecs.TmpfsMountOption.DEFAULTS],\n};",
28272 "custom": {
28273 "exampleMetadata": "fixture=_generated"
28274 }
28275 },
28276 "fqn": "@aws-cdk/aws-ecs.Tmpfs",
28277 "kind": "interface",
28278 "locationInModule": {
28279 "filename": "lib/linux-parameters.ts",
28280 "line": 159
28281 },
28282 "name": "Tmpfs",
28283 "properties": [
28284 {
28285 "abstract": true,
28286 "docs": {
28287 "stability": "stable",
28288 "summary": "The absolute file path where the tmpfs volume is to be mounted."
28289 },
28290 "immutable": true,
28291 "locationInModule": {
28292 "filename": "lib/linux-parameters.ts",
28293 "line": 163
28294 },
28295 "name": "containerPath",
28296 "type": {
28297 "primitive": "string"
28298 }
28299 },
28300 {
28301 "abstract": true,
28302 "docs": {
28303 "stability": "stable",
28304 "summary": "The size (in MiB) of the tmpfs volume."
28305 },
28306 "immutable": true,
28307 "locationInModule": {
28308 "filename": "lib/linux-parameters.ts",
28309 "line": 168
28310 },
28311 "name": "size",
28312 "type": {
28313 "primitive": "number"
28314 }
28315 },
28316 {
28317 "abstract": true,
28318 "docs": {
28319 "remarks": "For more information, see\n[TmpfsMountOptions](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Tmpfs.html).",
28320 "stability": "stable",
28321 "summary": "The list of tmpfs volume mount options."
28322 },
28323 "immutable": true,
28324 "locationInModule": {
28325 "filename": "lib/linux-parameters.ts",
28326 "line": 174
28327 },
28328 "name": "mountOptions",
28329 "optional": true,
28330 "type": {
28331 "collection": {
28332 "elementtype": {
28333 "fqn": "@aws-cdk/aws-ecs.TmpfsMountOption"
28334 },
28335 "kind": "array"
28336 }
28337 }
28338 }
28339 ],
28340 "symbolId": "lib/linux-parameters:Tmpfs"
28341 },
28342 "@aws-cdk/aws-ecs.TmpfsMountOption": {
28343 "assembly": "@aws-cdk/aws-ecs",
28344 "docs": {
28345 "stability": "stable",
28346 "summary": "The supported options for a tmpfs mount for a container."
28347 },
28348 "fqn": "@aws-cdk/aws-ecs.TmpfsMountOption",
28349 "kind": "enum",
28350 "locationInModule": {
28351 "filename": "lib/linux-parameters.ts",
28352 "line": 252
28353 },
28354 "members": [
28355 {
28356 "docs": {
28357 "stability": "stable"
28358 },
28359 "name": "DEFAULTS"
28360 },
28361 {
28362 "docs": {
28363 "stability": "stable"
28364 },
28365 "name": "RO"
28366 },
28367 {
28368 "docs": {
28369 "stability": "stable"
28370 },
28371 "name": "RW"
28372 },
28373 {
28374 "docs": {
28375 "stability": "stable"
28376 },
28377 "name": "SUID"
28378 },
28379 {
28380 "docs": {
28381 "stability": "stable"
28382 },
28383 "name": "NOSUID"
28384 },
28385 {
28386 "docs": {
28387 "stability": "stable"
28388 },
28389 "name": "DEV"
28390 },
28391 {
28392 "docs": {
28393 "stability": "stable"
28394 },
28395 "name": "NODEV"
28396 },
28397 {
28398 "docs": {
28399 "stability": "stable"
28400 },
28401 "name": "EXEC"
28402 },
28403 {
28404 "docs": {
28405 "stability": "stable"
28406 },
28407 "name": "NOEXEC"
28408 },
28409 {
28410 "docs": {
28411 "stability": "stable"
28412 },
28413 "name": "SYNC"
28414 },
28415 {
28416 "docs": {
28417 "stability": "stable"
28418 },
28419 "name": "ASYNC"
28420 },
28421 {
28422 "docs": {
28423 "stability": "stable"
28424 },
28425 "name": "DIRSYNC"
28426 },
28427 {
28428 "docs": {
28429 "stability": "stable"
28430 },
28431 "name": "REMOUNT"
28432 },
28433 {
28434 "docs": {
28435 "stability": "stable"
28436 },
28437 "name": "MAND"
28438 },
28439 {
28440 "docs": {
28441 "stability": "stable"
28442 },
28443 "name": "NOMAND"
28444 },
28445 {
28446 "docs": {
28447 "stability": "stable"
28448 },
28449 "name": "ATIME"
28450 },
28451 {
28452 "docs": {
28453 "stability": "stable"
28454 },
28455 "name": "NOATIME"
28456 },
28457 {
28458 "docs": {
28459 "stability": "stable"
28460 },
28461 "name": "DIRATIME"
28462 },
28463 {
28464 "docs": {
28465 "stability": "stable"
28466 },
28467 "name": "NODIRATIME"
28468 },
28469 {
28470 "docs": {
28471 "stability": "stable"
28472 },
28473 "name": "BIND"
28474 },
28475 {
28476 "docs": {
28477 "stability": "stable"
28478 },
28479 "name": "RBIND"
28480 },
28481 {
28482 "docs": {
28483 "stability": "stable"
28484 },
28485 "name": "UNBINDABLE"
28486 },
28487 {
28488 "docs": {
28489 "stability": "stable"
28490 },
28491 "name": "RUNBINDABLE"
28492 },
28493 {
28494 "docs": {
28495 "stability": "stable"
28496 },
28497 "name": "PRIVATE"
28498 },
28499 {
28500 "docs": {
28501 "stability": "stable"
28502 },
28503 "name": "RPRIVATE"
28504 },
28505 {
28506 "docs": {
28507 "stability": "stable"
28508 },
28509 "name": "SHARED"
28510 },
28511 {
28512 "docs": {
28513 "stability": "stable"
28514 },
28515 "name": "RSHARED"
28516 },
28517 {
28518 "docs": {
28519 "stability": "stable"
28520 },
28521 "name": "SLAVE"
28522 },
28523 {
28524 "docs": {
28525 "stability": "stable"
28526 },
28527 "name": "RSLAVE"
28528 },
28529 {
28530 "docs": {
28531 "stability": "stable"
28532 },
28533 "name": "RELATIME"
28534 },
28535 {
28536 "docs": {
28537 "stability": "stable"
28538 },
28539 "name": "NORELATIME"
28540 },
28541 {
28542 "docs": {
28543 "stability": "stable"
28544 },
28545 "name": "STRICTATIME"
28546 },
28547 {
28548 "docs": {
28549 "stability": "stable"
28550 },
28551 "name": "NOSTRICTATIME"
28552 },
28553 {
28554 "docs": {
28555 "stability": "stable"
28556 },
28557 "name": "MODE"
28558 },
28559 {
28560 "docs": {
28561 "stability": "stable"
28562 },
28563 "name": "UID"
28564 },
28565 {
28566 "docs": {
28567 "stability": "stable"
28568 },
28569 "name": "GID"
28570 },
28571 {
28572 "docs": {
28573 "stability": "stable"
28574 },
28575 "name": "NR_INODES"
28576 },
28577 {
28578 "docs": {
28579 "stability": "stable"
28580 },
28581 "name": "NR_BLOCKS"
28582 },
28583 {
28584 "docs": {
28585 "stability": "stable"
28586 },
28587 "name": "MPOL"
28588 }
28589 ],
28590 "name": "TmpfsMountOption",
28591 "symbolId": "lib/linux-parameters:TmpfsMountOption"
28592 },
28593 "@aws-cdk/aws-ecs.TrackCustomMetricProps": {
28594 "assembly": "@aws-cdk/aws-ecs",
28595 "datatype": true,
28596 "docs": {
28597 "stability": "stable",
28598 "summary": "The properties for enabling target tracking scaling based on a custom CloudWatch metric.",
28599 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nimport * as ecs from '@aws-cdk/aws-ecs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const metric: cloudwatch.Metric;\nconst trackCustomMetricProps: ecs.TrackCustomMetricProps = {\n metric: metric,\n targetValue: 123,\n\n // the properties below are optional\n disableScaleIn: false,\n policyName: 'policyName',\n scaleInCooldown: cdk.Duration.minutes(30),\n scaleOutCooldown: cdk.Duration.minutes(30),\n};",
28600 "custom": {
28601 "exampleMetadata": "fixture=_generated"
28602 }
28603 },
28604 "fqn": "@aws-cdk/aws-ecs.TrackCustomMetricProps",
28605 "interfaces": [
28606 "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps"
28607 ],
28608 "kind": "interface",
28609 "locationInModule": {
28610 "filename": "lib/base/scalable-task-count.ts",
28611 "line": 138
28612 },
28613 "name": "TrackCustomMetricProps",
28614 "properties": [
28615 {
28616 "abstract": true,
28617 "docs": {
28618 "remarks": "The metric must represent utilization; that is, you will always get the following behavior:\n\n- metric > targetValue => scale out\n- metric < targetValue => scale in",
28619 "stability": "stable",
28620 "summary": "The custom CloudWatch metric to track."
28621 },
28622 "immutable": true,
28623 "locationInModule": {
28624 "filename": "lib/base/scalable-task-count.ts",
28625 "line": 147
28626 },
28627 "name": "metric",
28628 "type": {
28629 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
28630 }
28631 },
28632 {
28633 "abstract": true,
28634 "docs": {
28635 "stability": "stable",
28636 "summary": "The target value for the custom CloudWatch metric."
28637 },
28638 "immutable": true,
28639 "locationInModule": {
28640 "filename": "lib/base/scalable-task-count.ts",
28641 "line": 152
28642 },
28643 "name": "targetValue",
28644 "type": {
28645 "primitive": "number"
28646 }
28647 }
28648 ],
28649 "symbolId": "lib/base/scalable-task-count:TrackCustomMetricProps"
28650 },
28651 "@aws-cdk/aws-ecs.Ulimit": {
28652 "assembly": "@aws-cdk/aws-ecs",
28653 "datatype": true,
28654 "docs": {
28655 "remarks": "NOTE: Does not work for Windows containers.",
28656 "stability": "stable",
28657 "summary": "The ulimit settings to pass to the container.",
28658 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst ulimit: ecs.Ulimit = {\n hardLimit: 123,\n name: ecs.UlimitName.CORE,\n softLimit: 123,\n};",
28659 "custom": {
28660 "exampleMetadata": "fixture=_generated"
28661 }
28662 },
28663 "fqn": "@aws-cdk/aws-ecs.Ulimit",
28664 "kind": "interface",
28665 "locationInModule": {
28666 "filename": "lib/container-definition.ts",
28667 "line": 874
28668 },
28669 "name": "Ulimit",
28670 "properties": [
28671 {
28672 "abstract": true,
28673 "docs": {
28674 "stability": "stable",
28675 "summary": "The hard limit for the ulimit type."
28676 },
28677 "immutable": true,
28678 "locationInModule": {
28679 "filename": "lib/container-definition.ts",
28680 "line": 890
28681 },
28682 "name": "hardLimit",
28683 "type": {
28684 "primitive": "number"
28685 }
28686 },
28687 {
28688 "abstract": true,
28689 "docs": {
28690 "remarks": "For more information, see [UlimitName](https://docs.aws.amazon.com/cdk/api/latest/typescript/api/aws-ecs/ulimitname.html#aws_ecs_UlimitName).",
28691 "stability": "stable",
28692 "summary": "The type of the ulimit."
28693 },
28694 "immutable": true,
28695 "locationInModule": {
28696 "filename": "lib/container-definition.ts",
28697 "line": 880
28698 },
28699 "name": "name",
28700 "type": {
28701 "fqn": "@aws-cdk/aws-ecs.UlimitName"
28702 }
28703 },
28704 {
28705 "abstract": true,
28706 "docs": {
28707 "stability": "stable",
28708 "summary": "The soft limit for the ulimit type."
28709 },
28710 "immutable": true,
28711 "locationInModule": {
28712 "filename": "lib/container-definition.ts",
28713 "line": 885
28714 },
28715 "name": "softLimit",
28716 "type": {
28717 "primitive": "number"
28718 }
28719 }
28720 ],
28721 "symbolId": "lib/container-definition:Ulimit"
28722 },
28723 "@aws-cdk/aws-ecs.UlimitName": {
28724 "assembly": "@aws-cdk/aws-ecs",
28725 "docs": {
28726 "stability": "stable",
28727 "summary": "Type of resource to set a limit on."
28728 },
28729 "fqn": "@aws-cdk/aws-ecs.UlimitName",
28730 "kind": "enum",
28731 "locationInModule": {
28732 "filename": "lib/container-definition.ts",
28733 "line": 896
28734 },
28735 "members": [
28736 {
28737 "docs": {
28738 "stability": "stable"
28739 },
28740 "name": "CORE"
28741 },
28742 {
28743 "docs": {
28744 "stability": "stable"
28745 },
28746 "name": "CPU"
28747 },
28748 {
28749 "docs": {
28750 "stability": "stable"
28751 },
28752 "name": "DATA"
28753 },
28754 {
28755 "docs": {
28756 "stability": "stable"
28757 },
28758 "name": "FSIZE"
28759 },
28760 {
28761 "docs": {
28762 "stability": "stable"
28763 },
28764 "name": "LOCKS"
28765 },
28766 {
28767 "docs": {
28768 "stability": "stable"
28769 },
28770 "name": "MEMLOCK"
28771 },
28772 {
28773 "docs": {
28774 "stability": "stable"
28775 },
28776 "name": "MSGQUEUE"
28777 },
28778 {
28779 "docs": {
28780 "stability": "stable"
28781 },
28782 "name": "NICE"
28783 },
28784 {
28785 "docs": {
28786 "stability": "stable"
28787 },
28788 "name": "NOFILE"
28789 },
28790 {
28791 "docs": {
28792 "stability": "stable"
28793 },
28794 "name": "NPROC"
28795 },
28796 {
28797 "docs": {
28798 "stability": "stable"
28799 },
28800 "name": "RSS"
28801 },
28802 {
28803 "docs": {
28804 "stability": "stable"
28805 },
28806 "name": "RTPRIO"
28807 },
28808 {
28809 "docs": {
28810 "stability": "stable"
28811 },
28812 "name": "RTTIME"
28813 },
28814 {
28815 "docs": {
28816 "stability": "stable"
28817 },
28818 "name": "SIGPENDING"
28819 },
28820 {
28821 "docs": {
28822 "stability": "stable"
28823 },
28824 "name": "STACK"
28825 }
28826 ],
28827 "name": "UlimitName",
28828 "symbolId": "lib/container-definition:UlimitName"
28829 },
28830 "@aws-cdk/aws-ecs.Volume": {
28831 "assembly": "@aws-cdk/aws-ecs",
28832 "datatype": true,
28833 "docs": {
28834 "custom": {
28835 "exampleMetadata": "infused"
28836 },
28837 "example": "const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {\n memoryLimitMiB: 512,\n cpu: 256,\n});\nconst volume = {\n // Use an Elastic FileSystem\n name: \"mydatavolume\",\n efsVolumeConfiguration: {\n fileSystemId: \"EFS\",\n // ... other options here ...\n },\n};\n\nconst container = fargateTaskDefinition.addVolume(volume);",
28838 "remarks": "For tasks that use a Docker volume, specify a DockerVolumeConfiguration.\nFor tasks that use a bind mount host volume, specify a host and optional sourcePath.\n\nFor more information, see [Using Data Volumes in Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).",
28839 "stability": "stable",
28840 "summary": "A data volume used in a task definition."
28841 },
28842 "fqn": "@aws-cdk/aws-ecs.Volume",
28843 "kind": "interface",
28844 "locationInModule": {
28845 "filename": "lib/base/task-definition.ts",
28846 "line": 854
28847 },
28848 "name": "Volume",
28849 "properties": [
28850 {
28851 "abstract": true,
28852 "docs": {
28853 "remarks": "Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.\nThis name is referenced in the sourceVolume parameter of container definition mountPoints.",
28854 "stability": "stable",
28855 "summary": "The name of the volume."
28856 },
28857 "immutable": true,
28858 "locationInModule": {
28859 "filename": "lib/base/task-definition.ts",
28860 "line": 872
28861 },
28862 "name": "name",
28863 "type": {
28864 "primitive": "string"
28865 }
28866 },
28867 {
28868 "abstract": true,
28869 "docs": {
28870 "remarks": "Docker volumes are only supported when you are using the EC2 launch type.\nWindows containers only support the use of the local driver.\nTo use bind mounts, specify a host instead.",
28871 "stability": "stable",
28872 "summary": "This property is specified when you are using Docker volumes."
28873 },
28874 "immutable": true,
28875 "locationInModule": {
28876 "filename": "lib/base/task-definition.ts",
28877 "line": 881
28878 },
28879 "name": "dockerVolumeConfiguration",
28880 "optional": true,
28881 "type": {
28882 "fqn": "@aws-cdk/aws-ecs.DockerVolumeConfiguration"
28883 }
28884 },
28885 {
28886 "abstract": true,
28887 "docs": {
28888 "default": "No Elastic FileSystem is setup",
28889 "remarks": "When specifying Amazon EFS volumes in tasks using the Fargate launch type,\nFargate creates a supervisor container that is responsible for managing the Amazon EFS volume.\nThe supervisor container uses a small amount of the task's memory.\nThe supervisor container is visible when querying the task metadata version 4 endpoint,\nbut is not visible in CloudWatch Container Insights.",
28890 "stability": "stable",
28891 "summary": "This property is specified when you are using Amazon EFS."
28892 },
28893 "immutable": true,
28894 "locationInModule": {
28895 "filename": "lib/base/task-definition.ts",
28896 "line": 894
28897 },
28898 "name": "efsVolumeConfiguration",
28899 "optional": true,
28900 "type": {
28901 "fqn": "@aws-cdk/aws-ecs.EfsVolumeConfiguration"
28902 }
28903 },
28904 {
28905 "abstract": true,
28906 "docs": {
28907 "remarks": "Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types.\nThe contents of the host parameter determine whether your bind mount host volume persists on the\nhost container instance and where it is stored. If the host parameter is empty, then the Docker\ndaemon assigns a host path for your data volume. However, the data is not guaranteed to persist\nafter the containers associated with it stop running.",
28908 "stability": "stable",
28909 "summary": "This property is specified when you are using bind mount host volumes."
28910 },
28911 "immutable": true,
28912 "locationInModule": {
28913 "filename": "lib/base/task-definition.ts",
28914 "line": 864
28915 },
28916 "name": "host",
28917 "optional": true,
28918 "type": {
28919 "fqn": "@aws-cdk/aws-ecs.Host"
28920 }
28921 }
28922 ],
28923 "symbolId": "lib/base/task-definition:Volume"
28924 },
28925 "@aws-cdk/aws-ecs.VolumeFrom": {
28926 "assembly": "@aws-cdk/aws-ecs",
28927 "datatype": true,
28928 "docs": {
28929 "stability": "stable",
28930 "summary": "The details on a data volume from another container in the same task definition.",
28931 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecs from '@aws-cdk/aws-ecs';\nconst volumeFrom: ecs.VolumeFrom = {\n readOnly: false,\n sourceContainer: 'sourceContainer',\n};",
28932 "custom": {
28933 "exampleMetadata": "fixture=_generated"
28934 }
28935 },
28936 "fqn": "@aws-cdk/aws-ecs.VolumeFrom",
28937 "kind": "interface",
28938 "locationInModule": {
28939 "filename": "lib/container-definition.ts",
28940 "line": 1091
28941 },
28942 "name": "VolumeFrom",
28943 "properties": [
28944 {
28945 "abstract": true,
28946 "docs": {
28947 "remarks": "If this value is true, the container has read-only access to the volume.\nIf this value is false, then the container can write to the volume.",
28948 "stability": "stable",
28949 "summary": "Specifies whether the container has read-only access to the volume."
28950 },
28951 "immutable": true,
28952 "locationInModule": {
28953 "filename": "lib/container-definition.ts",
28954 "line": 1103
28955 },
28956 "name": "readOnly",
28957 "type": {
28958 "primitive": "boolean"
28959 }
28960 },
28961 {
28962 "abstract": true,
28963 "docs": {
28964 "stability": "stable",
28965 "summary": "The name of another container within the same task definition from which to mount volumes."
28966 },
28967 "immutable": true,
28968 "locationInModule": {
28969 "filename": "lib/container-definition.ts",
28970 "line": 1095
28971 },
28972 "name": "sourceContainer",
28973 "type": {
28974 "primitive": "string"
28975 }
28976 }
28977 ],
28978 "symbolId": "lib/container-definition:VolumeFrom"
28979 },
28980 "@aws-cdk/aws-ecs.WindowsOptimizedVersion": {
28981 "assembly": "@aws-cdk/aws-ecs",
28982 "docs": {
28983 "stability": "stable",
28984 "summary": "ECS-optimized Windows version list."
28985 },
28986 "fqn": "@aws-cdk/aws-ecs.WindowsOptimizedVersion",
28987 "kind": "enum",
28988 "locationInModule": {
28989 "filename": "lib/amis.ts",
28990 "line": 34
28991 },
28992 "members": [
28993 {
28994 "docs": {
28995 "stability": "stable"
28996 },
28997 "name": "SERVER_2019"
28998 },
28999 {
29000 "docs": {
29001 "stability": "stable"
29002 },
29003 "name": "SERVER_2016"
29004 }
29005 ],
29006 "name": "WindowsOptimizedVersion",
29007 "symbolId": "lib/amis:WindowsOptimizedVersion"
29008 }
29009 },
29010 "version": "1.156.1",
29011 "fingerprint": "**********"
29012}