UNPKG

352 kBPlain 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-iam": "1.203.0",
12 "@aws-cdk/aws-lambda": "1.203.0",
13 "@aws-cdk/aws-s3": "1.203.0",
14 "@aws-cdk/aws-sns": "1.203.0",
15 "@aws-cdk/core": "1.203.0",
16 "@aws-cdk/cx-api": "1.203.0",
17 "constructs": "^3.3.69"
18 },
19 "dependencyClosure": {
20 "@aws-cdk/assets": {
21 "targets": {
22 "dotnet": {
23 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
24 "namespace": "Amazon.CDK.Assets",
25 "packageId": "Amazon.CDK.Assets"
26 },
27 "java": {
28 "maven": {
29 "artifactId": "cdk-assets",
30 "groupId": "software.amazon.awscdk"
31 },
32 "package": "software.amazon.awscdk.assets"
33 },
34 "js": {
35 "npm": "@aws-cdk/assets"
36 },
37 "python": {
38 "classifiers": [
39 "Framework :: AWS CDK",
40 "Framework :: AWS CDK :: 1"
41 ],
42 "distName": "aws-cdk.assets",
43 "module": "aws_cdk.assets"
44 }
45 }
46 },
47 "@aws-cdk/aws-applicationautoscaling": {
48 "targets": {
49 "dotnet": {
50 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
51 "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling",
52 "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling"
53 },
54 "java": {
55 "maven": {
56 "artifactId": "applicationautoscaling",
57 "groupId": "software.amazon.awscdk"
58 },
59 "package": "software.amazon.awscdk.services.applicationautoscaling"
60 },
61 "js": {
62 "npm": "@aws-cdk/aws-applicationautoscaling"
63 },
64 "python": {
65 "classifiers": [
66 "Framework :: AWS CDK",
67 "Framework :: AWS CDK :: 1"
68 ],
69 "distName": "aws-cdk.aws-applicationautoscaling",
70 "module": "aws_cdk.aws_applicationautoscaling"
71 }
72 }
73 },
74 "@aws-cdk/aws-autoscaling-common": {
75 "targets": {
76 "dotnet": {
77 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
78 "namespace": "Amazon.CDK.AWS.AutoScaling.Common",
79 "packageId": "Amazon.CDK.AWS.AutoScaling.Common"
80 },
81 "java": {
82 "maven": {
83 "artifactId": "autoscaling-common",
84 "groupId": "software.amazon.awscdk"
85 },
86 "package": "software.amazon.awscdk.services.autoscaling.common"
87 },
88 "js": {
89 "npm": "@aws-cdk/aws-autoscaling-common"
90 },
91 "python": {
92 "classifiers": [
93 "Framework :: AWS CDK",
94 "Framework :: AWS CDK :: 1"
95 ],
96 "distName": "aws-cdk.aws-autoscaling-common",
97 "module": "aws_cdk.aws_autoscaling_common"
98 }
99 }
100 },
101 "@aws-cdk/aws-cloudwatch": {
102 "targets": {
103 "dotnet": {
104 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
105 "namespace": "Amazon.CDK.AWS.CloudWatch",
106 "packageId": "Amazon.CDK.AWS.CloudWatch"
107 },
108 "java": {
109 "maven": {
110 "artifactId": "cloudwatch",
111 "groupId": "software.amazon.awscdk"
112 },
113 "package": "software.amazon.awscdk.services.cloudwatch"
114 },
115 "js": {
116 "npm": "@aws-cdk/aws-cloudwatch"
117 },
118 "python": {
119 "classifiers": [
120 "Framework :: AWS CDK",
121 "Framework :: AWS CDK :: 1"
122 ],
123 "distName": "aws-cdk.aws-cloudwatch",
124 "module": "aws_cdk.aws_cloudwatch"
125 }
126 }
127 },
128 "@aws-cdk/aws-codeguruprofiler": {
129 "targets": {
130 "dotnet": {
131 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
132 "namespace": "Amazon.CDK.AWS.CodeGuruProfiler",
133 "packageId": "Amazon.CDK.AWS.CodeGuruProfiler"
134 },
135 "java": {
136 "maven": {
137 "artifactId": "codeguruprofiler",
138 "groupId": "software.amazon.awscdk"
139 },
140 "package": "software.amazon.awscdk.services.codeguruprofiler"
141 },
142 "js": {
143 "npm": "@aws-cdk/aws-codeguruprofiler"
144 },
145 "python": {
146 "classifiers": [
147 "Framework :: AWS CDK",
148 "Framework :: AWS CDK :: 1"
149 ],
150 "distName": "aws-cdk.aws-codeguruprofiler",
151 "module": "aws_cdk.aws_codeguruprofiler"
152 }
153 }
154 },
155 "@aws-cdk/aws-codestarnotifications": {
156 "targets": {
157 "dotnet": {
158 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
159 "namespace": "Amazon.CDK.AWS.CodeStarNotifications",
160 "packageId": "Amazon.CDK.AWS.CodeStarNotifications"
161 },
162 "java": {
163 "maven": {
164 "artifactId": "codestarnotifications",
165 "groupId": "software.amazon.awscdk"
166 },
167 "package": "software.amazon.awscdk.services.codestarnotifications"
168 },
169 "js": {
170 "npm": "@aws-cdk/aws-codestarnotifications"
171 },
172 "python": {
173 "classifiers": [
174 "Framework :: AWS CDK",
175 "Framework :: AWS CDK :: 1"
176 ],
177 "distName": "aws-cdk.aws-codestarnotifications",
178 "module": "aws_cdk.aws_codestarnotifications"
179 }
180 }
181 },
182 "@aws-cdk/aws-ec2": {
183 "targets": {
184 "dotnet": {
185 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
186 "namespace": "Amazon.CDK.AWS.EC2",
187 "packageId": "Amazon.CDK.AWS.EC2"
188 },
189 "java": {
190 "maven": {
191 "artifactId": "ec2",
192 "groupId": "software.amazon.awscdk"
193 },
194 "package": "software.amazon.awscdk.services.ec2"
195 },
196 "js": {
197 "npm": "@aws-cdk/aws-ec2"
198 },
199 "python": {
200 "classifiers": [
201 "Framework :: AWS CDK",
202 "Framework :: AWS CDK :: 1"
203 ],
204 "distName": "aws-cdk.aws-ec2",
205 "module": "aws_cdk.aws_ec2"
206 }
207 }
208 },
209 "@aws-cdk/aws-ecr": {
210 "targets": {
211 "dotnet": {
212 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
213 "namespace": "Amazon.CDK.AWS.ECR",
214 "packageId": "Amazon.CDK.AWS.ECR"
215 },
216 "java": {
217 "maven": {
218 "artifactId": "ecr",
219 "groupId": "software.amazon.awscdk"
220 },
221 "package": "software.amazon.awscdk.services.ecr"
222 },
223 "js": {
224 "npm": "@aws-cdk/aws-ecr"
225 },
226 "python": {
227 "classifiers": [
228 "Framework :: AWS CDK",
229 "Framework :: AWS CDK :: 1"
230 ],
231 "distName": "aws-cdk.aws-ecr",
232 "module": "aws_cdk.aws_ecr"
233 }
234 }
235 },
236 "@aws-cdk/aws-ecr-assets": {
237 "targets": {
238 "dotnet": {
239 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
240 "namespace": "Amazon.CDK.AWS.Ecr.Assets",
241 "packageId": "Amazon.CDK.ECR.Assets"
242 },
243 "java": {
244 "maven": {
245 "artifactId": "ecr-assets",
246 "groupId": "software.amazon.awscdk"
247 },
248 "package": "software.amazon.awscdk.services.ecr.assets"
249 },
250 "js": {
251 "npm": "@aws-cdk/aws-ecr-assets"
252 },
253 "python": {
254 "classifiers": [
255 "Framework :: AWS CDK",
256 "Framework :: AWS CDK :: 1"
257 ],
258 "distName": "aws-cdk.aws-ecr-assets",
259 "module": "aws_cdk.aws_ecr_assets"
260 }
261 }
262 },
263 "@aws-cdk/aws-efs": {
264 "targets": {
265 "dotnet": {
266 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
267 "namespace": "Amazon.CDK.AWS.EFS",
268 "packageId": "Amazon.CDK.AWS.EFS"
269 },
270 "java": {
271 "maven": {
272 "artifactId": "efs",
273 "groupId": "software.amazon.awscdk"
274 },
275 "package": "software.amazon.awscdk.services.efs"
276 },
277 "js": {
278 "npm": "@aws-cdk/aws-efs"
279 },
280 "python": {
281 "classifiers": [
282 "Framework :: AWS CDK",
283 "Framework :: AWS CDK :: 1"
284 ],
285 "distName": "aws-cdk.aws-efs",
286 "module": "aws_cdk.aws_efs"
287 }
288 }
289 },
290 "@aws-cdk/aws-events": {
291 "targets": {
292 "dotnet": {
293 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
294 "namespace": "Amazon.CDK.AWS.Events",
295 "packageId": "Amazon.CDK.AWS.Events"
296 },
297 "java": {
298 "maven": {
299 "artifactId": "events",
300 "groupId": "software.amazon.awscdk"
301 },
302 "package": "software.amazon.awscdk.services.events"
303 },
304 "js": {
305 "npm": "@aws-cdk/aws-events"
306 },
307 "python": {
308 "classifiers": [
309 "Framework :: AWS CDK",
310 "Framework :: AWS CDK :: 1"
311 ],
312 "distName": "aws-cdk.aws-events",
313 "module": "aws_cdk.aws_events"
314 }
315 }
316 },
317 "@aws-cdk/aws-iam": {
318 "targets": {
319 "dotnet": {
320 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
321 "namespace": "Amazon.CDK.AWS.IAM",
322 "packageId": "Amazon.CDK.AWS.IAM"
323 },
324 "java": {
325 "maven": {
326 "artifactId": "iam",
327 "groupId": "software.amazon.awscdk"
328 },
329 "package": "software.amazon.awscdk.services.iam"
330 },
331 "js": {
332 "npm": "@aws-cdk/aws-iam"
333 },
334 "python": {
335 "classifiers": [
336 "Framework :: AWS CDK",
337 "Framework :: AWS CDK :: 1"
338 ],
339 "distName": "aws-cdk.aws-iam",
340 "module": "aws_cdk.aws_iam"
341 }
342 }
343 },
344 "@aws-cdk/aws-kms": {
345 "targets": {
346 "dotnet": {
347 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
348 "namespace": "Amazon.CDK.AWS.KMS",
349 "packageId": "Amazon.CDK.AWS.KMS"
350 },
351 "java": {
352 "maven": {
353 "artifactId": "kms",
354 "groupId": "software.amazon.awscdk"
355 },
356 "package": "software.amazon.awscdk.services.kms"
357 },
358 "js": {
359 "npm": "@aws-cdk/aws-kms"
360 },
361 "python": {
362 "classifiers": [
363 "Framework :: AWS CDK",
364 "Framework :: AWS CDK :: 1"
365 ],
366 "distName": "aws-cdk.aws-kms",
367 "module": "aws_cdk.aws_kms"
368 }
369 }
370 },
371 "@aws-cdk/aws-lambda": {
372 "targets": {
373 "dotnet": {
374 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
375 "namespace": "Amazon.CDK.AWS.Lambda",
376 "packageId": "Amazon.CDK.AWS.Lambda"
377 },
378 "java": {
379 "maven": {
380 "artifactId": "lambda",
381 "groupId": "software.amazon.awscdk"
382 },
383 "package": "software.amazon.awscdk.services.lambda"
384 },
385 "js": {
386 "npm": "@aws-cdk/aws-lambda"
387 },
388 "python": {
389 "classifiers": [
390 "Framework :: AWS CDK",
391 "Framework :: AWS CDK :: 1"
392 ],
393 "distName": "aws-cdk.aws-lambda",
394 "module": "aws_cdk.aws_lambda"
395 }
396 }
397 },
398 "@aws-cdk/aws-logs": {
399 "targets": {
400 "dotnet": {
401 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
402 "namespace": "Amazon.CDK.AWS.Logs",
403 "packageId": "Amazon.CDK.AWS.Logs"
404 },
405 "java": {
406 "maven": {
407 "artifactId": "logs",
408 "groupId": "software.amazon.awscdk"
409 },
410 "package": "software.amazon.awscdk.services.logs"
411 },
412 "js": {
413 "npm": "@aws-cdk/aws-logs"
414 },
415 "python": {
416 "classifiers": [
417 "Framework :: AWS CDK",
418 "Framework :: AWS CDK :: 1"
419 ],
420 "distName": "aws-cdk.aws-logs",
421 "module": "aws_cdk.aws_logs"
422 }
423 }
424 },
425 "@aws-cdk/aws-s3": {
426 "targets": {
427 "dotnet": {
428 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
429 "namespace": "Amazon.CDK.AWS.S3",
430 "packageId": "Amazon.CDK.AWS.S3"
431 },
432 "java": {
433 "maven": {
434 "artifactId": "s3",
435 "groupId": "software.amazon.awscdk"
436 },
437 "package": "software.amazon.awscdk.services.s3"
438 },
439 "js": {
440 "npm": "@aws-cdk/aws-s3"
441 },
442 "python": {
443 "classifiers": [
444 "Framework :: AWS CDK",
445 "Framework :: AWS CDK :: 1"
446 ],
447 "distName": "aws-cdk.aws-s3",
448 "module": "aws_cdk.aws_s3"
449 }
450 }
451 },
452 "@aws-cdk/aws-s3-assets": {
453 "targets": {
454 "dotnet": {
455 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
456 "namespace": "Amazon.CDK.AWS.S3.Assets",
457 "packageId": "Amazon.CDK.AWS.S3.Assets"
458 },
459 "java": {
460 "maven": {
461 "artifactId": "s3-assets",
462 "groupId": "software.amazon.awscdk"
463 },
464 "package": "software.amazon.awscdk.services.s3.assets"
465 },
466 "js": {
467 "npm": "@aws-cdk/aws-s3-assets"
468 },
469 "python": {
470 "classifiers": [
471 "Framework :: AWS CDK",
472 "Framework :: AWS CDK :: 1"
473 ],
474 "distName": "aws-cdk.aws-s3-assets",
475 "module": "aws_cdk.aws_s3_assets"
476 }
477 }
478 },
479 "@aws-cdk/aws-signer": {
480 "targets": {
481 "dotnet": {
482 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
483 "namespace": "Amazon.CDK.AWS.Signer",
484 "packageId": "Amazon.CDK.AWS.Signer"
485 },
486 "java": {
487 "maven": {
488 "artifactId": "signer",
489 "groupId": "software.amazon.awscdk"
490 },
491 "package": "software.amazon.awscdk.services.signer"
492 },
493 "js": {
494 "npm": "@aws-cdk/aws-signer"
495 },
496 "python": {
497 "classifiers": [
498 "Framework :: AWS CDK",
499 "Framework :: AWS CDK :: 1"
500 ],
501 "distName": "aws-cdk.aws-signer",
502 "module": "aws_cdk.aws_signer"
503 }
504 }
505 },
506 "@aws-cdk/aws-sns": {
507 "targets": {
508 "dotnet": {
509 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
510 "namespace": "Amazon.CDK.AWS.SNS",
511 "packageId": "Amazon.CDK.AWS.SNS"
512 },
513 "java": {
514 "maven": {
515 "artifactId": "sns",
516 "groupId": "software.amazon.awscdk"
517 },
518 "package": "software.amazon.awscdk.services.sns"
519 },
520 "js": {
521 "npm": "@aws-cdk/aws-sns"
522 },
523 "python": {
524 "classifiers": [
525 "Framework :: AWS CDK",
526 "Framework :: AWS CDK :: 1"
527 ],
528 "distName": "aws-cdk.aws-sns",
529 "module": "aws_cdk.aws_sns"
530 }
531 }
532 },
533 "@aws-cdk/aws-sqs": {
534 "targets": {
535 "dotnet": {
536 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
537 "namespace": "Amazon.CDK.AWS.SQS",
538 "packageId": "Amazon.CDK.AWS.SQS"
539 },
540 "java": {
541 "maven": {
542 "artifactId": "sqs",
543 "groupId": "software.amazon.awscdk"
544 },
545 "package": "software.amazon.awscdk.services.sqs"
546 },
547 "js": {
548 "npm": "@aws-cdk/aws-sqs"
549 },
550 "python": {
551 "classifiers": [
552 "Framework :: AWS CDK",
553 "Framework :: AWS CDK :: 1"
554 ],
555 "distName": "aws-cdk.aws-sqs",
556 "module": "aws_cdk.aws_sqs"
557 }
558 }
559 },
560 "@aws-cdk/aws-ssm": {
561 "targets": {
562 "dotnet": {
563 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
564 "namespace": "Amazon.CDK.AWS.SSM",
565 "packageId": "Amazon.CDK.AWS.SSM"
566 },
567 "java": {
568 "maven": {
569 "artifactId": "ssm",
570 "groupId": "software.amazon.awscdk"
571 },
572 "package": "software.amazon.awscdk.services.ssm"
573 },
574 "js": {
575 "npm": "@aws-cdk/aws-ssm"
576 },
577 "python": {
578 "classifiers": [
579 "Framework :: AWS CDK",
580 "Framework :: AWS CDK :: 1"
581 ],
582 "distName": "aws-cdk.aws-ssm",
583 "module": "aws_cdk.aws_ssm"
584 }
585 }
586 },
587 "@aws-cdk/cloud-assembly-schema": {
588 "targets": {
589 "dotnet": {
590 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
591 "namespace": "Amazon.CDK.CloudAssembly.Schema",
592 "packageId": "Amazon.CDK.CloudAssembly.Schema"
593 },
594 "java": {
595 "maven": {
596 "artifactId": "cdk-cloud-assembly-schema",
597 "groupId": "software.amazon.awscdk"
598 },
599 "package": "software.amazon.awscdk.cloudassembly.schema"
600 },
601 "js": {
602 "npm": "@aws-cdk/cloud-assembly-schema"
603 },
604 "python": {
605 "classifiers": [
606 "Framework :: AWS CDK",
607 "Framework :: AWS CDK :: 1"
608 ],
609 "distName": "aws-cdk.cloud-assembly-schema",
610 "module": "aws_cdk.cloud_assembly_schema"
611 }
612 }
613 },
614 "@aws-cdk/core": {
615 "targets": {
616 "dotnet": {
617 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
618 "namespace": "Amazon.CDK",
619 "packageId": "Amazon.CDK"
620 },
621 "java": {
622 "maven": {
623 "artifactId": "core",
624 "groupId": "software.amazon.awscdk"
625 },
626 "package": "software.amazon.awscdk.core"
627 },
628 "js": {
629 "npm": "@aws-cdk/core"
630 },
631 "python": {
632 "classifiers": [
633 "Framework :: AWS CDK",
634 "Framework :: AWS CDK :: 1"
635 ],
636 "distName": "aws-cdk.core",
637 "module": "aws_cdk.core"
638 }
639 }
640 },
641 "@aws-cdk/cx-api": {
642 "targets": {
643 "dotnet": {
644 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
645 "namespace": "Amazon.CDK.CXAPI",
646 "packageId": "Amazon.CDK.CXAPI"
647 },
648 "java": {
649 "maven": {
650 "artifactId": "cdk-cx-api",
651 "groupId": "software.amazon.awscdk"
652 },
653 "package": "software.amazon.awscdk.cxapi"
654 },
655 "js": {
656 "npm": "@aws-cdk/cx-api"
657 },
658 "python": {
659 "classifiers": [
660 "Framework :: AWS CDK",
661 "Framework :: AWS CDK :: 1"
662 ],
663 "distName": "aws-cdk.cx-api",
664 "module": "aws_cdk.cx_api"
665 }
666 }
667 },
668 "@aws-cdk/region-info": {
669 "targets": {
670 "dotnet": {
671 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
672 "namespace": "Amazon.CDK.RegionInfo",
673 "packageId": "Amazon.CDK.RegionInfo"
674 },
675 "java": {
676 "maven": {
677 "artifactId": "cdk-region-info",
678 "groupId": "software.amazon.awscdk"
679 },
680 "package": "software.amazon.awscdk.regioninfo"
681 },
682 "js": {
683 "npm": "@aws-cdk/region-info"
684 },
685 "python": {
686 "classifiers": [
687 "Framework :: AWS CDK",
688 "Framework :: AWS CDK :: 1"
689 ],
690 "distName": "aws-cdk.region-info",
691 "module": "aws_cdk.region_info"
692 }
693 }
694 },
695 "constructs": {
696 "targets": {
697 "dotnet": {
698 "namespace": "Constructs",
699 "packageId": "Constructs"
700 },
701 "go": {
702 "moduleName": "github.com/aws/constructs-go"
703 },
704 "java": {
705 "maven": {
706 "artifactId": "constructs",
707 "groupId": "software.constructs"
708 },
709 "package": "software.constructs"
710 },
711 "js": {
712 "npm": "constructs"
713 },
714 "python": {
715 "distName": "constructs",
716 "module": "constructs"
717 }
718 }
719 }
720 },
721 "description": "The CDK Construct Library for AWS::CloudFormation",
722 "docs": {
723 "stability": "deprecated"
724 },
725 "homepage": "https://github.com/aws/aws-cdk",
726 "jsiiVersion": "1.74.0 (build 6d08790)",
727 "keywords": [
728 "aws",
729 "cdk",
730 "constructs",
731 "cloudformation"
732 ],
733 "license": "Apache-2.0",
734 "metadata": {
735 "jsii": {
736 "compiledWithDeprecationWarnings": true,
737 "pacmak": {
738 "hasDefaultInterfaces": true
739 },
740 "rosetta": {
741 "strict": true
742 }
743 }
744 },
745 "name": "@aws-cdk/aws-cloudformation",
746 "readme": {
747 "markdown": "# AWS CloudFormation Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Deprecated](https://img.shields.io/badge/deprecated-critical.svg?style=for-the-badge)\n\n> This API may emit warnings. Backward compatibility is not guaranteed.\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n"
748 },
749 "repository": {
750 "directory": "packages/@aws-cdk/aws-cloudformation",
751 "type": "git",
752 "url": "https://github.com/aws/aws-cdk.git"
753 },
754 "schema": "jsii/0.10.0",
755 "targets": {
756 "dotnet": {
757 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
758 "namespace": "Amazon.CDK.AWS.CloudFormation",
759 "packageId": "Amazon.CDK.AWS.CloudFormation"
760 },
761 "java": {
762 "maven": {
763 "artifactId": "cloudformation",
764 "groupId": "software.amazon.awscdk"
765 },
766 "package": "software.amazon.awscdk.services.cloudformation"
767 },
768 "js": {
769 "npm": "@aws-cdk/aws-cloudformation"
770 },
771 "python": {
772 "classifiers": [
773 "Framework :: AWS CDK",
774 "Framework :: AWS CDK :: 1"
775 ],
776 "distName": "aws-cdk.aws-cloudformation",
777 "module": "aws_cdk.aws_cloudformation"
778 }
779 },
780 "types": {
781 "@aws-cdk/aws-cloudformation.CfnCustomResource": {
782 "assembly": "@aws-cdk/aws-cloudformation",
783 "base": "@aws-cdk/core.CfnResource",
784 "docs": {
785 "custom": {
786 "cloudformationResource": "AWS::CloudFormation::CustomResource",
787 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html",
788 "exampleMetadata": "fixture=_generated"
789 },
790 "remarks": "In a CloudFormation template, you use the `AWS::CloudFormation::CustomResource` or `Custom:: *String*` resource type to specify custom resources.\n\nCustom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see [Custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) .\n\n> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, custom resources in the VPC must have access to CloudFormation -specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .",
791 "stability": "external",
792 "summary": "A CloudFormation `AWS::CloudFormation::CustomResource`.",
793 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnCustomResource = new cloudformation.CfnCustomResource(this, 'MyCfnCustomResource', {\n serviceToken: 'serviceToken',\n});"
794 },
795 "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResource",
796 "initializer": {
797 "docs": {
798 "stability": "external",
799 "summary": "Create a new `AWS::CloudFormation::CustomResource`."
800 },
801 "locationInModule": {
802 "filename": "lib/cloudformation.generated.ts",
803 "line": 136
804 },
805 "parameters": [
806 {
807 "docs": {
808 "summary": "- scope in which this resource is defined."
809 },
810 "name": "scope",
811 "type": {
812 "fqn": "@aws-cdk/core.Construct"
813 }
814 },
815 {
816 "docs": {
817 "summary": "- scoped id of the resource."
818 },
819 "name": "id",
820 "type": {
821 "primitive": "string"
822 }
823 },
824 {
825 "docs": {
826 "summary": "- resource properties."
827 },
828 "name": "props",
829 "type": {
830 "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResourceProps"
831 }
832 }
833 ]
834 },
835 "interfaces": [
836 "@aws-cdk/core.IInspectable"
837 ],
838 "kind": "class",
839 "locationInModule": {
840 "filename": "lib/cloudformation.generated.ts",
841 "line": 93
842 },
843 "methods": [
844 {
845 "docs": {
846 "stability": "external",
847 "summary": "Examines the CloudFormation resource and discloses attributes."
848 },
849 "locationInModule": {
850 "filename": "lib/cloudformation.generated.ts",
851 "line": 149
852 },
853 "name": "inspect",
854 "overrides": "@aws-cdk/core.IInspectable",
855 "parameters": [
856 {
857 "docs": {
858 "summary": "- tree inspector to collect and process attributes."
859 },
860 "name": "inspector",
861 "type": {
862 "fqn": "@aws-cdk/core.TreeInspector"
863 }
864 }
865 ]
866 },
867 {
868 "docs": {
869 "stability": "external"
870 },
871 "locationInModule": {
872 "filename": "lib/cloudformation.generated.ts",
873 "line": 160
874 },
875 "name": "renderProperties",
876 "overrides": "@aws-cdk/core.CfnResource",
877 "parameters": [
878 {
879 "name": "props",
880 "type": {
881 "collection": {
882 "elementtype": {
883 "primitive": "any"
884 },
885 "kind": "map"
886 }
887 }
888 }
889 ],
890 "protected": true,
891 "returns": {
892 "type": {
893 "collection": {
894 "elementtype": {
895 "primitive": "any"
896 },
897 "kind": "map"
898 }
899 }
900 }
901 }
902 ],
903 "name": "CfnCustomResource",
904 "properties": [
905 {
906 "const": true,
907 "docs": {
908 "stability": "external",
909 "summary": "The CloudFormation resource type name for this resource class."
910 },
911 "immutable": true,
912 "locationInModule": {
913 "filename": "lib/cloudformation.generated.ts",
914 "line": 97
915 },
916 "name": "CFN_RESOURCE_TYPE_NAME",
917 "static": true,
918 "type": {
919 "primitive": "string"
920 }
921 },
922 {
923 "docs": {
924 "stability": "external"
925 },
926 "immutable": true,
927 "locationInModule": {
928 "filename": "lib/cloudformation.generated.ts",
929 "line": 154
930 },
931 "name": "cfnProperties",
932 "overrides": "@aws-cdk/core.CfnResource",
933 "protected": true,
934 "type": {
935 "collection": {
936 "elementtype": {
937 "primitive": "any"
938 },
939 "kind": "map"
940 }
941 }
942 },
943 {
944 "docs": {
945 "custom": {
946 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken"
947 },
948 "remarks": "All other properties are defined by the service provider.\n\nThe service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region in which you are creating the stack.\n\nUpdates aren't supported.",
949 "stability": "external",
950 "summary": "> Only one property is defined by AWS for a custom resource: `ServiceToken` ."
951 },
952 "locationInModule": {
953 "filename": "lib/cloudformation.generated.ts",
954 "line": 127
955 },
956 "name": "serviceToken",
957 "type": {
958 "primitive": "string"
959 }
960 }
961 ],
962 "symbolId": "lib/cloudformation.generated:CfnCustomResource"
963 },
964 "@aws-cdk/aws-cloudformation.CfnCustomResourceProps": {
965 "assembly": "@aws-cdk/aws-cloudformation",
966 "datatype": true,
967 "docs": {
968 "custom": {
969 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html",
970 "exampleMetadata": "fixture=_generated"
971 },
972 "stability": "external",
973 "summary": "Properties for defining a `CfnCustomResource`.",
974 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnCustomResourceProps: cloudformation.CfnCustomResourceProps = {\n serviceToken: 'serviceToken',\n};"
975 },
976 "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResourceProps",
977 "kind": "interface",
978 "locationInModule": {
979 "filename": "lib/cloudformation.generated.ts",
980 "line": 19
981 },
982 "name": "CfnCustomResourceProps",
983 "properties": [
984 {
985 "abstract": true,
986 "docs": {
987 "custom": {
988 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken"
989 },
990 "remarks": "All other properties are defined by the service provider.\n\nThe service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region in which you are creating the stack.\n\nUpdates aren't supported.",
991 "stability": "external",
992 "summary": "> Only one property is defined by AWS for a custom resource: `ServiceToken` ."
993 },
994 "immutable": true,
995 "locationInModule": {
996 "filename": "lib/cloudformation.generated.ts",
997 "line": 30
998 },
999 "name": "serviceToken",
1000 "type": {
1001 "primitive": "string"
1002 }
1003 }
1004 ],
1005 "symbolId": "lib/cloudformation.generated:CfnCustomResourceProps"
1006 },
1007 "@aws-cdk/aws-cloudformation.CfnHookDefaultVersion": {
1008 "assembly": "@aws-cdk/aws-cloudformation",
1009 "base": "@aws-cdk/core.CfnResource",
1010 "docs": {
1011 "custom": {
1012 "cloudformationResource": "AWS::CloudFormation::HookDefaultVersion",
1013 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html",
1014 "exampleMetadata": "fixture=_generated"
1015 },
1016 "remarks": "The `HookDefaultVersion` resource specifies the default version of the hook. The default version of the hook is used in CloudFormation operations for this AWS account and AWS Region .",
1017 "stability": "external",
1018 "summary": "A CloudFormation `AWS::CloudFormation::HookDefaultVersion`.",
1019 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookDefaultVersion = new cloudformation.CfnHookDefaultVersion(this, 'MyCfnHookDefaultVersion', /* all optional props */ {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n});"
1020 },
1021 "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersion",
1022 "initializer": {
1023 "docs": {
1024 "stability": "external",
1025 "summary": "Create a new `AWS::CloudFormation::HookDefaultVersion`."
1026 },
1027 "locationInModule": {
1028 "filename": "lib/cloudformation.generated.ts",
1029 "line": 329
1030 },
1031 "parameters": [
1032 {
1033 "docs": {
1034 "summary": "- scope in which this resource is defined."
1035 },
1036 "name": "scope",
1037 "type": {
1038 "fqn": "@aws-cdk/core.Construct"
1039 }
1040 },
1041 {
1042 "docs": {
1043 "summary": "- scoped id of the resource."
1044 },
1045 "name": "id",
1046 "type": {
1047 "primitive": "string"
1048 }
1049 },
1050 {
1051 "docs": {
1052 "summary": "- resource properties."
1053 },
1054 "name": "props",
1055 "optional": true,
1056 "type": {
1057 "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps"
1058 }
1059 }
1060 ]
1061 },
1062 "interfaces": [
1063 "@aws-cdk/core.IInspectable"
1064 ],
1065 "kind": "class",
1066 "locationInModule": {
1067 "filename": "lib/cloudformation.generated.ts",
1068 "line": 264
1069 },
1070 "methods": [
1071 {
1072 "docs": {
1073 "stability": "external",
1074 "summary": "Examines the CloudFormation resource and discloses attributes."
1075 },
1076 "locationInModule": {
1077 "filename": "lib/cloudformation.generated.ts",
1078 "line": 344
1079 },
1080 "name": "inspect",
1081 "overrides": "@aws-cdk/core.IInspectable",
1082 "parameters": [
1083 {
1084 "docs": {
1085 "summary": "- tree inspector to collect and process attributes."
1086 },
1087 "name": "inspector",
1088 "type": {
1089 "fqn": "@aws-cdk/core.TreeInspector"
1090 }
1091 }
1092 ]
1093 },
1094 {
1095 "docs": {
1096 "stability": "external"
1097 },
1098 "locationInModule": {
1099 "filename": "lib/cloudformation.generated.ts",
1100 "line": 357
1101 },
1102 "name": "renderProperties",
1103 "overrides": "@aws-cdk/core.CfnResource",
1104 "parameters": [
1105 {
1106 "name": "props",
1107 "type": {
1108 "collection": {
1109 "elementtype": {
1110 "primitive": "any"
1111 },
1112 "kind": "map"
1113 }
1114 }
1115 }
1116 ],
1117 "protected": true,
1118 "returns": {
1119 "type": {
1120 "collection": {
1121 "elementtype": {
1122 "primitive": "any"
1123 },
1124 "kind": "map"
1125 }
1126 }
1127 }
1128 }
1129 ],
1130 "name": "CfnHookDefaultVersion",
1131 "properties": [
1132 {
1133 "const": true,
1134 "docs": {
1135 "stability": "external",
1136 "summary": "The CloudFormation resource type name for this resource class."
1137 },
1138 "immutable": true,
1139 "locationInModule": {
1140 "filename": "lib/cloudformation.generated.ts",
1141 "line": 268
1142 },
1143 "name": "CFN_RESOURCE_TYPE_NAME",
1144 "static": true,
1145 "type": {
1146 "primitive": "string"
1147 }
1148 },
1149 {
1150 "docs": {
1151 "custom": {
1152 "cloudformationAttribute": "Arn"
1153 },
1154 "stability": "external",
1155 "summary": "The Amazon Resource Number (ARN) of the activated extension, in this account and Region."
1156 },
1157 "immutable": true,
1158 "locationInModule": {
1159 "filename": "lib/cloudformation.generated.ts",
1160 "line": 293
1161 },
1162 "name": "attrArn",
1163 "type": {
1164 "primitive": "string"
1165 }
1166 },
1167 {
1168 "docs": {
1169 "stability": "external"
1170 },
1171 "immutable": true,
1172 "locationInModule": {
1173 "filename": "lib/cloudformation.generated.ts",
1174 "line": 349
1175 },
1176 "name": "cfnProperties",
1177 "overrides": "@aws-cdk/core.CfnResource",
1178 "protected": true,
1179 "type": {
1180 "collection": {
1181 "elementtype": {
1182 "primitive": "any"
1183 },
1184 "kind": "map"
1185 }
1186 }
1187 },
1188 {
1189 "docs": {
1190 "custom": {
1191 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename"
1192 },
1193 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1194 "stability": "external",
1195 "summary": "The name of the hook."
1196 },
1197 "locationInModule": {
1198 "filename": "lib/cloudformation.generated.ts",
1199 "line": 302
1200 },
1201 "name": "typeName",
1202 "optional": true,
1203 "type": {
1204 "primitive": "string"
1205 }
1206 },
1207 {
1208 "docs": {
1209 "custom": {
1210 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn"
1211 },
1212 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1213 "stability": "external",
1214 "summary": "The version ID of the type configuration."
1215 },
1216 "locationInModule": {
1217 "filename": "lib/cloudformation.generated.ts",
1218 "line": 311
1219 },
1220 "name": "typeVersionArn",
1221 "optional": true,
1222 "type": {
1223 "primitive": "string"
1224 }
1225 },
1226 {
1227 "docs": {
1228 "custom": {
1229 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid"
1230 },
1231 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1232 "stability": "external",
1233 "summary": "The version ID of the type specified."
1234 },
1235 "locationInModule": {
1236 "filename": "lib/cloudformation.generated.ts",
1237 "line": 320
1238 },
1239 "name": "versionId",
1240 "optional": true,
1241 "type": {
1242 "primitive": "string"
1243 }
1244 }
1245 ],
1246 "symbolId": "lib/cloudformation.generated:CfnHookDefaultVersion"
1247 },
1248 "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps": {
1249 "assembly": "@aws-cdk/aws-cloudformation",
1250 "datatype": true,
1251 "docs": {
1252 "custom": {
1253 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html",
1254 "exampleMetadata": "fixture=_generated"
1255 },
1256 "stability": "external",
1257 "summary": "Properties for defining a `CfnHookDefaultVersion`.",
1258 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookDefaultVersionProps: cloudformation.CfnHookDefaultVersionProps = {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n};"
1259 },
1260 "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps",
1261 "kind": "interface",
1262 "locationInModule": {
1263 "filename": "lib/cloudformation.generated.ts",
1264 "line": 173
1265 },
1266 "name": "CfnHookDefaultVersionProps",
1267 "properties": [
1268 {
1269 "abstract": true,
1270 "docs": {
1271 "custom": {
1272 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename"
1273 },
1274 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1275 "stability": "external",
1276 "summary": "The name of the hook."
1277 },
1278 "immutable": true,
1279 "locationInModule": {
1280 "filename": "lib/cloudformation.generated.ts",
1281 "line": 182
1282 },
1283 "name": "typeName",
1284 "optional": true,
1285 "type": {
1286 "primitive": "string"
1287 }
1288 },
1289 {
1290 "abstract": true,
1291 "docs": {
1292 "custom": {
1293 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn"
1294 },
1295 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1296 "stability": "external",
1297 "summary": "The version ID of the type configuration."
1298 },
1299 "immutable": true,
1300 "locationInModule": {
1301 "filename": "lib/cloudformation.generated.ts",
1302 "line": 191
1303 },
1304 "name": "typeVersionArn",
1305 "optional": true,
1306 "type": {
1307 "primitive": "string"
1308 }
1309 },
1310 {
1311 "abstract": true,
1312 "docs": {
1313 "custom": {
1314 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid"
1315 },
1316 "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
1317 "stability": "external",
1318 "summary": "The version ID of the type specified."
1319 },
1320 "immutable": true,
1321 "locationInModule": {
1322 "filename": "lib/cloudformation.generated.ts",
1323 "line": 200
1324 },
1325 "name": "versionId",
1326 "optional": true,
1327 "type": {
1328 "primitive": "string"
1329 }
1330 }
1331 ],
1332 "symbolId": "lib/cloudformation.generated:CfnHookDefaultVersionProps"
1333 },
1334 "@aws-cdk/aws-cloudformation.CfnHookTypeConfig": {
1335 "assembly": "@aws-cdk/aws-cloudformation",
1336 "base": "@aws-cdk/core.CfnResource",
1337 "docs": {
1338 "custom": {
1339 "cloudformationResource": "AWS::CloudFormation::HookTypeConfig",
1340 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html",
1341 "exampleMetadata": "fixture=_generated"
1342 },
1343 "remarks": "The `HookTypeConfig` resource specifies the configuration of a hook.",
1344 "stability": "external",
1345 "summary": "A CloudFormation `AWS::CloudFormation::HookTypeConfig`.",
1346 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookTypeConfig = new cloudformation.CfnHookTypeConfig(this, 'MyCfnHookTypeConfig', {\n configuration: 'configuration',\n\n // the properties below are optional\n configurationAlias: 'configurationAlias',\n typeArn: 'typeArn',\n typeName: 'typeName',\n});"
1347 },
1348 "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfig",
1349 "initializer": {
1350 "docs": {
1351 "stability": "external",
1352 "summary": "Create a new `AWS::CloudFormation::HookTypeConfig`."
1353 },
1354 "locationInModule": {
1355 "filename": "lib/cloudformation.generated.ts",
1356 "line": 548
1357 },
1358 "parameters": [
1359 {
1360 "docs": {
1361 "summary": "- scope in which this resource is defined."
1362 },
1363 "name": "scope",
1364 "type": {
1365 "fqn": "@aws-cdk/core.Construct"
1366 }
1367 },
1368 {
1369 "docs": {
1370 "summary": "- scoped id of the resource."
1371 },
1372 "name": "id",
1373 "type": {
1374 "primitive": "string"
1375 }
1376 },
1377 {
1378 "docs": {
1379 "summary": "- resource properties."
1380 },
1381 "name": "props",
1382 "type": {
1383 "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps"
1384 }
1385 }
1386 ]
1387 },
1388 "interfaces": [
1389 "@aws-cdk/core.IInspectable"
1390 ],
1391 "kind": "class",
1392 "locationInModule": {
1393 "filename": "lib/cloudformation.generated.ts",
1394 "line": 474
1395 },
1396 "methods": [
1397 {
1398 "docs": {
1399 "stability": "external",
1400 "summary": "Examines the CloudFormation resource and discloses attributes."
1401 },
1402 "locationInModule": {
1403 "filename": "lib/cloudformation.generated.ts",
1404 "line": 565
1405 },
1406 "name": "inspect",
1407 "overrides": "@aws-cdk/core.IInspectable",
1408 "parameters": [
1409 {
1410 "docs": {
1411 "summary": "- tree inspector to collect and process attributes."
1412 },
1413 "name": "inspector",
1414 "type": {
1415 "fqn": "@aws-cdk/core.TreeInspector"
1416 }
1417 }
1418 ]
1419 },
1420 {
1421 "docs": {
1422 "stability": "external"
1423 },
1424 "locationInModule": {
1425 "filename": "lib/cloudformation.generated.ts",
1426 "line": 579
1427 },
1428 "name": "renderProperties",
1429 "overrides": "@aws-cdk/core.CfnResource",
1430 "parameters": [
1431 {
1432 "name": "props",
1433 "type": {
1434 "collection": {
1435 "elementtype": {
1436 "primitive": "any"
1437 },
1438 "kind": "map"
1439 }
1440 }
1441 }
1442 ],
1443 "protected": true,
1444 "returns": {
1445 "type": {
1446 "collection": {
1447 "elementtype": {
1448 "primitive": "any"
1449 },
1450 "kind": "map"
1451 }
1452 }
1453 }
1454 }
1455 ],
1456 "name": "CfnHookTypeConfig",
1457 "properties": [
1458 {
1459 "const": true,
1460 "docs": {
1461 "stability": "external",
1462 "summary": "The CloudFormation resource type name for this resource class."
1463 },
1464 "immutable": true,
1465 "locationInModule": {
1466 "filename": "lib/cloudformation.generated.ts",
1467 "line": 478
1468 },
1469 "name": "CFN_RESOURCE_TYPE_NAME",
1470 "static": true,
1471 "type": {
1472 "primitive": "string"
1473 }
1474 },
1475 {
1476 "docs": {
1477 "custom": {
1478 "cloudformationAttribute": "ConfigurationArn"
1479 },
1480 "stability": "external",
1481 "summary": "The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region."
1482 },
1483 "immutable": true,
1484 "locationInModule": {
1485 "filename": "lib/cloudformation.generated.ts",
1486 "line": 503
1487 },
1488 "name": "attrConfigurationArn",
1489 "type": {
1490 "primitive": "string"
1491 }
1492 },
1493 {
1494 "docs": {
1495 "stability": "external"
1496 },
1497 "immutable": true,
1498 "locationInModule": {
1499 "filename": "lib/cloudformation.generated.ts",
1500 "line": 570
1501 },
1502 "name": "cfnProperties",
1503 "overrides": "@aws-cdk/core.CfnResource",
1504 "protected": true,
1505 "type": {
1506 "collection": {
1507 "elementtype": {
1508 "primitive": "any"
1509 },
1510 "kind": "map"
1511 }
1512 }
1513 },
1514 {
1515 "docs": {
1516 "custom": {
1517 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration"
1518 },
1519 "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1520 "stability": "external",
1521 "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ."
1522 },
1523 "locationInModule": {
1524 "filename": "lib/cloudformation.generated.ts",
1525 "line": 512
1526 },
1527 "name": "configuration",
1528 "type": {
1529 "primitive": "string"
1530 }
1531 },
1532 {
1533 "docs": {
1534 "custom": {
1535 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias"
1536 },
1537 "remarks": "Defaults to `default` alias. Hook types currently support default configuration alias.",
1538 "stability": "external",
1539 "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ."
1540 },
1541 "locationInModule": {
1542 "filename": "lib/cloudformation.generated.ts",
1543 "line": 521
1544 },
1545 "name": "configurationAlias",
1546 "optional": true,
1547 "type": {
1548 "primitive": "string"
1549 }
1550 },
1551 {
1552 "docs": {
1553 "custom": {
1554 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn"
1555 },
1556 "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1557 "stability": "external",
1558 "summary": "The Amazon Resource Number (ARN) for the hook to set `Configuration` for."
1559 },
1560 "locationInModule": {
1561 "filename": "lib/cloudformation.generated.ts",
1562 "line": 530
1563 },
1564 "name": "typeArn",
1565 "optional": true,
1566 "type": {
1567 "primitive": "string"
1568 }
1569 },
1570 {
1571 "docs": {
1572 "custom": {
1573 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename"
1574 },
1575 "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1576 "stability": "external",
1577 "summary": "The unique name for your hook."
1578 },
1579 "locationInModule": {
1580 "filename": "lib/cloudformation.generated.ts",
1581 "line": 539
1582 },
1583 "name": "typeName",
1584 "optional": true,
1585 "type": {
1586 "primitive": "string"
1587 }
1588 }
1589 ],
1590 "symbolId": "lib/cloudformation.generated:CfnHookTypeConfig"
1591 },
1592 "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps": {
1593 "assembly": "@aws-cdk/aws-cloudformation",
1594 "datatype": true,
1595 "docs": {
1596 "custom": {
1597 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html",
1598 "exampleMetadata": "fixture=_generated"
1599 },
1600 "stability": "external",
1601 "summary": "Properties for defining a `CfnHookTypeConfig`.",
1602 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookTypeConfigProps: cloudformation.CfnHookTypeConfigProps = {\n configuration: 'configuration',\n\n // the properties below are optional\n configurationAlias: 'configurationAlias',\n typeArn: 'typeArn',\n typeName: 'typeName',\n};"
1603 },
1604 "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps",
1605 "kind": "interface",
1606 "locationInModule": {
1607 "filename": "lib/cloudformation.generated.ts",
1608 "line": 370
1609 },
1610 "name": "CfnHookTypeConfigProps",
1611 "properties": [
1612 {
1613 "abstract": true,
1614 "docs": {
1615 "custom": {
1616 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration"
1617 },
1618 "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1619 "stability": "external",
1620 "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ."
1621 },
1622 "immutable": true,
1623 "locationInModule": {
1624 "filename": "lib/cloudformation.generated.ts",
1625 "line": 379
1626 },
1627 "name": "configuration",
1628 "type": {
1629 "primitive": "string"
1630 }
1631 },
1632 {
1633 "abstract": true,
1634 "docs": {
1635 "custom": {
1636 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias"
1637 },
1638 "remarks": "Defaults to `default` alias. Hook types currently support default configuration alias.",
1639 "stability": "external",
1640 "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ."
1641 },
1642 "immutable": true,
1643 "locationInModule": {
1644 "filename": "lib/cloudformation.generated.ts",
1645 "line": 388
1646 },
1647 "name": "configurationAlias",
1648 "optional": true,
1649 "type": {
1650 "primitive": "string"
1651 }
1652 },
1653 {
1654 "abstract": true,
1655 "docs": {
1656 "custom": {
1657 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn"
1658 },
1659 "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1660 "stability": "external",
1661 "summary": "The Amazon Resource Number (ARN) for the hook to set `Configuration` for."
1662 },
1663 "immutable": true,
1664 "locationInModule": {
1665 "filename": "lib/cloudformation.generated.ts",
1666 "line": 397
1667 },
1668 "name": "typeArn",
1669 "optional": true,
1670 "type": {
1671 "primitive": "string"
1672 }
1673 },
1674 {
1675 "abstract": true,
1676 "docs": {
1677 "custom": {
1678 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename"
1679 },
1680 "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .",
1681 "stability": "external",
1682 "summary": "The unique name for your hook."
1683 },
1684 "immutable": true,
1685 "locationInModule": {
1686 "filename": "lib/cloudformation.generated.ts",
1687 "line": 406
1688 },
1689 "name": "typeName",
1690 "optional": true,
1691 "type": {
1692 "primitive": "string"
1693 }
1694 }
1695 ],
1696 "symbolId": "lib/cloudformation.generated:CfnHookTypeConfigProps"
1697 },
1698 "@aws-cdk/aws-cloudformation.CfnHookVersion": {
1699 "assembly": "@aws-cdk/aws-cloudformation",
1700 "base": "@aws-cdk/core.CfnResource",
1701 "docs": {
1702 "custom": {
1703 "cloudformationResource": "AWS::CloudFormation::HookVersion",
1704 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html",
1705 "exampleMetadata": "fixture=_generated"
1706 },
1707 "remarks": "The `HookVersion` resource publishes new or first hook version to the AWS CloudFormation registry.",
1708 "stability": "external",
1709 "summary": "A CloudFormation `AWS::CloudFormation::HookVersion`.",
1710 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookVersion = new cloudformation.CfnHookVersion(this, 'MyCfnHookVersion', {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n});"
1711 },
1712 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion",
1713 "initializer": {
1714 "docs": {
1715 "stability": "external",
1716 "summary": "Create a new `AWS::CloudFormation::HookVersion`."
1717 },
1718 "locationInModule": {
1719 "filename": "lib/cloudformation.generated.ts",
1720 "line": 812
1721 },
1722 "parameters": [
1723 {
1724 "docs": {
1725 "summary": "- scope in which this resource is defined."
1726 },
1727 "name": "scope",
1728 "type": {
1729 "fqn": "@aws-cdk/core.Construct"
1730 }
1731 },
1732 {
1733 "docs": {
1734 "summary": "- scoped id of the resource."
1735 },
1736 "name": "id",
1737 "type": {
1738 "primitive": "string"
1739 }
1740 },
1741 {
1742 "docs": {
1743 "summary": "- resource properties."
1744 },
1745 "name": "props",
1746 "type": {
1747 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersionProps"
1748 }
1749 }
1750 ]
1751 },
1752 "interfaces": [
1753 "@aws-cdk/core.IInspectable"
1754 ],
1755 "kind": "class",
1756 "locationInModule": {
1757 "filename": "lib/cloudformation.generated.ts",
1758 "line": 703
1759 },
1760 "methods": [
1761 {
1762 "docs": {
1763 "stability": "external",
1764 "summary": "Examines the CloudFormation resource and discloses attributes."
1765 },
1766 "locationInModule": {
1767 "filename": "lib/cloudformation.generated.ts",
1768 "line": 834
1769 },
1770 "name": "inspect",
1771 "overrides": "@aws-cdk/core.IInspectable",
1772 "parameters": [
1773 {
1774 "docs": {
1775 "summary": "- tree inspector to collect and process attributes."
1776 },
1777 "name": "inspector",
1778 "type": {
1779 "fqn": "@aws-cdk/core.TreeInspector"
1780 }
1781 }
1782 ]
1783 },
1784 {
1785 "docs": {
1786 "stability": "external"
1787 },
1788 "locationInModule": {
1789 "filename": "lib/cloudformation.generated.ts",
1790 "line": 848
1791 },
1792 "name": "renderProperties",
1793 "overrides": "@aws-cdk/core.CfnResource",
1794 "parameters": [
1795 {
1796 "name": "props",
1797 "type": {
1798 "collection": {
1799 "elementtype": {
1800 "primitive": "any"
1801 },
1802 "kind": "map"
1803 }
1804 }
1805 }
1806 ],
1807 "protected": true,
1808 "returns": {
1809 "type": {
1810 "collection": {
1811 "elementtype": {
1812 "primitive": "any"
1813 },
1814 "kind": "map"
1815 }
1816 }
1817 }
1818 }
1819 ],
1820 "name": "CfnHookVersion",
1821 "properties": [
1822 {
1823 "const": true,
1824 "docs": {
1825 "stability": "external",
1826 "summary": "The CloudFormation resource type name for this resource class."
1827 },
1828 "immutable": true,
1829 "locationInModule": {
1830 "filename": "lib/cloudformation.generated.ts",
1831 "line": 707
1832 },
1833 "name": "CFN_RESOURCE_TYPE_NAME",
1834 "static": true,
1835 "type": {
1836 "primitive": "string"
1837 }
1838 },
1839 {
1840 "docs": {
1841 "custom": {
1842 "cloudformationAttribute": "Arn"
1843 },
1844 "stability": "external",
1845 "summary": "The Amazon Resource Name (ARN) of the hook."
1846 },
1847 "immutable": true,
1848 "locationInModule": {
1849 "filename": "lib/cloudformation.generated.ts",
1850 "line": 732
1851 },
1852 "name": "attrArn",
1853 "type": {
1854 "primitive": "string"
1855 }
1856 },
1857 {
1858 "docs": {
1859 "custom": {
1860 "cloudformationAttribute": "IsDefaultVersion"
1861 },
1862 "stability": "external",
1863 "summary": "Whether the specified hook version is set as the default version."
1864 },
1865 "immutable": true,
1866 "locationInModule": {
1867 "filename": "lib/cloudformation.generated.ts",
1868 "line": 738
1869 },
1870 "name": "attrIsDefaultVersion",
1871 "type": {
1872 "fqn": "@aws-cdk/core.IResolvable"
1873 }
1874 },
1875 {
1876 "docs": {
1877 "custom": {
1878 "cloudformationAttribute": "TypeArn"
1879 },
1880 "stability": "external",
1881 "summary": "The Amazon Resource Number (ARN) assigned to this version of the hook."
1882 },
1883 "immutable": true,
1884 "locationInModule": {
1885 "filename": "lib/cloudformation.generated.ts",
1886 "line": 744
1887 },
1888 "name": "attrTypeArn",
1889 "type": {
1890 "primitive": "string"
1891 }
1892 },
1893 {
1894 "docs": {
1895 "custom": {
1896 "cloudformationAttribute": "VersionId"
1897 },
1898 "stability": "external",
1899 "summary": "The ID of this version of the hook."
1900 },
1901 "immutable": true,
1902 "locationInModule": {
1903 "filename": "lib/cloudformation.generated.ts",
1904 "line": 750
1905 },
1906 "name": "attrVersionId",
1907 "type": {
1908 "primitive": "string"
1909 }
1910 },
1911 {
1912 "docs": {
1913 "custom": {
1914 "cloudformationAttribute": "Visibility"
1915 },
1916 "remarks": "Valid values include:\n\n- `PRIVATE` : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as `PRIVATE` .\n- `PUBLIC` : The resource is publicly visible and usable within any Amazon account.",
1917 "stability": "external",
1918 "summary": "The scope at which the resource is visible and usable in CloudFormation operations."
1919 },
1920 "immutable": true,
1921 "locationInModule": {
1922 "filename": "lib/cloudformation.generated.ts",
1923 "line": 761
1924 },
1925 "name": "attrVisibility",
1926 "type": {
1927 "primitive": "string"
1928 }
1929 },
1930 {
1931 "docs": {
1932 "stability": "external"
1933 },
1934 "immutable": true,
1935 "locationInModule": {
1936 "filename": "lib/cloudformation.generated.ts",
1937 "line": 839
1938 },
1939 "name": "cfnProperties",
1940 "overrides": "@aws-cdk/core.CfnResource",
1941 "protected": true,
1942 "type": {
1943 "collection": {
1944 "elementtype": {
1945 "primitive": "any"
1946 },
1947 "kind": "map"
1948 }
1949 }
1950 },
1951 {
1952 "docs": {
1953 "custom": {
1954 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage"
1955 },
1956 "remarks": "For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide for Extension Development* .\n\n> The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
1957 "stability": "external",
1958 "summary": "A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register."
1959 },
1960 "locationInModule": {
1961 "filename": "lib/cloudformation.generated.ts",
1962 "line": 772
1963 },
1964 "name": "schemaHandlerPackage",
1965 "type": {
1966 "primitive": "string"
1967 }
1968 },
1969 {
1970 "docs": {
1971 "custom": {
1972 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename"
1973 },
1974 "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\n> The following organization namespaces are reserved and can't be used in your hook type names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `ASK`\n> - `AWS`\n> - `Custom`\n> - `Dev`",
1975 "stability": "external",
1976 "summary": "The unique name for your hook."
1977 },
1978 "locationInModule": {
1979 "filename": "lib/cloudformation.generated.ts",
1980 "line": 789
1981 },
1982 "name": "typeName",
1983 "type": {
1984 "primitive": "string"
1985 }
1986 },
1987 {
1988 "docs": {
1989 "custom": {
1990 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn"
1991 },
1992 "stability": "external",
1993 "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the hook permission."
1994 },
1995 "locationInModule": {
1996 "filename": "lib/cloudformation.generated.ts",
1997 "line": 796
1998 },
1999 "name": "executionRoleArn",
2000 "optional": true,
2001 "type": {
2002 "primitive": "string"
2003 }
2004 },
2005 {
2006 "docs": {
2007 "custom": {
2008 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig"
2009 },
2010 "stability": "external",
2011 "summary": "Contains logging configuration information for an extension."
2012 },
2013 "locationInModule": {
2014 "filename": "lib/cloudformation.generated.ts",
2015 "line": 803
2016 },
2017 "name": "loggingConfig",
2018 "optional": true,
2019 "type": {
2020 "union": {
2021 "types": [
2022 {
2023 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty"
2024 },
2025 {
2026 "fqn": "@aws-cdk/core.IResolvable"
2027 }
2028 ]
2029 }
2030 }
2031 }
2032 ],
2033 "symbolId": "lib/cloudformation.generated:CfnHookVersion"
2034 },
2035 "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty": {
2036 "assembly": "@aws-cdk/aws-cloudformation",
2037 "datatype": true,
2038 "docs": {
2039 "custom": {
2040 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html",
2041 "exampleMetadata": "fixture=_generated"
2042 },
2043 "stability": "external",
2044 "summary": "The `LoggingConfig` property type specifies logging configuration information for an extension.",
2045 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnHookVersion.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};"
2046 },
2047 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty",
2048 "kind": "interface",
2049 "locationInModule": {
2050 "filename": "lib/cloudformation.generated.ts",
2051 "line": 862
2052 },
2053 "name": "LoggingConfigProperty",
2054 "namespace": "CfnHookVersion",
2055 "properties": [
2056 {
2057 "abstract": true,
2058 "docs": {
2059 "custom": {
2060 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname"
2061 },
2062 "stability": "external",
2063 "summary": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers."
2064 },
2065 "immutable": true,
2066 "locationInModule": {
2067 "filename": "lib/cloudformation.generated.ts",
2068 "line": 868
2069 },
2070 "name": "logGroupName",
2071 "optional": true,
2072 "type": {
2073 "primitive": "string"
2074 }
2075 },
2076 {
2077 "abstract": true,
2078 "docs": {
2079 "custom": {
2080 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn"
2081 },
2082 "stability": "external",
2083 "summary": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs."
2084 },
2085 "immutable": true,
2086 "locationInModule": {
2087 "filename": "lib/cloudformation.generated.ts",
2088 "line": 874
2089 },
2090 "name": "logRoleArn",
2091 "optional": true,
2092 "type": {
2093 "primitive": "string"
2094 }
2095 }
2096 ],
2097 "symbolId": "lib/cloudformation.generated:CfnHookVersion.LoggingConfigProperty"
2098 },
2099 "@aws-cdk/aws-cloudformation.CfnHookVersionProps": {
2100 "assembly": "@aws-cdk/aws-cloudformation",
2101 "datatype": true,
2102 "docs": {
2103 "custom": {
2104 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html",
2105 "exampleMetadata": "fixture=_generated"
2106 },
2107 "stability": "external",
2108 "summary": "Properties for defining a `CfnHookVersion`.",
2109 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookVersionProps: cloudformation.CfnHookVersionProps = {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n};"
2110 },
2111 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersionProps",
2112 "kind": "interface",
2113 "locationInModule": {
2114 "filename": "lib/cloudformation.generated.ts",
2115 "line": 592
2116 },
2117 "name": "CfnHookVersionProps",
2118 "properties": [
2119 {
2120 "abstract": true,
2121 "docs": {
2122 "custom": {
2123 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage"
2124 },
2125 "remarks": "For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide for Extension Development* .\n\n> The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
2126 "stability": "external",
2127 "summary": "A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register."
2128 },
2129 "immutable": true,
2130 "locationInModule": {
2131 "filename": "lib/cloudformation.generated.ts",
2132 "line": 603
2133 },
2134 "name": "schemaHandlerPackage",
2135 "type": {
2136 "primitive": "string"
2137 }
2138 },
2139 {
2140 "abstract": true,
2141 "docs": {
2142 "custom": {
2143 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename"
2144 },
2145 "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\n> The following organization namespaces are reserved and can't be used in your hook type names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `ASK`\n> - `AWS`\n> - `Custom`\n> - `Dev`",
2146 "stability": "external",
2147 "summary": "The unique name for your hook."
2148 },
2149 "immutable": true,
2150 "locationInModule": {
2151 "filename": "lib/cloudformation.generated.ts",
2152 "line": 620
2153 },
2154 "name": "typeName",
2155 "type": {
2156 "primitive": "string"
2157 }
2158 },
2159 {
2160 "abstract": true,
2161 "docs": {
2162 "custom": {
2163 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn"
2164 },
2165 "stability": "external",
2166 "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the hook permission."
2167 },
2168 "immutable": true,
2169 "locationInModule": {
2170 "filename": "lib/cloudformation.generated.ts",
2171 "line": 627
2172 },
2173 "name": "executionRoleArn",
2174 "optional": true,
2175 "type": {
2176 "primitive": "string"
2177 }
2178 },
2179 {
2180 "abstract": true,
2181 "docs": {
2182 "custom": {
2183 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig"
2184 },
2185 "stability": "external",
2186 "summary": "Contains logging configuration information for an extension."
2187 },
2188 "immutable": true,
2189 "locationInModule": {
2190 "filename": "lib/cloudformation.generated.ts",
2191 "line": 634
2192 },
2193 "name": "loggingConfig",
2194 "optional": true,
2195 "type": {
2196 "union": {
2197 "types": [
2198 {
2199 "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty"
2200 },
2201 {
2202 "fqn": "@aws-cdk/core.IResolvable"
2203 }
2204 ]
2205 }
2206 }
2207 }
2208 ],
2209 "symbolId": "lib/cloudformation.generated:CfnHookVersionProps"
2210 },
2211 "@aws-cdk/aws-cloudformation.CfnMacro": {
2212 "assembly": "@aws-cdk/aws-cloudformation",
2213 "base": "@aws-cdk/core.CfnResource",
2214 "docs": {
2215 "custom": {
2216 "cloudformationResource": "AWS::CloudFormation::Macro",
2217 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html",
2218 "exampleMetadata": "fixture=_generated"
2219 },
2220 "remarks": "The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .",
2221 "stability": "external",
2222 "summary": "A CloudFormation `AWS::CloudFormation::Macro`.",
2223 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnMacro = new cloudformation.CfnMacro(this, 'MyCfnMacro', {\n functionName: 'functionName',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n});"
2224 },
2225 "fqn": "@aws-cdk/aws-cloudformation.CfnMacro",
2226 "initializer": {
2227 "docs": {
2228 "stability": "external",
2229 "summary": "Create a new `AWS::CloudFormation::Macro`."
2230 },
2231 "locationInModule": {
2232 "filename": "lib/cloudformation.generated.ts",
2233 "line": 1111
2234 },
2235 "parameters": [
2236 {
2237 "docs": {
2238 "summary": "- scope in which this resource is defined."
2239 },
2240 "name": "scope",
2241 "type": {
2242 "fqn": "@aws-cdk/core.Construct"
2243 }
2244 },
2245 {
2246 "docs": {
2247 "summary": "- scoped id of the resource."
2248 },
2249 "name": "id",
2250 "type": {
2251 "primitive": "string"
2252 }
2253 },
2254 {
2255 "docs": {
2256 "summary": "- resource properties."
2257 },
2258 "name": "props",
2259 "type": {
2260 "fqn": "@aws-cdk/aws-cloudformation.CfnMacroProps"
2261 }
2262 }
2263 ]
2264 },
2265 "interfaces": [
2266 "@aws-cdk/core.IInspectable"
2267 ],
2268 "kind": "class",
2269 "locationInModule": {
2270 "filename": "lib/cloudformation.generated.ts",
2271 "line": 1044
2272 },
2273 "methods": [
2274 {
2275 "docs": {
2276 "stability": "external",
2277 "summary": "Examines the CloudFormation resource and discloses attributes."
2278 },
2279 "locationInModule": {
2280 "filename": "lib/cloudformation.generated.ts",
2281 "line": 1129
2282 },
2283 "name": "inspect",
2284 "overrides": "@aws-cdk/core.IInspectable",
2285 "parameters": [
2286 {
2287 "docs": {
2288 "summary": "- tree inspector to collect and process attributes."
2289 },
2290 "name": "inspector",
2291 "type": {
2292 "fqn": "@aws-cdk/core.TreeInspector"
2293 }
2294 }
2295 ]
2296 },
2297 {
2298 "docs": {
2299 "stability": "external"
2300 },
2301 "locationInModule": {
2302 "filename": "lib/cloudformation.generated.ts",
2303 "line": 1144
2304 },
2305 "name": "renderProperties",
2306 "overrides": "@aws-cdk/core.CfnResource",
2307 "parameters": [
2308 {
2309 "name": "props",
2310 "type": {
2311 "collection": {
2312 "elementtype": {
2313 "primitive": "any"
2314 },
2315 "kind": "map"
2316 }
2317 }
2318 }
2319 ],
2320 "protected": true,
2321 "returns": {
2322 "type": {
2323 "collection": {
2324 "elementtype": {
2325 "primitive": "any"
2326 },
2327 "kind": "map"
2328 }
2329 }
2330 }
2331 }
2332 ],
2333 "name": "CfnMacro",
2334 "properties": [
2335 {
2336 "const": true,
2337 "docs": {
2338 "stability": "external",
2339 "summary": "The CloudFormation resource type name for this resource class."
2340 },
2341 "immutable": true,
2342 "locationInModule": {
2343 "filename": "lib/cloudformation.generated.ts",
2344 "line": 1048
2345 },
2346 "name": "CFN_RESOURCE_TYPE_NAME",
2347 "static": true,
2348 "type": {
2349 "primitive": "string"
2350 }
2351 },
2352 {
2353 "docs": {
2354 "stability": "external"
2355 },
2356 "immutable": true,
2357 "locationInModule": {
2358 "filename": "lib/cloudformation.generated.ts",
2359 "line": 1134
2360 },
2361 "name": "cfnProperties",
2362 "overrides": "@aws-cdk/core.CfnResource",
2363 "protected": true,
2364 "type": {
2365 "collection": {
2366 "elementtype": {
2367 "primitive": "any"
2368 },
2369 "kind": "map"
2370 }
2371 }
2372 },
2373 {
2374 "docs": {
2375 "custom": {
2376 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname"
2377 },
2378 "stability": "external",
2379 "summary": "The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run."
2380 },
2381 "locationInModule": {
2382 "filename": "lib/cloudformation.generated.ts",
2383 "line": 1074
2384 },
2385 "name": "functionName",
2386 "type": {
2387 "primitive": "string"
2388 }
2389 },
2390 {
2391 "docs": {
2392 "custom": {
2393 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name"
2394 },
2395 "remarks": "The name of the macro must be unique across all macros in the account.",
2396 "stability": "external",
2397 "summary": "The name of the macro."
2398 },
2399 "locationInModule": {
2400 "filename": "lib/cloudformation.generated.ts",
2401 "line": 1081
2402 },
2403 "name": "name",
2404 "type": {
2405 "primitive": "string"
2406 }
2407 },
2408 {
2409 "docs": {
2410 "custom": {
2411 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description"
2412 },
2413 "stability": "external",
2414 "summary": "A description of the macro."
2415 },
2416 "locationInModule": {
2417 "filename": "lib/cloudformation.generated.ts",
2418 "line": 1088
2419 },
2420 "name": "description",
2421 "optional": true,
2422 "type": {
2423 "primitive": "string"
2424 }
2425 },
2426 {
2427 "docs": {
2428 "custom": {
2429 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname"
2430 },
2431 "stability": "external",
2432 "summary": "The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function."
2433 },
2434 "locationInModule": {
2435 "filename": "lib/cloudformation.generated.ts",
2436 "line": 1095
2437 },
2438 "name": "logGroupName",
2439 "optional": true,
2440 "type": {
2441 "primitive": "string"
2442 }
2443 },
2444 {
2445 "docs": {
2446 "custom": {
2447 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn"
2448 },
2449 "stability": "external",
2450 "summary": "The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs ."
2451 },
2452 "locationInModule": {
2453 "filename": "lib/cloudformation.generated.ts",
2454 "line": 1102
2455 },
2456 "name": "logRoleArn",
2457 "optional": true,
2458 "type": {
2459 "primitive": "string"
2460 }
2461 }
2462 ],
2463 "symbolId": "lib/cloudformation.generated:CfnMacro"
2464 },
2465 "@aws-cdk/aws-cloudformation.CfnMacroProps": {
2466 "assembly": "@aws-cdk/aws-cloudformation",
2467 "datatype": true,
2468 "docs": {
2469 "custom": {
2470 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html",
2471 "exampleMetadata": "fixture=_generated"
2472 },
2473 "stability": "external",
2474 "summary": "Properties for defining a `CfnMacro`.",
2475 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnMacroProps: cloudformation.CfnMacroProps = {\n functionName: 'functionName',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};"
2476 },
2477 "fqn": "@aws-cdk/aws-cloudformation.CfnMacroProps",
2478 "kind": "interface",
2479 "locationInModule": {
2480 "filename": "lib/cloudformation.generated.ts",
2481 "line": 937
2482 },
2483 "name": "CfnMacroProps",
2484 "properties": [
2485 {
2486 "abstract": true,
2487 "docs": {
2488 "custom": {
2489 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname"
2490 },
2491 "stability": "external",
2492 "summary": "The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run."
2493 },
2494 "immutable": true,
2495 "locationInModule": {
2496 "filename": "lib/cloudformation.generated.ts",
2497 "line": 944
2498 },
2499 "name": "functionName",
2500 "type": {
2501 "primitive": "string"
2502 }
2503 },
2504 {
2505 "abstract": true,
2506 "docs": {
2507 "custom": {
2508 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name"
2509 },
2510 "remarks": "The name of the macro must be unique across all macros in the account.",
2511 "stability": "external",
2512 "summary": "The name of the macro."
2513 },
2514 "immutable": true,
2515 "locationInModule": {
2516 "filename": "lib/cloudformation.generated.ts",
2517 "line": 951
2518 },
2519 "name": "name",
2520 "type": {
2521 "primitive": "string"
2522 }
2523 },
2524 {
2525 "abstract": true,
2526 "docs": {
2527 "custom": {
2528 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description"
2529 },
2530 "stability": "external",
2531 "summary": "A description of the macro."
2532 },
2533 "immutable": true,
2534 "locationInModule": {
2535 "filename": "lib/cloudformation.generated.ts",
2536 "line": 958
2537 },
2538 "name": "description",
2539 "optional": true,
2540 "type": {
2541 "primitive": "string"
2542 }
2543 },
2544 {
2545 "abstract": true,
2546 "docs": {
2547 "custom": {
2548 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname"
2549 },
2550 "stability": "external",
2551 "summary": "The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function."
2552 },
2553 "immutable": true,
2554 "locationInModule": {
2555 "filename": "lib/cloudformation.generated.ts",
2556 "line": 965
2557 },
2558 "name": "logGroupName",
2559 "optional": true,
2560 "type": {
2561 "primitive": "string"
2562 }
2563 },
2564 {
2565 "abstract": true,
2566 "docs": {
2567 "custom": {
2568 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn"
2569 },
2570 "stability": "external",
2571 "summary": "The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs ."
2572 },
2573 "immutable": true,
2574 "locationInModule": {
2575 "filename": "lib/cloudformation.generated.ts",
2576 "line": 972
2577 },
2578 "name": "logRoleArn",
2579 "optional": true,
2580 "type": {
2581 "primitive": "string"
2582 }
2583 }
2584 ],
2585 "symbolId": "lib/cloudformation.generated:CfnMacroProps"
2586 },
2587 "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersion": {
2588 "assembly": "@aws-cdk/aws-cloudformation",
2589 "base": "@aws-cdk/core.CfnResource",
2590 "docs": {
2591 "custom": {
2592 "cloudformationResource": "AWS::CloudFormation::ModuleDefaultVersion",
2593 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html",
2594 "exampleMetadata": "fixture=_generated"
2595 },
2596 "remarks": "Specifies the default version of a module. The default version of the module will be used in CloudFormation operations for this account and Region.\n\nTo register a module version, use the `[AWS::CloudFormation::ModuleVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html)` resource.\n\nFor more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *AWS CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *AWS CloudFormation CLI User Guide* .",
2597 "stability": "external",
2598 "summary": "A CloudFormation `AWS::CloudFormation::ModuleDefaultVersion`.",
2599 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleDefaultVersion = new cloudformation.CfnModuleDefaultVersion(this, 'MyCfnModuleDefaultVersion', /* all optional props */ {\n arn: 'arn',\n moduleName: 'moduleName',\n versionId: 'versionId',\n});"
2600 },
2601 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersion",
2602 "initializer": {
2603 "docs": {
2604 "stability": "external",
2605 "summary": "Create a new `AWS::CloudFormation::ModuleDefaultVersion`."
2606 },
2607 "locationInModule": {
2608 "filename": "lib/cloudformation.generated.ts",
2609 "line": 1311
2610 },
2611 "parameters": [
2612 {
2613 "docs": {
2614 "summary": "- scope in which this resource is defined."
2615 },
2616 "name": "scope",
2617 "type": {
2618 "fqn": "@aws-cdk/core.Construct"
2619 }
2620 },
2621 {
2622 "docs": {
2623 "summary": "- scoped id of the resource."
2624 },
2625 "name": "id",
2626 "type": {
2627 "primitive": "string"
2628 }
2629 },
2630 {
2631 "docs": {
2632 "summary": "- resource properties."
2633 },
2634 "name": "props",
2635 "optional": true,
2636 "type": {
2637 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps"
2638 }
2639 }
2640 ]
2641 },
2642 "interfaces": [
2643 "@aws-cdk/core.IInspectable"
2644 ],
2645 "kind": "class",
2646 "locationInModule": {
2647 "filename": "lib/cloudformation.generated.ts",
2648 "line": 1252
2649 },
2650 "methods": [
2651 {
2652 "docs": {
2653 "stability": "external",
2654 "summary": "Examines the CloudFormation resource and discloses attributes."
2655 },
2656 "locationInModule": {
2657 "filename": "lib/cloudformation.generated.ts",
2658 "line": 1325
2659 },
2660 "name": "inspect",
2661 "overrides": "@aws-cdk/core.IInspectable",
2662 "parameters": [
2663 {
2664 "docs": {
2665 "summary": "- tree inspector to collect and process attributes."
2666 },
2667 "name": "inspector",
2668 "type": {
2669 "fqn": "@aws-cdk/core.TreeInspector"
2670 }
2671 }
2672 ]
2673 },
2674 {
2675 "docs": {
2676 "stability": "external"
2677 },
2678 "locationInModule": {
2679 "filename": "lib/cloudformation.generated.ts",
2680 "line": 1338
2681 },
2682 "name": "renderProperties",
2683 "overrides": "@aws-cdk/core.CfnResource",
2684 "parameters": [
2685 {
2686 "name": "props",
2687 "type": {
2688 "collection": {
2689 "elementtype": {
2690 "primitive": "any"
2691 },
2692 "kind": "map"
2693 }
2694 }
2695 }
2696 ],
2697 "protected": true,
2698 "returns": {
2699 "type": {
2700 "collection": {
2701 "elementtype": {
2702 "primitive": "any"
2703 },
2704 "kind": "map"
2705 }
2706 }
2707 }
2708 }
2709 ],
2710 "name": "CfnModuleDefaultVersion",
2711 "properties": [
2712 {
2713 "const": true,
2714 "docs": {
2715 "stability": "external",
2716 "summary": "The CloudFormation resource type name for this resource class."
2717 },
2718 "immutable": true,
2719 "locationInModule": {
2720 "filename": "lib/cloudformation.generated.ts",
2721 "line": 1256
2722 },
2723 "name": "CFN_RESOURCE_TYPE_NAME",
2724 "static": true,
2725 "type": {
2726 "primitive": "string"
2727 }
2728 },
2729 {
2730 "docs": {
2731 "stability": "external"
2732 },
2733 "immutable": true,
2734 "locationInModule": {
2735 "filename": "lib/cloudformation.generated.ts",
2736 "line": 1330
2737 },
2738 "name": "cfnProperties",
2739 "overrides": "@aws-cdk/core.CfnResource",
2740 "protected": true,
2741 "type": {
2742 "collection": {
2743 "elementtype": {
2744 "primitive": "any"
2745 },
2746 "kind": "map"
2747 }
2748 }
2749 },
2750 {
2751 "docs": {
2752 "custom": {
2753 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn"
2754 },
2755 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2756 "stability": "external",
2757 "summary": "The Amazon Resource Name (ARN) of the module version to set as the default version."
2758 },
2759 "locationInModule": {
2760 "filename": "lib/cloudformation.generated.ts",
2761 "line": 1284
2762 },
2763 "name": "arn",
2764 "optional": true,
2765 "type": {
2766 "primitive": "string"
2767 }
2768 },
2769 {
2770 "docs": {
2771 "custom": {
2772 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename"
2773 },
2774 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2775 "stability": "external",
2776 "summary": "The name of the module."
2777 },
2778 "locationInModule": {
2779 "filename": "lib/cloudformation.generated.ts",
2780 "line": 1293
2781 },
2782 "name": "moduleName",
2783 "optional": true,
2784 "type": {
2785 "primitive": "string"
2786 }
2787 },
2788 {
2789 "docs": {
2790 "custom": {
2791 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid"
2792 },
2793 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2794 "stability": "external",
2795 "summary": "The ID for the specific version of the module."
2796 },
2797 "locationInModule": {
2798 "filename": "lib/cloudformation.generated.ts",
2799 "line": 1302
2800 },
2801 "name": "versionId",
2802 "optional": true,
2803 "type": {
2804 "primitive": "string"
2805 }
2806 }
2807 ],
2808 "symbolId": "lib/cloudformation.generated:CfnModuleDefaultVersion"
2809 },
2810 "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps": {
2811 "assembly": "@aws-cdk/aws-cloudformation",
2812 "datatype": true,
2813 "docs": {
2814 "custom": {
2815 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html",
2816 "exampleMetadata": "fixture=_generated"
2817 },
2818 "stability": "external",
2819 "summary": "Properties for defining a `CfnModuleDefaultVersion`.",
2820 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleDefaultVersionProps: cloudformation.CfnModuleDefaultVersionProps = {\n arn: 'arn',\n moduleName: 'moduleName',\n versionId: 'versionId',\n};"
2821 },
2822 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps",
2823 "kind": "interface",
2824 "locationInModule": {
2825 "filename": "lib/cloudformation.generated.ts",
2826 "line": 1157
2827 },
2828 "name": "CfnModuleDefaultVersionProps",
2829 "properties": [
2830 {
2831 "abstract": true,
2832 "docs": {
2833 "custom": {
2834 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn"
2835 },
2836 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2837 "stability": "external",
2838 "summary": "The Amazon Resource Name (ARN) of the module version to set as the default version."
2839 },
2840 "immutable": true,
2841 "locationInModule": {
2842 "filename": "lib/cloudformation.generated.ts",
2843 "line": 1166
2844 },
2845 "name": "arn",
2846 "optional": true,
2847 "type": {
2848 "primitive": "string"
2849 }
2850 },
2851 {
2852 "abstract": true,
2853 "docs": {
2854 "custom": {
2855 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename"
2856 },
2857 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2858 "stability": "external",
2859 "summary": "The name of the module."
2860 },
2861 "immutable": true,
2862 "locationInModule": {
2863 "filename": "lib/cloudformation.generated.ts",
2864 "line": 1175
2865 },
2866 "name": "moduleName",
2867 "optional": true,
2868 "type": {
2869 "primitive": "string"
2870 }
2871 },
2872 {
2873 "abstract": true,
2874 "docs": {
2875 "custom": {
2876 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid"
2877 },
2878 "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .",
2879 "stability": "external",
2880 "summary": "The ID for the specific version of the module."
2881 },
2882 "immutable": true,
2883 "locationInModule": {
2884 "filename": "lib/cloudformation.generated.ts",
2885 "line": 1184
2886 },
2887 "name": "versionId",
2888 "optional": true,
2889 "type": {
2890 "primitive": "string"
2891 }
2892 }
2893 ],
2894 "symbolId": "lib/cloudformation.generated:CfnModuleDefaultVersionProps"
2895 },
2896 "@aws-cdk/aws-cloudformation.CfnModuleVersion": {
2897 "assembly": "@aws-cdk/aws-cloudformation",
2898 "base": "@aws-cdk/core.CfnResource",
2899 "docs": {
2900 "custom": {
2901 "cloudformationResource": "AWS::CloudFormation::ModuleVersion",
2902 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html",
2903 "exampleMetadata": "fixture=_generated"
2904 },
2905 "remarks": "Registers the specified version of the module with the CloudFormation service. Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.\n\nTo specify a module version as the default version, use the `[AWS::CloudFormation::ModuleDefaultVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html)` resource.\n\nFor more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *CloudFormation CLI User Guide* .",
2906 "stability": "external",
2907 "summary": "A CloudFormation `AWS::CloudFormation::ModuleVersion`.",
2908 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleVersion = new cloudformation.CfnModuleVersion(this, 'MyCfnModuleVersion', {\n moduleName: 'moduleName',\n modulePackage: 'modulePackage',\n});"
2909 },
2910 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersion",
2911 "initializer": {
2912 "docs": {
2913 "stability": "external",
2914 "summary": "Create a new `AWS::CloudFormation::ModuleVersion`."
2915 },
2916 "locationInModule": {
2917 "filename": "lib/cloudformation.generated.ts",
2918 "line": 1535
2919 },
2920 "parameters": [
2921 {
2922 "docs": {
2923 "summary": "- scope in which this resource is defined."
2924 },
2925 "name": "scope",
2926 "type": {
2927 "fqn": "@aws-cdk/core.Construct"
2928 }
2929 },
2930 {
2931 "docs": {
2932 "summary": "- scoped id of the resource."
2933 },
2934 "name": "id",
2935 "type": {
2936 "primitive": "string"
2937 }
2938 },
2939 {
2940 "docs": {
2941 "summary": "- resource properties."
2942 },
2943 "name": "props",
2944 "type": {
2945 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersionProps"
2946 }
2947 }
2948 ]
2949 },
2950 "interfaces": [
2951 "@aws-cdk/core.IInspectable"
2952 ],
2953 "kind": "class",
2954 "locationInModule": {
2955 "filename": "lib/cloudformation.generated.ts",
2956 "line": 1434
2957 },
2958 "methods": [
2959 {
2960 "docs": {
2961 "stability": "external",
2962 "summary": "Examines the CloudFormation resource and discloses attributes."
2963 },
2964 "locationInModule": {
2965 "filename": "lib/cloudformation.generated.ts",
2966 "line": 1558
2967 },
2968 "name": "inspect",
2969 "overrides": "@aws-cdk/core.IInspectable",
2970 "parameters": [
2971 {
2972 "docs": {
2973 "summary": "- tree inspector to collect and process attributes."
2974 },
2975 "name": "inspector",
2976 "type": {
2977 "fqn": "@aws-cdk/core.TreeInspector"
2978 }
2979 }
2980 ]
2981 },
2982 {
2983 "docs": {
2984 "stability": "external"
2985 },
2986 "locationInModule": {
2987 "filename": "lib/cloudformation.generated.ts",
2988 "line": 1570
2989 },
2990 "name": "renderProperties",
2991 "overrides": "@aws-cdk/core.CfnResource",
2992 "parameters": [
2993 {
2994 "name": "props",
2995 "type": {
2996 "collection": {
2997 "elementtype": {
2998 "primitive": "any"
2999 },
3000 "kind": "map"
3001 }
3002 }
3003 }
3004 ],
3005 "protected": true,
3006 "returns": {
3007 "type": {
3008 "collection": {
3009 "elementtype": {
3010 "primitive": "any"
3011 },
3012 "kind": "map"
3013 }
3014 }
3015 }
3016 }
3017 ],
3018 "name": "CfnModuleVersion",
3019 "properties": [
3020 {
3021 "const": true,
3022 "docs": {
3023 "stability": "external",
3024 "summary": "The CloudFormation resource type name for this resource class."
3025 },
3026 "immutable": true,
3027 "locationInModule": {
3028 "filename": "lib/cloudformation.generated.ts",
3029 "line": 1438
3030 },
3031 "name": "CFN_RESOURCE_TYPE_NAME",
3032 "static": true,
3033 "type": {
3034 "primitive": "string"
3035 }
3036 },
3037 {
3038 "docs": {
3039 "custom": {
3040 "cloudformationAttribute": "Arn"
3041 },
3042 "stability": "external",
3043 "summary": "The Amazon Resource Name (ARN) of the module."
3044 },
3045 "immutable": true,
3046 "locationInModule": {
3047 "filename": "lib/cloudformation.generated.ts",
3048 "line": 1463
3049 },
3050 "name": "attrArn",
3051 "type": {
3052 "primitive": "string"
3053 }
3054 },
3055 {
3056 "docs": {
3057 "custom": {
3058 "cloudformationAttribute": "Description"
3059 },
3060 "stability": "external",
3061 "summary": "The description of the module."
3062 },
3063 "immutable": true,
3064 "locationInModule": {
3065 "filename": "lib/cloudformation.generated.ts",
3066 "line": 1469
3067 },
3068 "name": "attrDescription",
3069 "type": {
3070 "primitive": "string"
3071 }
3072 },
3073 {
3074 "docs": {
3075 "custom": {
3076 "cloudformationAttribute": "DocumentationUrl"
3077 },
3078 "stability": "external",
3079 "summary": "The URL of a page providing detailed documentation for this module."
3080 },
3081 "immutable": true,
3082 "locationInModule": {
3083 "filename": "lib/cloudformation.generated.ts",
3084 "line": 1475
3085 },
3086 "name": "attrDocumentationUrl",
3087 "type": {
3088 "primitive": "string"
3089 }
3090 },
3091 {
3092 "docs": {
3093 "custom": {
3094 "cloudformationAttribute": "IsDefaultVersion"
3095 },
3096 "stability": "external",
3097 "summary": "Whether the specified module version is set as the default version."
3098 },
3099 "immutable": true,
3100 "locationInModule": {
3101 "filename": "lib/cloudformation.generated.ts",
3102 "line": 1481
3103 },
3104 "name": "attrIsDefaultVersion",
3105 "type": {
3106 "fqn": "@aws-cdk/core.IResolvable"
3107 }
3108 },
3109 {
3110 "docs": {
3111 "custom": {
3112 "cloudformationAttribute": "Schema"
3113 },
3114 "stability": "external",
3115 "summary": "The schema that defines the module."
3116 },
3117 "immutable": true,
3118 "locationInModule": {
3119 "filename": "lib/cloudformation.generated.ts",
3120 "line": 1487
3121 },
3122 "name": "attrSchema",
3123 "type": {
3124 "primitive": "string"
3125 }
3126 },
3127 {
3128 "docs": {
3129 "custom": {
3130 "cloudformationAttribute": "TimeCreated"
3131 },
3132 "stability": "external",
3133 "summary": "When the specified module version was registered."
3134 },
3135 "immutable": true,
3136 "locationInModule": {
3137 "filename": "lib/cloudformation.generated.ts",
3138 "line": 1493
3139 },
3140 "name": "attrTimeCreated",
3141 "type": {
3142 "primitive": "string"
3143 }
3144 },
3145 {
3146 "docs": {
3147 "custom": {
3148 "cloudformationAttribute": "VersionId"
3149 },
3150 "stability": "external",
3151 "summary": "The ID of this version of the module."
3152 },
3153 "immutable": true,
3154 "locationInModule": {
3155 "filename": "lib/cloudformation.generated.ts",
3156 "line": 1499
3157 },
3158 "name": "attrVersionId",
3159 "type": {
3160 "primitive": "string"
3161 }
3162 },
3163 {
3164 "docs": {
3165 "custom": {
3166 "cloudformationAttribute": "Visibility"
3167 },
3168 "remarks": "Valid values include:\n\n- `PRIVATE` : The module is only visible and usable within the account in which it's registered.\n- `PUBLIC` : The module is publicly visible and usable within any Amazon account.",
3169 "stability": "external",
3170 "summary": "The scope at which the module is visible and usable in CloudFormation operations."
3171 },
3172 "immutable": true,
3173 "locationInModule": {
3174 "filename": "lib/cloudformation.generated.ts",
3175 "line": 1510
3176 },
3177 "name": "attrVisibility",
3178 "type": {
3179 "primitive": "string"
3180 }
3181 },
3182 {
3183 "docs": {
3184 "stability": "external"
3185 },
3186 "immutable": true,
3187 "locationInModule": {
3188 "filename": "lib/cloudformation.generated.ts",
3189 "line": 1563
3190 },
3191 "name": "cfnProperties",
3192 "overrides": "@aws-cdk/core.CfnResource",
3193 "protected": true,
3194 "type": {
3195 "collection": {
3196 "elementtype": {
3197 "primitive": "any"
3198 },
3199 "kind": "map"
3200 }
3201 }
3202 },
3203 {
3204 "docs": {
3205 "custom": {
3206 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename"
3207 },
3208 "stability": "external",
3209 "summary": "The name of the module being registered."
3210 },
3211 "locationInModule": {
3212 "filename": "lib/cloudformation.generated.ts",
3213 "line": 1517
3214 },
3215 "name": "moduleName",
3216 "type": {
3217 "primitive": "string"
3218 }
3219 },
3220 {
3221 "docs": {
3222 "custom": {
3223 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage"
3224 },
3225 "remarks": "> The user registering the module version must be able to access the module package in the S3 bucket. That's, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
3226 "stability": "external",
3227 "summary": "A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register."
3228 },
3229 "locationInModule": {
3230 "filename": "lib/cloudformation.generated.ts",
3231 "line": 1526
3232 },
3233 "name": "modulePackage",
3234 "type": {
3235 "primitive": "string"
3236 }
3237 }
3238 ],
3239 "symbolId": "lib/cloudformation.generated:CfnModuleVersion"
3240 },
3241 "@aws-cdk/aws-cloudformation.CfnModuleVersionProps": {
3242 "assembly": "@aws-cdk/aws-cloudformation",
3243 "datatype": true,
3244 "docs": {
3245 "custom": {
3246 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html",
3247 "exampleMetadata": "fixture=_generated"
3248 },
3249 "stability": "external",
3250 "summary": "Properties for defining a `CfnModuleVersion`.",
3251 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleVersionProps: cloudformation.CfnModuleVersionProps = {\n moduleName: 'moduleName',\n modulePackage: 'modulePackage',\n};"
3252 },
3253 "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersionProps",
3254 "kind": "interface",
3255 "locationInModule": {
3256 "filename": "lib/cloudformation.generated.ts",
3257 "line": 1351
3258 },
3259 "name": "CfnModuleVersionProps",
3260 "properties": [
3261 {
3262 "abstract": true,
3263 "docs": {
3264 "custom": {
3265 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename"
3266 },
3267 "stability": "external",
3268 "summary": "The name of the module being registered."
3269 },
3270 "immutable": true,
3271 "locationInModule": {
3272 "filename": "lib/cloudformation.generated.ts",
3273 "line": 1358
3274 },
3275 "name": "moduleName",
3276 "type": {
3277 "primitive": "string"
3278 }
3279 },
3280 {
3281 "abstract": true,
3282 "docs": {
3283 "custom": {
3284 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage"
3285 },
3286 "remarks": "> The user registering the module version must be able to access the module package in the S3 bucket. That's, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
3287 "stability": "external",
3288 "summary": "A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register."
3289 },
3290 "immutable": true,
3291 "locationInModule": {
3292 "filename": "lib/cloudformation.generated.ts",
3293 "line": 1367
3294 },
3295 "name": "modulePackage",
3296 "type": {
3297 "primitive": "string"
3298 }
3299 }
3300 ],
3301 "symbolId": "lib/cloudformation.generated:CfnModuleVersionProps"
3302 },
3303 "@aws-cdk/aws-cloudformation.CfnPublicTypeVersion": {
3304 "assembly": "@aws-cdk/aws-cloudformation",
3305 "base": "@aws-cdk/core.CfnResource",
3306 "docs": {
3307 "custom": {
3308 "cloudformationResource": "AWS::CloudFormation::PublicTypeVersion",
3309 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html",
3310 "exampleMetadata": "fixture=_generated"
3311 },
3312 "remarks": "Tests and publishes a registered extension as a public, third-party extension.\n\nCloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users.\n\n- For resource types, testing includes passing all contracts tests defined for the type.\n- For modules, testing includes determining if the module's model meets all necessary requirements.\n\nFor more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation CLI User Guide* .\n\nIf you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.\n\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n\nAn extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the *CloudFormation CLI User Guide* .",
3313 "stability": "external",
3314 "summary": "A CloudFormation `AWS::CloudFormation::PublicTypeVersion`.",
3315 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublicTypeVersion = new cloudformation.CfnPublicTypeVersion(this, 'MyCfnPublicTypeVersion', /* all optional props */ {\n arn: 'arn',\n logDeliveryBucket: 'logDeliveryBucket',\n publicVersionNumber: 'publicVersionNumber',\n type: 'type',\n typeName: 'typeName',\n});"
3316 },
3317 "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersion",
3318 "initializer": {
3319 "docs": {
3320 "stability": "external",
3321 "summary": "Create a new `AWS::CloudFormation::PublicTypeVersion`."
3322 },
3323 "locationInModule": {
3324 "filename": "lib/cloudformation.generated.ts",
3325 "line": 1836
3326 },
3327 "parameters": [
3328 {
3329 "docs": {
3330 "summary": "- scope in which this resource is defined."
3331 },
3332 "name": "scope",
3333 "type": {
3334 "fqn": "@aws-cdk/core.Construct"
3335 }
3336 },
3337 {
3338 "docs": {
3339 "summary": "- scoped id of the resource."
3340 },
3341 "name": "id",
3342 "type": {
3343 "primitive": "string"
3344 }
3345 },
3346 {
3347 "docs": {
3348 "summary": "- resource properties."
3349 },
3350 "name": "props",
3351 "optional": true,
3352 "type": {
3353 "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps"
3354 }
3355 }
3356 ]
3357 },
3358 "interfaces": [
3359 "@aws-cdk/core.IInspectable"
3360 ],
3361 "kind": "class",
3362 "locationInModule": {
3363 "filename": "lib/cloudformation.generated.ts",
3364 "line": 1726
3365 },
3366 "methods": [
3367 {
3368 "docs": {
3369 "stability": "external",
3370 "summary": "Examines the CloudFormation resource and discloses attributes."
3371 },
3372 "locationInModule": {
3373 "filename": "lib/cloudformation.generated.ts",
3374 "line": 1855
3375 },
3376 "name": "inspect",
3377 "overrides": "@aws-cdk/core.IInspectable",
3378 "parameters": [
3379 {
3380 "docs": {
3381 "summary": "- tree inspector to collect and process attributes."
3382 },
3383 "name": "inspector",
3384 "type": {
3385 "fqn": "@aws-cdk/core.TreeInspector"
3386 }
3387 }
3388 ]
3389 },
3390 {
3391 "docs": {
3392 "stability": "external"
3393 },
3394 "locationInModule": {
3395 "filename": "lib/cloudformation.generated.ts",
3396 "line": 1870
3397 },
3398 "name": "renderProperties",
3399 "overrides": "@aws-cdk/core.CfnResource",
3400 "parameters": [
3401 {
3402 "name": "props",
3403 "type": {
3404 "collection": {
3405 "elementtype": {
3406 "primitive": "any"
3407 },
3408 "kind": "map"
3409 }
3410 }
3411 }
3412 ],
3413 "protected": true,
3414 "returns": {
3415 "type": {
3416 "collection": {
3417 "elementtype": {
3418 "primitive": "any"
3419 },
3420 "kind": "map"
3421 }
3422 }
3423 }
3424 }
3425 ],
3426 "name": "CfnPublicTypeVersion",
3427 "properties": [
3428 {
3429 "const": true,
3430 "docs": {
3431 "stability": "external",
3432 "summary": "The CloudFormation resource type name for this resource class."
3433 },
3434 "immutable": true,
3435 "locationInModule": {
3436 "filename": "lib/cloudformation.generated.ts",
3437 "line": 1730
3438 },
3439 "name": "CFN_RESOURCE_TYPE_NAME",
3440 "static": true,
3441 "type": {
3442 "primitive": "string"
3443 }
3444 },
3445 {
3446 "docs": {
3447 "custom": {
3448 "cloudformationAttribute": "PublicTypeArn"
3449 },
3450 "stability": "external",
3451 "summary": "The Amazon Resource Number (ARN) assigned to the public extension upon publication."
3452 },
3453 "immutable": true,
3454 "locationInModule": {
3455 "filename": "lib/cloudformation.generated.ts",
3456 "line": 1755
3457 },
3458 "name": "attrPublicTypeArn",
3459 "type": {
3460 "primitive": "string"
3461 }
3462 },
3463 {
3464 "docs": {
3465 "custom": {
3466 "cloudformationAttribute": "PublisherId"
3467 },
3468 "stability": "external",
3469 "summary": "The publisher ID of the extension publisher."
3470 },
3471 "immutable": true,
3472 "locationInModule": {
3473 "filename": "lib/cloudformation.generated.ts",
3474 "line": 1761
3475 },
3476 "name": "attrPublisherId",
3477 "type": {
3478 "primitive": "string"
3479 }
3480 },
3481 {
3482 "docs": {
3483 "custom": {
3484 "cloudformationAttribute": "TypeVersionArn"
3485 },
3486 "stability": "external",
3487 "summary": "The Amazon Resource Number (ARN) assigned to this version of the extension."
3488 },
3489 "immutable": true,
3490 "locationInModule": {
3491 "filename": "lib/cloudformation.generated.ts",
3492 "line": 1767
3493 },
3494 "name": "attrTypeVersionArn",
3495 "type": {
3496 "primitive": "string"
3497 }
3498 },
3499 {
3500 "docs": {
3501 "stability": "external"
3502 },
3503 "immutable": true,
3504 "locationInModule": {
3505 "filename": "lib/cloudformation.generated.ts",
3506 "line": 1860
3507 },
3508 "name": "cfnProperties",
3509 "overrides": "@aws-cdk/core.CfnResource",
3510 "protected": true,
3511 "type": {
3512 "collection": {
3513 "elementtype": {
3514 "primitive": "any"
3515 },
3516 "kind": "map"
3517 }
3518 }
3519 },
3520 {
3521 "docs": {
3522 "custom": {
3523 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn"
3524 },
3525 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3526 "stability": "external",
3527 "summary": "The Amazon Resource Number (ARN) of the extension."
3528 },
3529 "locationInModule": {
3530 "filename": "lib/cloudformation.generated.ts",
3531 "line": 1776
3532 },
3533 "name": "arn",
3534 "optional": true,
3535 "type": {
3536 "primitive": "string"
3537 }
3538 },
3539 {
3540 "docs": {
3541 "custom": {
3542 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket"
3543 },
3544 "remarks": "CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED` .\n\nThe user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:\n\n- GetObject\n- PutObject\n\nFor more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
3545 "stability": "external",
3546 "summary": "The S3 bucket to which CloudFormation delivers the contract test execution logs."
3547 },
3548 "locationInModule": {
3549 "filename": "lib/cloudformation.generated.ts",
3550 "line": 1792
3551 },
3552 "name": "logDeliveryBucket",
3553 "optional": true,
3554 "type": {
3555 "primitive": "string"
3556 }
3557 },
3558 {
3559 "docs": {
3560 "custom": {
3561 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber"
3562 },
3563 "remarks": "Use the following format, and adhere to semantic versioning when assigning a version number to your extension:\n\n`MAJOR.MINOR.PATCH`\n\nFor more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .\n\nIf you don't specify a version number, CloudFormation increments the version number by one minor version release.\n\nYou cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be `1.0.0` .",
3564 "stability": "external",
3565 "summary": "The version number to assign to this version of the extension."
3566 },
3567 "locationInModule": {
3568 "filename": "lib/cloudformation.generated.ts",
3569 "line": 1809
3570 },
3571 "name": "publicVersionNumber",
3572 "optional": true,
3573 "type": {
3574 "primitive": "string"
3575 }
3576 },
3577 {
3578 "docs": {
3579 "custom": {
3580 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type"
3581 },
3582 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3583 "stability": "external",
3584 "summary": "The type of the extension to test."
3585 },
3586 "locationInModule": {
3587 "filename": "lib/cloudformation.generated.ts",
3588 "line": 1818
3589 },
3590 "name": "type",
3591 "optional": true,
3592 "type": {
3593 "primitive": "string"
3594 }
3595 },
3596 {
3597 "docs": {
3598 "custom": {
3599 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename"
3600 },
3601 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3602 "stability": "external",
3603 "summary": "The name of the extension to test."
3604 },
3605 "locationInModule": {
3606 "filename": "lib/cloudformation.generated.ts",
3607 "line": 1827
3608 },
3609 "name": "typeName",
3610 "optional": true,
3611 "type": {
3612 "primitive": "string"
3613 }
3614 }
3615 ],
3616 "symbolId": "lib/cloudformation.generated:CfnPublicTypeVersion"
3617 },
3618 "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps": {
3619 "assembly": "@aws-cdk/aws-cloudformation",
3620 "datatype": true,
3621 "docs": {
3622 "custom": {
3623 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html",
3624 "exampleMetadata": "fixture=_generated"
3625 },
3626 "stability": "external",
3627 "summary": "Properties for defining a `CfnPublicTypeVersion`.",
3628 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublicTypeVersionProps: cloudformation.CfnPublicTypeVersionProps = {\n arn: 'arn',\n logDeliveryBucket: 'logDeliveryBucket',\n publicVersionNumber: 'publicVersionNumber',\n type: 'type',\n typeName: 'typeName',\n};"
3629 },
3630 "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps",
3631 "kind": "interface",
3632 "locationInModule": {
3633 "filename": "lib/cloudformation.generated.ts",
3634 "line": 1583
3635 },
3636 "name": "CfnPublicTypeVersionProps",
3637 "properties": [
3638 {
3639 "abstract": true,
3640 "docs": {
3641 "custom": {
3642 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn"
3643 },
3644 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3645 "stability": "external",
3646 "summary": "The Amazon Resource Number (ARN) of the extension."
3647 },
3648 "immutable": true,
3649 "locationInModule": {
3650 "filename": "lib/cloudformation.generated.ts",
3651 "line": 1592
3652 },
3653 "name": "arn",
3654 "optional": true,
3655 "type": {
3656 "primitive": "string"
3657 }
3658 },
3659 {
3660 "abstract": true,
3661 "docs": {
3662 "custom": {
3663 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket"
3664 },
3665 "remarks": "CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED` .\n\nThe user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:\n\n- GetObject\n- PutObject\n\nFor more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
3666 "stability": "external",
3667 "summary": "The S3 bucket to which CloudFormation delivers the contract test execution logs."
3668 },
3669 "immutable": true,
3670 "locationInModule": {
3671 "filename": "lib/cloudformation.generated.ts",
3672 "line": 1608
3673 },
3674 "name": "logDeliveryBucket",
3675 "optional": true,
3676 "type": {
3677 "primitive": "string"
3678 }
3679 },
3680 {
3681 "abstract": true,
3682 "docs": {
3683 "custom": {
3684 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber"
3685 },
3686 "remarks": "Use the following format, and adhere to semantic versioning when assigning a version number to your extension:\n\n`MAJOR.MINOR.PATCH`\n\nFor more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .\n\nIf you don't specify a version number, CloudFormation increments the version number by one minor version release.\n\nYou cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be `1.0.0` .",
3687 "stability": "external",
3688 "summary": "The version number to assign to this version of the extension."
3689 },
3690 "immutable": true,
3691 "locationInModule": {
3692 "filename": "lib/cloudformation.generated.ts",
3693 "line": 1625
3694 },
3695 "name": "publicVersionNumber",
3696 "optional": true,
3697 "type": {
3698 "primitive": "string"
3699 }
3700 },
3701 {
3702 "abstract": true,
3703 "docs": {
3704 "custom": {
3705 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type"
3706 },
3707 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3708 "stability": "external",
3709 "summary": "The type of the extension to test."
3710 },
3711 "immutable": true,
3712 "locationInModule": {
3713 "filename": "lib/cloudformation.generated.ts",
3714 "line": 1634
3715 },
3716 "name": "type",
3717 "optional": true,
3718 "type": {
3719 "primitive": "string"
3720 }
3721 },
3722 {
3723 "abstract": true,
3724 "docs": {
3725 "custom": {
3726 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename"
3727 },
3728 "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .",
3729 "stability": "external",
3730 "summary": "The name of the extension to test."
3731 },
3732 "immutable": true,
3733 "locationInModule": {
3734 "filename": "lib/cloudformation.generated.ts",
3735 "line": 1643
3736 },
3737 "name": "typeName",
3738 "optional": true,
3739 "type": {
3740 "primitive": "string"
3741 }
3742 }
3743 ],
3744 "symbolId": "lib/cloudformation.generated:CfnPublicTypeVersionProps"
3745 },
3746 "@aws-cdk/aws-cloudformation.CfnPublisher": {
3747 "assembly": "@aws-cdk/aws-cloudformation",
3748 "base": "@aws-cdk/core.CfnResource",
3749 "docs": {
3750 "custom": {
3751 "cloudformationResource": "AWS::CloudFormation::Publisher",
3752 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html",
3753 "exampleMetadata": "fixture=_generated"
3754 },
3755 "remarks": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n\nFor information on requirements for registering as a public extension publisher, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .",
3756 "stability": "external",
3757 "summary": "A CloudFormation `AWS::CloudFormation::Publisher`.",
3758 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublisher = new cloudformation.CfnPublisher(this, 'MyCfnPublisher', {\n acceptTermsAndConditions: false,\n\n // the properties below are optional\n connectionArn: 'connectionArn',\n});"
3759 },
3760 "fqn": "@aws-cdk/aws-cloudformation.CfnPublisher",
3761 "initializer": {
3762 "docs": {
3763 "stability": "external",
3764 "summary": "Create a new `AWS::CloudFormation::Publisher`."
3765 },
3766 "locationInModule": {
3767 "filename": "lib/cloudformation.generated.ts",
3768 "line": 2041
3769 },
3770 "parameters": [
3771 {
3772 "docs": {
3773 "summary": "- scope in which this resource is defined."
3774 },
3775 "name": "scope",
3776 "type": {
3777 "fqn": "@aws-cdk/core.Construct"
3778 }
3779 },
3780 {
3781 "docs": {
3782 "summary": "- scoped id of the resource."
3783 },
3784 "name": "id",
3785 "type": {
3786 "primitive": "string"
3787 }
3788 },
3789 {
3790 "docs": {
3791 "summary": "- resource properties."
3792 },
3793 "name": "props",
3794 "type": {
3795 "fqn": "@aws-cdk/aws-cloudformation.CfnPublisherProps"
3796 }
3797 }
3798 ]
3799 },
3800 "interfaces": [
3801 "@aws-cdk/core.IInspectable"
3802 ],
3803 "kind": "class",
3804 "locationInModule": {
3805 "filename": "lib/cloudformation.generated.ts",
3806 "line": 1965
3807 },
3808 "methods": [
3809 {
3810 "docs": {
3811 "stability": "external",
3812 "summary": "Examines the CloudFormation resource and discloses attributes."
3813 },
3814 "locationInModule": {
3815 "filename": "lib/cloudformation.generated.ts",
3816 "line": 2059
3817 },
3818 "name": "inspect",
3819 "overrides": "@aws-cdk/core.IInspectable",
3820 "parameters": [
3821 {
3822 "docs": {
3823 "summary": "- tree inspector to collect and process attributes."
3824 },
3825 "name": "inspector",
3826 "type": {
3827 "fqn": "@aws-cdk/core.TreeInspector"
3828 }
3829 }
3830 ]
3831 },
3832 {
3833 "docs": {
3834 "stability": "external"
3835 },
3836 "locationInModule": {
3837 "filename": "lib/cloudformation.generated.ts",
3838 "line": 2071
3839 },
3840 "name": "renderProperties",
3841 "overrides": "@aws-cdk/core.CfnResource",
3842 "parameters": [
3843 {
3844 "name": "props",
3845 "type": {
3846 "collection": {
3847 "elementtype": {
3848 "primitive": "any"
3849 },
3850 "kind": "map"
3851 }
3852 }
3853 }
3854 ],
3855 "protected": true,
3856 "returns": {
3857 "type": {
3858 "collection": {
3859 "elementtype": {
3860 "primitive": "any"
3861 },
3862 "kind": "map"
3863 }
3864 }
3865 }
3866 }
3867 ],
3868 "name": "CfnPublisher",
3869 "properties": [
3870 {
3871 "const": true,
3872 "docs": {
3873 "stability": "external",
3874 "summary": "The CloudFormation resource type name for this resource class."
3875 },
3876 "immutable": true,
3877 "locationInModule": {
3878 "filename": "lib/cloudformation.generated.ts",
3879 "line": 1969
3880 },
3881 "name": "CFN_RESOURCE_TYPE_NAME",
3882 "static": true,
3883 "type": {
3884 "primitive": "string"
3885 }
3886 },
3887 {
3888 "docs": {
3889 "custom": {
3890 "cloudformationAttribute": "IdentityProvider"
3891 },
3892 "remarks": "Values include: `AWS_Marketplace` | `Bitbucket` | `GitHub` .",
3893 "stability": "external",
3894 "summary": "The type of account used as the identity provider when registering this publisher with CloudFormation ."
3895 },
3896 "immutable": true,
3897 "locationInModule": {
3898 "filename": "lib/cloudformation.generated.ts",
3899 "line": 1996
3900 },
3901 "name": "attrIdentityProvider",
3902 "type": {
3903 "primitive": "string"
3904 }
3905 },
3906 {
3907 "docs": {
3908 "custom": {
3909 "cloudformationAttribute": "PublisherId"
3910 },
3911 "remarks": "This publisher ID applies to your account in all AWS Regions .",
3912 "stability": "external",
3913 "summary": "The ID of the extension publisher."
3914 },
3915 "immutable": true,
3916 "locationInModule": {
3917 "filename": "lib/cloudformation.generated.ts",
3918 "line": 2002
3919 },
3920 "name": "attrPublisherId",
3921 "type": {
3922 "primitive": "string"
3923 }
3924 },
3925 {
3926 "docs": {
3927 "custom": {
3928 "cloudformationAttribute": "PublisherProfile"
3929 },
3930 "stability": "external",
3931 "summary": "The URL to the publisher's profile with the identity provider."
3932 },
3933 "immutable": true,
3934 "locationInModule": {
3935 "filename": "lib/cloudformation.generated.ts",
3936 "line": 2008
3937 },
3938 "name": "attrPublisherProfile",
3939 "type": {
3940 "primitive": "string"
3941 }
3942 },
3943 {
3944 "docs": {
3945 "custom": {
3946 "cloudformationAttribute": "PublisherStatus"
3947 },
3948 "stability": "external",
3949 "summary": "Whether the publisher is verified."
3950 },
3951 "immutable": true,
3952 "locationInModule": {
3953 "filename": "lib/cloudformation.generated.ts",
3954 "line": 2014
3955 },
3956 "name": "attrPublisherStatus",
3957 "type": {
3958 "primitive": "string"
3959 }
3960 },
3961 {
3962 "docs": {
3963 "stability": "external"
3964 },
3965 "immutable": true,
3966 "locationInModule": {
3967 "filename": "lib/cloudformation.generated.ts",
3968 "line": 2064
3969 },
3970 "name": "cfnProperties",
3971 "overrides": "@aws-cdk/core.CfnResource",
3972 "protected": true,
3973 "type": {
3974 "collection": {
3975 "elementtype": {
3976 "primitive": "any"
3977 },
3978 "kind": "map"
3979 }
3980 }
3981 },
3982 {
3983 "docs": {
3984 "custom": {
3985 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions"
3986 },
3987 "remarks": "The default is `false` .",
3988 "stability": "external",
3989 "summary": "Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry."
3990 },
3991 "locationInModule": {
3992 "filename": "lib/cloudformation.generated.ts",
3993 "line": 2023
3994 },
3995 "name": "acceptTermsAndConditions",
3996 "type": {
3997 "union": {
3998 "types": [
3999 {
4000 "primitive": "boolean"
4001 },
4002 {
4003 "fqn": "@aws-cdk/core.IResolvable"
4004 }
4005 ]
4006 }
4007 }
4008 },
4009 {
4010 "docs": {
4011 "custom": {
4012 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn"
4013 },
4014 "remarks": "For more information, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .",
4015 "stability": "external",
4016 "summary": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account."
4017 },
4018 "locationInModule": {
4019 "filename": "lib/cloudformation.generated.ts",
4020 "line": 2032
4021 },
4022 "name": "connectionArn",
4023 "optional": true,
4024 "type": {
4025 "primitive": "string"
4026 }
4027 }
4028 ],
4029 "symbolId": "lib/cloudformation.generated:CfnPublisher"
4030 },
4031 "@aws-cdk/aws-cloudformation.CfnPublisherProps": {
4032 "assembly": "@aws-cdk/aws-cloudformation",
4033 "datatype": true,
4034 "docs": {
4035 "custom": {
4036 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html",
4037 "exampleMetadata": "fixture=_generated"
4038 },
4039 "stability": "external",
4040 "summary": "Properties for defining a `CfnPublisher`.",
4041 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublisherProps: cloudformation.CfnPublisherProps = {\n acceptTermsAndConditions: false,\n\n // the properties below are optional\n connectionArn: 'connectionArn',\n};"
4042 },
4043 "fqn": "@aws-cdk/aws-cloudformation.CfnPublisherProps",
4044 "kind": "interface",
4045 "locationInModule": {
4046 "filename": "lib/cloudformation.generated.ts",
4047 "line": 1883
4048 },
4049 "name": "CfnPublisherProps",
4050 "properties": [
4051 {
4052 "abstract": true,
4053 "docs": {
4054 "custom": {
4055 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions"
4056 },
4057 "remarks": "The default is `false` .",
4058 "stability": "external",
4059 "summary": "Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry."
4060 },
4061 "immutable": true,
4062 "locationInModule": {
4063 "filename": "lib/cloudformation.generated.ts",
4064 "line": 1892
4065 },
4066 "name": "acceptTermsAndConditions",
4067 "type": {
4068 "union": {
4069 "types": [
4070 {
4071 "primitive": "boolean"
4072 },
4073 {
4074 "fqn": "@aws-cdk/core.IResolvable"
4075 }
4076 ]
4077 }
4078 }
4079 },
4080 {
4081 "abstract": true,
4082 "docs": {
4083 "custom": {
4084 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn"
4085 },
4086 "remarks": "For more information, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .",
4087 "stability": "external",
4088 "summary": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account."
4089 },
4090 "immutable": true,
4091 "locationInModule": {
4092 "filename": "lib/cloudformation.generated.ts",
4093 "line": 1901
4094 },
4095 "name": "connectionArn",
4096 "optional": true,
4097 "type": {
4098 "primitive": "string"
4099 }
4100 }
4101 ],
4102 "symbolId": "lib/cloudformation.generated:CfnPublisherProps"
4103 },
4104 "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersion": {
4105 "assembly": "@aws-cdk/aws-cloudformation",
4106 "base": "@aws-cdk/core.CfnResource",
4107 "docs": {
4108 "custom": {
4109 "cloudformationResource": "AWS::CloudFormation::ResourceDefaultVersion",
4110 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html",
4111 "exampleMetadata": "fixture=_generated"
4112 },
4113 "remarks": "Specifies the default version of a resource. The default version of a resource will be used in CloudFormation operations.",
4114 "stability": "external",
4115 "summary": "A CloudFormation `AWS::CloudFormation::ResourceDefaultVersion`.",
4116 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceDefaultVersion = new cloudformation.CfnResourceDefaultVersion(this, 'MyCfnResourceDefaultVersion', /* all optional props */ {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n});"
4117 },
4118 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersion",
4119 "initializer": {
4120 "docs": {
4121 "stability": "external",
4122 "summary": "Create a new `AWS::CloudFormation::ResourceDefaultVersion`."
4123 },
4124 "locationInModule": {
4125 "filename": "lib/cloudformation.generated.ts",
4126 "line": 2240
4127 },
4128 "parameters": [
4129 {
4130 "docs": {
4131 "summary": "- scope in which this resource is defined."
4132 },
4133 "name": "scope",
4134 "type": {
4135 "fqn": "@aws-cdk/core.Construct"
4136 }
4137 },
4138 {
4139 "docs": {
4140 "summary": "- scoped id of the resource."
4141 },
4142 "name": "id",
4143 "type": {
4144 "primitive": "string"
4145 }
4146 },
4147 {
4148 "docs": {
4149 "summary": "- resource properties."
4150 },
4151 "name": "props",
4152 "optional": true,
4153 "type": {
4154 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps"
4155 }
4156 }
4157 ]
4158 },
4159 "interfaces": [
4160 "@aws-cdk/core.IInspectable"
4161 ],
4162 "kind": "class",
4163 "locationInModule": {
4164 "filename": "lib/cloudformation.generated.ts",
4165 "line": 2175
4166 },
4167 "methods": [
4168 {
4169 "docs": {
4170 "stability": "external",
4171 "summary": "Examines the CloudFormation resource and discloses attributes."
4172 },
4173 "locationInModule": {
4174 "filename": "lib/cloudformation.generated.ts",
4175 "line": 2255
4176 },
4177 "name": "inspect",
4178 "overrides": "@aws-cdk/core.IInspectable",
4179 "parameters": [
4180 {
4181 "docs": {
4182 "summary": "- tree inspector to collect and process attributes."
4183 },
4184 "name": "inspector",
4185 "type": {
4186 "fqn": "@aws-cdk/core.TreeInspector"
4187 }
4188 }
4189 ]
4190 },
4191 {
4192 "docs": {
4193 "stability": "external"
4194 },
4195 "locationInModule": {
4196 "filename": "lib/cloudformation.generated.ts",
4197 "line": 2268
4198 },
4199 "name": "renderProperties",
4200 "overrides": "@aws-cdk/core.CfnResource",
4201 "parameters": [
4202 {
4203 "name": "props",
4204 "type": {
4205 "collection": {
4206 "elementtype": {
4207 "primitive": "any"
4208 },
4209 "kind": "map"
4210 }
4211 }
4212 }
4213 ],
4214 "protected": true,
4215 "returns": {
4216 "type": {
4217 "collection": {
4218 "elementtype": {
4219 "primitive": "any"
4220 },
4221 "kind": "map"
4222 }
4223 }
4224 }
4225 }
4226 ],
4227 "name": "CfnResourceDefaultVersion",
4228 "properties": [
4229 {
4230 "const": true,
4231 "docs": {
4232 "stability": "external",
4233 "summary": "The CloudFormation resource type name for this resource class."
4234 },
4235 "immutable": true,
4236 "locationInModule": {
4237 "filename": "lib/cloudformation.generated.ts",
4238 "line": 2179
4239 },
4240 "name": "CFN_RESOURCE_TYPE_NAME",
4241 "static": true,
4242 "type": {
4243 "primitive": "string"
4244 }
4245 },
4246 {
4247 "docs": {
4248 "custom": {
4249 "cloudformationAttribute": "Arn"
4250 },
4251 "stability": "external",
4252 "summary": "The Amazon Resource Name (ARN) of the resource."
4253 },
4254 "immutable": true,
4255 "locationInModule": {
4256 "filename": "lib/cloudformation.generated.ts",
4257 "line": 2204
4258 },
4259 "name": "attrArn",
4260 "type": {
4261 "primitive": "string"
4262 }
4263 },
4264 {
4265 "docs": {
4266 "stability": "external"
4267 },
4268 "immutable": true,
4269 "locationInModule": {
4270 "filename": "lib/cloudformation.generated.ts",
4271 "line": 2260
4272 },
4273 "name": "cfnProperties",
4274 "overrides": "@aws-cdk/core.CfnResource",
4275 "protected": true,
4276 "type": {
4277 "collection": {
4278 "elementtype": {
4279 "primitive": "any"
4280 },
4281 "kind": "map"
4282 }
4283 }
4284 },
4285 {
4286 "docs": {
4287 "custom": {
4288 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename"
4289 },
4290 "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4291 "stability": "external",
4292 "summary": "The name of the resource."
4293 },
4294 "locationInModule": {
4295 "filename": "lib/cloudformation.generated.ts",
4296 "line": 2213
4297 },
4298 "name": "typeName",
4299 "optional": true,
4300 "type": {
4301 "primitive": "string"
4302 }
4303 },
4304 {
4305 "docs": {
4306 "custom": {
4307 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn"
4308 },
4309 "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4310 "stability": "external",
4311 "summary": "The Amazon Resource Name (ARN) of the resource version."
4312 },
4313 "locationInModule": {
4314 "filename": "lib/cloudformation.generated.ts",
4315 "line": 2222
4316 },
4317 "name": "typeVersionArn",
4318 "optional": true,
4319 "type": {
4320 "primitive": "string"
4321 }
4322 },
4323 {
4324 "docs": {
4325 "custom": {
4326 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid"
4327 },
4328 "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.\n\nConditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4329 "stability": "external",
4330 "summary": "The ID of a specific version of the resource."
4331 },
4332 "locationInModule": {
4333 "filename": "lib/cloudformation.generated.ts",
4334 "line": 2231
4335 },
4336 "name": "versionId",
4337 "optional": true,
4338 "type": {
4339 "primitive": "string"
4340 }
4341 }
4342 ],
4343 "symbolId": "lib/cloudformation.generated:CfnResourceDefaultVersion"
4344 },
4345 "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps": {
4346 "assembly": "@aws-cdk/aws-cloudformation",
4347 "datatype": true,
4348 "docs": {
4349 "custom": {
4350 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html",
4351 "exampleMetadata": "fixture=_generated"
4352 },
4353 "stability": "external",
4354 "summary": "Properties for defining a `CfnResourceDefaultVersion`.",
4355 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceDefaultVersionProps: cloudformation.CfnResourceDefaultVersionProps = {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n};"
4356 },
4357 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps",
4358 "kind": "interface",
4359 "locationInModule": {
4360 "filename": "lib/cloudformation.generated.ts",
4361 "line": 2084
4362 },
4363 "name": "CfnResourceDefaultVersionProps",
4364 "properties": [
4365 {
4366 "abstract": true,
4367 "docs": {
4368 "custom": {
4369 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename"
4370 },
4371 "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4372 "stability": "external",
4373 "summary": "The name of the resource."
4374 },
4375 "immutable": true,
4376 "locationInModule": {
4377 "filename": "lib/cloudformation.generated.ts",
4378 "line": 2093
4379 },
4380 "name": "typeName",
4381 "optional": true,
4382 "type": {
4383 "primitive": "string"
4384 }
4385 },
4386 {
4387 "abstract": true,
4388 "docs": {
4389 "custom": {
4390 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn"
4391 },
4392 "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4393 "stability": "external",
4394 "summary": "The Amazon Resource Name (ARN) of the resource version."
4395 },
4396 "immutable": true,
4397 "locationInModule": {
4398 "filename": "lib/cloudformation.generated.ts",
4399 "line": 2102
4400 },
4401 "name": "typeVersionArn",
4402 "optional": true,
4403 "type": {
4404 "primitive": "string"
4405 }
4406 },
4407 {
4408 "abstract": true,
4409 "docs": {
4410 "custom": {
4411 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid"
4412 },
4413 "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.\n\nConditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .",
4414 "stability": "external",
4415 "summary": "The ID of a specific version of the resource."
4416 },
4417 "immutable": true,
4418 "locationInModule": {
4419 "filename": "lib/cloudformation.generated.ts",
4420 "line": 2111
4421 },
4422 "name": "versionId",
4423 "optional": true,
4424 "type": {
4425 "primitive": "string"
4426 }
4427 }
4428 ],
4429 "symbolId": "lib/cloudformation.generated:CfnResourceDefaultVersionProps"
4430 },
4431 "@aws-cdk/aws-cloudformation.CfnResourceVersion": {
4432 "assembly": "@aws-cdk/aws-cloudformation",
4433 "base": "@aws-cdk/core.CfnResource",
4434 "docs": {
4435 "custom": {
4436 "cloudformationResource": "AWS::CloudFormation::ResourceVersion",
4437 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html",
4438 "exampleMetadata": "fixture=_generated"
4439 },
4440 "remarks": "Registers a resource version with the CloudFormation service. Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:\n\n- Validating the resource schema.\n- Determining which handlers, if any, have been specified for the resource.\n- Making the resource available for use in your account.\n\nFor more information on how to develop resources and ready them for registration, see [Creating Resource Providers](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the *CloudFormation CLI User Guide* .\n\nYou can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.",
4441 "stability": "external",
4442 "summary": "A CloudFormation `AWS::CloudFormation::ResourceVersion`.",
4443 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceVersion = new cloudformation.CfnResourceVersion(this, 'MyCfnResourceVersion', {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n});"
4444 },
4445 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion",
4446 "initializer": {
4447 "docs": {
4448 "stability": "external",
4449 "summary": "Create a new `AWS::CloudFormation::ResourceVersion`."
4450 },
4451 "locationInModule": {
4452 "filename": "lib/cloudformation.generated.ts",
4453 "line": 2527
4454 },
4455 "parameters": [
4456 {
4457 "docs": {
4458 "summary": "- scope in which this resource is defined."
4459 },
4460 "name": "scope",
4461 "type": {
4462 "fqn": "@aws-cdk/core.Construct"
4463 }
4464 },
4465 {
4466 "docs": {
4467 "summary": "- scoped id of the resource."
4468 },
4469 "name": "id",
4470 "type": {
4471 "primitive": "string"
4472 }
4473 },
4474 {
4475 "docs": {
4476 "summary": "- resource properties."
4477 },
4478 "name": "props",
4479 "type": {
4480 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersionProps"
4481 }
4482 }
4483 ]
4484 },
4485 "interfaces": [
4486 "@aws-cdk/core.IInspectable"
4487 ],
4488 "kind": "class",
4489 "locationInModule": {
4490 "filename": "lib/cloudformation.generated.ts",
4491 "line": 2401
4492 },
4493 "methods": [
4494 {
4495 "docs": {
4496 "stability": "external",
4497 "summary": "Examines the CloudFormation resource and discloses attributes."
4498 },
4499 "locationInModule": {
4500 "filename": "lib/cloudformation.generated.ts",
4501 "line": 2550
4502 },
4503 "name": "inspect",
4504 "overrides": "@aws-cdk/core.IInspectable",
4505 "parameters": [
4506 {
4507 "docs": {
4508 "summary": "- tree inspector to collect and process attributes."
4509 },
4510 "name": "inspector",
4511 "type": {
4512 "fqn": "@aws-cdk/core.TreeInspector"
4513 }
4514 }
4515 ]
4516 },
4517 {
4518 "docs": {
4519 "stability": "external"
4520 },
4521 "locationInModule": {
4522 "filename": "lib/cloudformation.generated.ts",
4523 "line": 2564
4524 },
4525 "name": "renderProperties",
4526 "overrides": "@aws-cdk/core.CfnResource",
4527 "parameters": [
4528 {
4529 "name": "props",
4530 "type": {
4531 "collection": {
4532 "elementtype": {
4533 "primitive": "any"
4534 },
4535 "kind": "map"
4536 }
4537 }
4538 }
4539 ],
4540 "protected": true,
4541 "returns": {
4542 "type": {
4543 "collection": {
4544 "elementtype": {
4545 "primitive": "any"
4546 },
4547 "kind": "map"
4548 }
4549 }
4550 }
4551 }
4552 ],
4553 "name": "CfnResourceVersion",
4554 "properties": [
4555 {
4556 "const": true,
4557 "docs": {
4558 "stability": "external",
4559 "summary": "The CloudFormation resource type name for this resource class."
4560 },
4561 "immutable": true,
4562 "locationInModule": {
4563 "filename": "lib/cloudformation.generated.ts",
4564 "line": 2405
4565 },
4566 "name": "CFN_RESOURCE_TYPE_NAME",
4567 "static": true,
4568 "type": {
4569 "primitive": "string"
4570 }
4571 },
4572 {
4573 "docs": {
4574 "custom": {
4575 "cloudformationAttribute": "Arn"
4576 },
4577 "stability": "external",
4578 "summary": "The Amazon Resource Name (ARN) of the resource version."
4579 },
4580 "immutable": true,
4581 "locationInModule": {
4582 "filename": "lib/cloudformation.generated.ts",
4583 "line": 2430
4584 },
4585 "name": "attrArn",
4586 "type": {
4587 "primitive": "string"
4588 }
4589 },
4590 {
4591 "docs": {
4592 "custom": {
4593 "cloudformationAttribute": "IsDefaultVersion"
4594 },
4595 "stability": "external",
4596 "summary": "Whether the resource version is set as the default version."
4597 },
4598 "immutable": true,
4599 "locationInModule": {
4600 "filename": "lib/cloudformation.generated.ts",
4601 "line": 2436
4602 },
4603 "name": "attrIsDefaultVersion",
4604 "type": {
4605 "fqn": "@aws-cdk/core.IResolvable"
4606 }
4607 },
4608 {
4609 "docs": {
4610 "custom": {
4611 "cloudformationAttribute": "ProvisioningType"
4612 },
4613 "remarks": "CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.\n\nValid values include:\n\n- `FULLY_MUTABLE` : The resource type includes an update handler to process updates to the type during stack update operations.\n- `IMMUTABLE` : The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.\n- `NON_PROVISIONABLE` : The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.\n\n- create\n- read\n- delete",
4614 "stability": "external",
4615 "summary": "The provisioning behavior of the resource type."
4616 },
4617 "immutable": true,
4618 "locationInModule": {
4619 "filename": "lib/cloudformation.generated.ts",
4620 "line": 2452
4621 },
4622 "name": "attrProvisioningType",
4623 "type": {
4624 "primitive": "string"
4625 }
4626 },
4627 {
4628 "docs": {
4629 "custom": {
4630 "cloudformationAttribute": "TypeArn"
4631 },
4632 "stability": "external",
4633 "summary": "The Amazon Resource Name (ARN) of the resource."
4634 },
4635 "immutable": true,
4636 "locationInModule": {
4637 "filename": "lib/cloudformation.generated.ts",
4638 "line": 2458
4639 },
4640 "name": "attrTypeArn",
4641 "type": {
4642 "primitive": "string"
4643 }
4644 },
4645 {
4646 "docs": {
4647 "custom": {
4648 "cloudformationAttribute": "VersionId"
4649 },
4650 "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it is registered.",
4651 "stability": "external",
4652 "summary": "The ID of a specific version of the resource."
4653 },
4654 "immutable": true,
4655 "locationInModule": {
4656 "filename": "lib/cloudformation.generated.ts",
4657 "line": 2464
4658 },
4659 "name": "attrVersionId",
4660 "type": {
4661 "primitive": "string"
4662 }
4663 },
4664 {
4665 "docs": {
4666 "custom": {
4667 "cloudformationAttribute": "Visibility"
4668 },
4669 "remarks": "Valid values include:\n\n- `PRIVATE` : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as `PRIVATE` .\n- `PUBLIC` : The resource is publicly visible and usable within any Amazon account.",
4670 "stability": "external",
4671 "summary": "The scope at which the resource is visible and usable in CloudFormation operations."
4672 },
4673 "immutable": true,
4674 "locationInModule": {
4675 "filename": "lib/cloudformation.generated.ts",
4676 "line": 2475
4677 },
4678 "name": "attrVisibility",
4679 "type": {
4680 "primitive": "string"
4681 }
4682 },
4683 {
4684 "docs": {
4685 "stability": "external"
4686 },
4687 "immutable": true,
4688 "locationInModule": {
4689 "filename": "lib/cloudformation.generated.ts",
4690 "line": 2555
4691 },
4692 "name": "cfnProperties",
4693 "overrides": "@aws-cdk/core.CfnResource",
4694 "protected": true,
4695 "type": {
4696 "collection": {
4697 "elementtype": {
4698 "primitive": "any"
4699 },
4700 "kind": "map"
4701 }
4702 }
4703 },
4704 {
4705 "docs": {
4706 "custom": {
4707 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage"
4708 },
4709 "remarks": "For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide* .\n\n> The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
4710 "stability": "external",
4711 "summary": "A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register."
4712 },
4713 "locationInModule": {
4714 "filename": "lib/cloudformation.generated.ts",
4715 "line": 2486
4716 },
4717 "name": "schemaHandlerPackage",
4718 "type": {
4719 "primitive": "string"
4720 }
4721 },
4722 {
4723 "docs": {
4724 "custom": {
4725 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename"
4726 },
4727 "remarks": "We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .\n\n> The following organization namespaces are reserved and can't be used in your resource names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `AWS`\n> - `Custom`\n> - `Dev`",
4728 "stability": "external",
4729 "summary": "The name of the resource being registered."
4730 },
4731 "locationInModule": {
4732 "filename": "lib/cloudformation.generated.ts",
4733 "line": 2504
4734 },
4735 "name": "typeName",
4736 "type": {
4737 "primitive": "string"
4738 }
4739 },
4740 {
4741 "docs": {
4742 "custom": {
4743 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn"
4744 },
4745 "remarks": "If your resource calls AWS APIs in any of its handlers, you must create an *[IAM execution role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)* that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.",
4746 "stability": "external",
4747 "summary": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource."
4748 },
4749 "locationInModule": {
4750 "filename": "lib/cloudformation.generated.ts",
4751 "line": 2511
4752 },
4753 "name": "executionRoleArn",
4754 "optional": true,
4755 "type": {
4756 "primitive": "string"
4757 }
4758 },
4759 {
4760 "docs": {
4761 "custom": {
4762 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig"
4763 },
4764 "stability": "external",
4765 "summary": "Logging configuration information for a resource."
4766 },
4767 "locationInModule": {
4768 "filename": "lib/cloudformation.generated.ts",
4769 "line": 2518
4770 },
4771 "name": "loggingConfig",
4772 "optional": true,
4773 "type": {
4774 "union": {
4775 "types": [
4776 {
4777 "fqn": "@aws-cdk/core.IResolvable"
4778 },
4779 {
4780 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty"
4781 }
4782 ]
4783 }
4784 }
4785 }
4786 ],
4787 "symbolId": "lib/cloudformation.generated:CfnResourceVersion"
4788 },
4789 "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty": {
4790 "assembly": "@aws-cdk/aws-cloudformation",
4791 "datatype": true,
4792 "docs": {
4793 "custom": {
4794 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html",
4795 "exampleMetadata": "fixture=_generated"
4796 },
4797 "stability": "external",
4798 "summary": "Logging configuration information for a resource.",
4799 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnResourceVersion.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};"
4800 },
4801 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty",
4802 "kind": "interface",
4803 "locationInModule": {
4804 "filename": "lib/cloudformation.generated.ts",
4805 "line": 2578
4806 },
4807 "name": "LoggingConfigProperty",
4808 "namespace": "CfnResourceVersion",
4809 "properties": [
4810 {
4811 "abstract": true,
4812 "docs": {
4813 "custom": {
4814 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname"
4815 },
4816 "stability": "external",
4817 "summary": "The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers."
4818 },
4819 "immutable": true,
4820 "locationInModule": {
4821 "filename": "lib/cloudformation.generated.ts",
4822 "line": 2584
4823 },
4824 "name": "logGroupName",
4825 "optional": true,
4826 "type": {
4827 "primitive": "string"
4828 }
4829 },
4830 {
4831 "abstract": true,
4832 "docs": {
4833 "custom": {
4834 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn"
4835 },
4836 "stability": "external",
4837 "summary": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs."
4838 },
4839 "immutable": true,
4840 "locationInModule": {
4841 "filename": "lib/cloudformation.generated.ts",
4842 "line": 2590
4843 },
4844 "name": "logRoleArn",
4845 "optional": true,
4846 "type": {
4847 "primitive": "string"
4848 }
4849 }
4850 ],
4851 "symbolId": "lib/cloudformation.generated:CfnResourceVersion.LoggingConfigProperty"
4852 },
4853 "@aws-cdk/aws-cloudformation.CfnResourceVersionProps": {
4854 "assembly": "@aws-cdk/aws-cloudformation",
4855 "datatype": true,
4856 "docs": {
4857 "custom": {
4858 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html",
4859 "exampleMetadata": "fixture=_generated"
4860 },
4861 "stability": "external",
4862 "summary": "Properties for defining a `CfnResourceVersion`.",
4863 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceVersionProps: cloudformation.CfnResourceVersionProps = {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n};"
4864 },
4865 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersionProps",
4866 "kind": "interface",
4867 "locationInModule": {
4868 "filename": "lib/cloudformation.generated.ts",
4869 "line": 2281
4870 },
4871 "name": "CfnResourceVersionProps",
4872 "properties": [
4873 {
4874 "abstract": true,
4875 "docs": {
4876 "custom": {
4877 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage"
4878 },
4879 "remarks": "For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide* .\n\n> The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .",
4880 "stability": "external",
4881 "summary": "A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register."
4882 },
4883 "immutable": true,
4884 "locationInModule": {
4885 "filename": "lib/cloudformation.generated.ts",
4886 "line": 2292
4887 },
4888 "name": "schemaHandlerPackage",
4889 "type": {
4890 "primitive": "string"
4891 }
4892 },
4893 {
4894 "abstract": true,
4895 "docs": {
4896 "custom": {
4897 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename"
4898 },
4899 "remarks": "We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .\n\n> The following organization namespaces are reserved and can't be used in your resource names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `AWS`\n> - `Custom`\n> - `Dev`",
4900 "stability": "external",
4901 "summary": "The name of the resource being registered."
4902 },
4903 "immutable": true,
4904 "locationInModule": {
4905 "filename": "lib/cloudformation.generated.ts",
4906 "line": 2310
4907 },
4908 "name": "typeName",
4909 "type": {
4910 "primitive": "string"
4911 }
4912 },
4913 {
4914 "abstract": true,
4915 "docs": {
4916 "custom": {
4917 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn"
4918 },
4919 "remarks": "If your resource calls AWS APIs in any of its handlers, you must create an *[IAM execution role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)* that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.",
4920 "stability": "external",
4921 "summary": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource."
4922 },
4923 "immutable": true,
4924 "locationInModule": {
4925 "filename": "lib/cloudformation.generated.ts",
4926 "line": 2317
4927 },
4928 "name": "executionRoleArn",
4929 "optional": true,
4930 "type": {
4931 "primitive": "string"
4932 }
4933 },
4934 {
4935 "abstract": true,
4936 "docs": {
4937 "custom": {
4938 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig"
4939 },
4940 "stability": "external",
4941 "summary": "Logging configuration information for a resource."
4942 },
4943 "immutable": true,
4944 "locationInModule": {
4945 "filename": "lib/cloudformation.generated.ts",
4946 "line": 2324
4947 },
4948 "name": "loggingConfig",
4949 "optional": true,
4950 "type": {
4951 "union": {
4952 "types": [
4953 {
4954 "fqn": "@aws-cdk/core.IResolvable"
4955 },
4956 {
4957 "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty"
4958 }
4959 ]
4960 }
4961 }
4962 }
4963 ],
4964 "symbolId": "lib/cloudformation.generated:CfnResourceVersionProps"
4965 },
4966 "@aws-cdk/aws-cloudformation.CfnStack": {
4967 "assembly": "@aws-cdk/aws-cloudformation",
4968 "base": "@aws-cdk/core.CfnResource",
4969 "docs": {
4970 "custom": {
4971 "cloudformationResource": "AWS::CloudFormation::Stack",
4972 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html",
4973 "exampleMetadata": "fixture=_generated"
4974 },
4975 "remarks": "The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template.\n\nYou can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` .\n\n> We strongly recommend that updates to nested stacks are run from the parent stack.\n\nWhen you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks. For more information, see [CloudFormation stack updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n> You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) .",
4976 "stability": "external",
4977 "summary": "A CloudFormation `AWS::CloudFormation::Stack`.",
4978 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnStack = new cloudformation.CfnStack(this, 'MyCfnStack', {\n templateUrl: 'templateUrl',\n\n // the properties below are optional\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeoutInMinutes: 123,\n});"
4979 },
4980 "fqn": "@aws-cdk/aws-cloudformation.CfnStack",
4981 "initializer": {
4982 "docs": {
4983 "stability": "external",
4984 "summary": "Create a new `AWS::CloudFormation::Stack`."
4985 },
4986 "locationInModule": {
4987 "filename": "lib/cloudformation.generated.ts",
4988 "line": 2854
4989 },
4990 "parameters": [
4991 {
4992 "docs": {
4993 "summary": "- scope in which this resource is defined."
4994 },
4995 "name": "scope",
4996 "type": {
4997 "fqn": "@aws-cdk/core.Construct"
4998 }
4999 },
5000 {
5001 "docs": {
5002 "summary": "- scoped id of the resource."
5003 },
5004 "name": "id",
5005 "type": {
5006 "primitive": "string"
5007 }
5008 },
5009 {
5010 "docs": {
5011 "summary": "- resource properties."
5012 },
5013 "name": "props",
5014 "type": {
5015 "fqn": "@aws-cdk/aws-cloudformation.CfnStackProps"
5016 }
5017 }
5018 ]
5019 },
5020 "interfaces": [
5021 "@aws-cdk/core.IInspectable"
5022 ],
5023 "kind": "class",
5024 "locationInModule": {
5025 "filename": "lib/cloudformation.generated.ts",
5026 "line": 2777
5027 },
5028 "methods": [
5029 {
5030 "docs": {
5031 "stability": "external",
5032 "summary": "Examines the CloudFormation resource and discloses attributes."
5033 },
5034 "locationInModule": {
5035 "filename": "lib/cloudformation.generated.ts",
5036 "line": 2876
5037 },
5038 "name": "inspect",
5039 "overrides": "@aws-cdk/core.IInspectable",
5040 "parameters": [
5041 {
5042 "docs": {
5043 "summary": "- tree inspector to collect and process attributes."
5044 },
5045 "name": "inspector",
5046 "type": {
5047 "fqn": "@aws-cdk/core.TreeInspector"
5048 }
5049 }
5050 ]
5051 },
5052 {
5053 "docs": {
5054 "stability": "external"
5055 },
5056 "locationInModule": {
5057 "filename": "lib/cloudformation.generated.ts",
5058 "line": 2891
5059 },
5060 "name": "renderProperties",
5061 "overrides": "@aws-cdk/core.CfnResource",
5062 "parameters": [
5063 {
5064 "name": "props",
5065 "type": {
5066 "collection": {
5067 "elementtype": {
5068 "primitive": "any"
5069 },
5070 "kind": "map"
5071 }
5072 }
5073 }
5074 ],
5075 "protected": true,
5076 "returns": {
5077 "type": {
5078 "collection": {
5079 "elementtype": {
5080 "primitive": "any"
5081 },
5082 "kind": "map"
5083 }
5084 }
5085 }
5086 }
5087 ],
5088 "name": "CfnStack",
5089 "properties": [
5090 {
5091 "const": true,
5092 "docs": {
5093 "stability": "external",
5094 "summary": "The CloudFormation resource type name for this resource class."
5095 },
5096 "immutable": true,
5097 "locationInModule": {
5098 "filename": "lib/cloudformation.generated.ts",
5099 "line": 2781
5100 },
5101 "name": "CFN_RESOURCE_TYPE_NAME",
5102 "static": true,
5103 "type": {
5104 "primitive": "string"
5105 }
5106 },
5107 {
5108 "docs": {
5109 "stability": "external"
5110 },
5111 "immutable": true,
5112 "locationInModule": {
5113 "filename": "lib/cloudformation.generated.ts",
5114 "line": 2881
5115 },
5116 "name": "cfnProperties",
5117 "overrides": "@aws-cdk/core.CfnResource",
5118 "protected": true,
5119 "type": {
5120 "collection": {
5121 "elementtype": {
5122 "primitive": "any"
5123 },
5124 "kind": "map"
5125 }
5126 }
5127 },
5128 {
5129 "docs": {
5130 "custom": {
5131 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags"
5132 },
5133 "remarks": "AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.",
5134 "stability": "external",
5135 "summary": "Key-value pairs to associate with this stack."
5136 },
5137 "immutable": true,
5138 "locationInModule": {
5139 "filename": "lib/cloudformation.generated.ts",
5140 "line": 2836
5141 },
5142 "name": "tags",
5143 "type": {
5144 "fqn": "@aws-cdk/core.TagManager"
5145 }
5146 },
5147 {
5148 "docs": {
5149 "custom": {
5150 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl"
5151 },
5152 "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.",
5153 "stability": "external",
5154 "summary": "Location of file containing the template body."
5155 },
5156 "locationInModule": {
5157 "filename": "lib/cloudformation.generated.ts",
5158 "line": 2809
5159 },
5160 "name": "templateUrl",
5161 "type": {
5162 "primitive": "string"
5163 }
5164 },
5165 {
5166 "docs": {
5167 "custom": {
5168 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns"
5169 },
5170 "remarks": "You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).",
5171 "stability": "external",
5172 "summary": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events."
5173 },
5174 "locationInModule": {
5175 "filename": "lib/cloudformation.generated.ts",
5176 "line": 2816
5177 },
5178 "name": "notificationArns",
5179 "optional": true,
5180 "type": {
5181 "collection": {
5182 "elementtype": {
5183 "primitive": "string"
5184 },
5185 "kind": "array"
5186 }
5187 }
5188 },
5189 {
5190 "docs": {
5191 "custom": {
5192 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters"
5193 },
5194 "remarks": "Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.\n\n> If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.\n\nConditional. Required if the nested stack requires input parameters.\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.",
5195 "stability": "external",
5196 "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created."
5197 },
5198 "locationInModule": {
5199 "filename": "lib/cloudformation.generated.ts",
5200 "line": 2829
5201 },
5202 "name": "parameters",
5203 "optional": true,
5204 "type": {
5205 "union": {
5206 "types": [
5207 {
5208 "fqn": "@aws-cdk/core.IResolvable"
5209 },
5210 {
5211 "collection": {
5212 "elementtype": {
5213 "primitive": "string"
5214 },
5215 "kind": "map"
5216 }
5217 }
5218 ]
5219 }
5220 }
5221 },
5222 {
5223 "docs": {
5224 "custom": {
5225 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes"
5226 },
5227 "remarks": "The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.\n\nUpdates aren't supported.",
5228 "stability": "external",
5229 "summary": "The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state."
5230 },
5231 "locationInModule": {
5232 "filename": "lib/cloudformation.generated.ts",
5233 "line": 2845
5234 },
5235 "name": "timeoutInMinutes",
5236 "optional": true,
5237 "type": {
5238 "primitive": "number"
5239 }
5240 }
5241 ],
5242 "symbolId": "lib/cloudformation.generated:CfnStack"
5243 },
5244 "@aws-cdk/aws-cloudformation.CfnStackProps": {
5245 "assembly": "@aws-cdk/aws-cloudformation",
5246 "datatype": true,
5247 "docs": {
5248 "custom": {
5249 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html",
5250 "exampleMetadata": "fixture=_generated"
5251 },
5252 "stability": "external",
5253 "summary": "Properties for defining a `CfnStack`.",
5254 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnStackProps: cloudformation.CfnStackProps = {\n templateUrl: 'templateUrl',\n\n // the properties below are optional\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeoutInMinutes: 123,\n};"
5255 },
5256 "fqn": "@aws-cdk/aws-cloudformation.CfnStackProps",
5257 "kind": "interface",
5258 "locationInModule": {
5259 "filename": "lib/cloudformation.generated.ts",
5260 "line": 2653
5261 },
5262 "name": "CfnStackProps",
5263 "properties": [
5264 {
5265 "abstract": true,
5266 "docs": {
5267 "custom": {
5268 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl"
5269 },
5270 "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.",
5271 "stability": "external",
5272 "summary": "Location of file containing the template body."
5273 },
5274 "immutable": true,
5275 "locationInModule": {
5276 "filename": "lib/cloudformation.generated.ts",
5277 "line": 2662
5278 },
5279 "name": "templateUrl",
5280 "type": {
5281 "primitive": "string"
5282 }
5283 },
5284 {
5285 "abstract": true,
5286 "docs": {
5287 "custom": {
5288 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns"
5289 },
5290 "remarks": "You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).",
5291 "stability": "external",
5292 "summary": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events."
5293 },
5294 "immutable": true,
5295 "locationInModule": {
5296 "filename": "lib/cloudformation.generated.ts",
5297 "line": 2669
5298 },
5299 "name": "notificationArns",
5300 "optional": true,
5301 "type": {
5302 "collection": {
5303 "elementtype": {
5304 "primitive": "string"
5305 },
5306 "kind": "array"
5307 }
5308 }
5309 },
5310 {
5311 "abstract": true,
5312 "docs": {
5313 "custom": {
5314 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters"
5315 },
5316 "remarks": "Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.\n\n> If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.\n\nConditional. Required if the nested stack requires input parameters.\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.",
5317 "stability": "external",
5318 "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created."
5319 },
5320 "immutable": true,
5321 "locationInModule": {
5322 "filename": "lib/cloudformation.generated.ts",
5323 "line": 2682
5324 },
5325 "name": "parameters",
5326 "optional": true,
5327 "type": {
5328 "union": {
5329 "types": [
5330 {
5331 "fqn": "@aws-cdk/core.IResolvable"
5332 },
5333 {
5334 "collection": {
5335 "elementtype": {
5336 "primitive": "string"
5337 },
5338 "kind": "map"
5339 }
5340 }
5341 ]
5342 }
5343 }
5344 },
5345 {
5346 "abstract": true,
5347 "docs": {
5348 "custom": {
5349 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags"
5350 },
5351 "remarks": "AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.",
5352 "stability": "external",
5353 "summary": "Key-value pairs to associate with this stack."
5354 },
5355 "immutable": true,
5356 "locationInModule": {
5357 "filename": "lib/cloudformation.generated.ts",
5358 "line": 2689
5359 },
5360 "name": "tags",
5361 "optional": true,
5362 "type": {
5363 "collection": {
5364 "elementtype": {
5365 "fqn": "@aws-cdk/core.CfnTag"
5366 },
5367 "kind": "array"
5368 }
5369 }
5370 },
5371 {
5372 "abstract": true,
5373 "docs": {
5374 "custom": {
5375 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes"
5376 },
5377 "remarks": "The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.\n\nUpdates aren't supported.",
5378 "stability": "external",
5379 "summary": "The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state."
5380 },
5381 "immutable": true,
5382 "locationInModule": {
5383 "filename": "lib/cloudformation.generated.ts",
5384 "line": 2698
5385 },
5386 "name": "timeoutInMinutes",
5387 "optional": true,
5388 "type": {
5389 "primitive": "number"
5390 }
5391 }
5392 ],
5393 "symbolId": "lib/cloudformation.generated:CfnStackProps"
5394 },
5395 "@aws-cdk/aws-cloudformation.CfnStackSet": {
5396 "assembly": "@aws-cdk/aws-cloudformation",
5397 "base": "@aws-cdk/core.CfnResource",
5398 "docs": {
5399 "custom": {
5400 "cloudformationResource": "AWS::CloudFormation::StackSet",
5401 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html",
5402 "exampleMetadata": "fixture=_generated"
5403 },
5404 "remarks": "The `AWS::CloudFormation::StackSet` enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.",
5405 "stability": "external",
5406 "summary": "A CloudFormation `AWS::CloudFormation::StackSet`.",
5407 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\n\ndeclare const managedExecution: any;\nconst cfnStackSet = new cloudformation.CfnStackSet(this, 'MyCfnStackSet', {\n permissionModel: 'permissionModel',\n stackSetName: 'stackSetName',\n\n // the properties below are optional\n administrationRoleArn: 'administrationRoleArn',\n autoDeployment: {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n },\n callAs: 'callAs',\n capabilities: ['capabilities'],\n description: 'description',\n executionRoleName: 'executionRoleName',\n managedExecution: managedExecution,\n operationPreferences: {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n },\n parameters: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n stackInstancesGroup: [{\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n templateBody: 'templateBody',\n templateUrl: 'templateUrl',\n});"
5408 },
5409 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet",
5410 "initializer": {
5411 "docs": {
5412 "stability": "external",
5413 "summary": "Create a new `AWS::CloudFormation::StackSet`."
5414 },
5415 "locationInModule": {
5416 "filename": "lib/cloudformation.generated.ts",
5417 "line": 3366
5418 },
5419 "parameters": [
5420 {
5421 "docs": {
5422 "summary": "- scope in which this resource is defined."
5423 },
5424 "name": "scope",
5425 "type": {
5426 "fqn": "@aws-cdk/core.Construct"
5427 }
5428 },
5429 {
5430 "docs": {
5431 "summary": "- scoped id of the resource."
5432 },
5433 "name": "id",
5434 "type": {
5435 "primitive": "string"
5436 }
5437 },
5438 {
5439 "docs": {
5440 "summary": "- resource properties."
5441 },
5442 "name": "props",
5443 "type": {
5444 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSetProps"
5445 }
5446 }
5447 ]
5448 },
5449 "interfaces": [
5450 "@aws-cdk/core.IInspectable"
5451 ],
5452 "kind": "class",
5453 "locationInModule": {
5454 "filename": "lib/cloudformation.generated.ts",
5455 "line": 3167
5456 },
5457 "methods": [
5458 {
5459 "docs": {
5460 "stability": "external",
5461 "summary": "Examines the CloudFormation resource and discloses attributes."
5462 },
5463 "locationInModule": {
5464 "filename": "lib/cloudformation.generated.ts",
5465 "line": 3395
5466 },
5467 "name": "inspect",
5468 "overrides": "@aws-cdk/core.IInspectable",
5469 "parameters": [
5470 {
5471 "docs": {
5472 "summary": "- tree inspector to collect and process attributes."
5473 },
5474 "name": "inspector",
5475 "type": {
5476 "fqn": "@aws-cdk/core.TreeInspector"
5477 }
5478 }
5479 ]
5480 },
5481 {
5482 "docs": {
5483 "stability": "external"
5484 },
5485 "locationInModule": {
5486 "filename": "lib/cloudformation.generated.ts",
5487 "line": 3420
5488 },
5489 "name": "renderProperties",
5490 "overrides": "@aws-cdk/core.CfnResource",
5491 "parameters": [
5492 {
5493 "name": "props",
5494 "type": {
5495 "collection": {
5496 "elementtype": {
5497 "primitive": "any"
5498 },
5499 "kind": "map"
5500 }
5501 }
5502 }
5503 ],
5504 "protected": true,
5505 "returns": {
5506 "type": {
5507 "collection": {
5508 "elementtype": {
5509 "primitive": "any"
5510 },
5511 "kind": "map"
5512 }
5513 }
5514 }
5515 }
5516 ],
5517 "name": "CfnStackSet",
5518 "properties": [
5519 {
5520 "const": true,
5521 "docs": {
5522 "stability": "external",
5523 "summary": "The CloudFormation resource type name for this resource class."
5524 },
5525 "immutable": true,
5526 "locationInModule": {
5527 "filename": "lib/cloudformation.generated.ts",
5528 "line": 3171
5529 },
5530 "name": "CFN_RESOURCE_TYPE_NAME",
5531 "static": true,
5532 "type": {
5533 "primitive": "string"
5534 }
5535 },
5536 {
5537 "docs": {
5538 "custom": {
5539 "cloudformationAttribute": "StackSetId"
5540 },
5541 "stability": "external",
5542 "summary": "The ID of the stack that you're creating."
5543 },
5544 "immutable": true,
5545 "locationInModule": {
5546 "filename": "lib/cloudformation.generated.ts",
5547 "line": 3196
5548 },
5549 "name": "attrStackSetId",
5550 "type": {
5551 "primitive": "string"
5552 }
5553 },
5554 {
5555 "docs": {
5556 "stability": "external"
5557 },
5558 "immutable": true,
5559 "locationInModule": {
5560 "filename": "lib/cloudformation.generated.ts",
5561 "line": 3400
5562 },
5563 "name": "cfnProperties",
5564 "overrides": "@aws-cdk/core.CfnResource",
5565 "protected": true,
5566 "type": {
5567 "collection": {
5568 "elementtype": {
5569 "primitive": "any"
5570 },
5571 "kind": "map"
5572 }
5573 }
5574 },
5575 {
5576 "docs": {
5577 "custom": {
5578 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags"
5579 },
5580 "remarks": "AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.",
5581 "stability": "external",
5582 "summary": "The key-value pairs to associate with this stack set and the stacks created from it."
5583 },
5584 "immutable": true,
5585 "locationInModule": {
5586 "filename": "lib/cloudformation.generated.ts",
5587 "line": 3331
5588 },
5589 "name": "tags",
5590 "type": {
5591 "fqn": "@aws-cdk/core.TagManager"
5592 }
5593 },
5594 {
5595 "docs": {
5596 "custom": {
5597 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution"
5598 },
5599 "remarks": "When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen inactive (default), StackSets performs one operation at a time in request order.",
5600 "stability": "external",
5601 "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations."
5602 },
5603 "locationInModule": {
5604 "filename": "lib/cloudformation.generated.ts",
5605 "line": 3303
5606 },
5607 "name": "managedExecution",
5608 "type": {
5609 "primitive": "any"
5610 }
5611 },
5612 {
5613 "docs": {
5614 "custom": {
5615 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel"
5616 },
5617 "remarks": "- With `SELF_MANAGED` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant Self-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) .\n- With `SERVICE_MANAGED` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see [Grant Service-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) .",
5618 "stability": "external",
5619 "summary": "Describes how the IAM roles required for stack set operations are created."
5620 },
5621 "locationInModule": {
5622 "filename": "lib/cloudformation.generated.ts",
5623 "line": 3206
5624 },
5625 "name": "permissionModel",
5626 "type": {
5627 "primitive": "string"
5628 }
5629 },
5630 {
5631 "docs": {
5632 "custom": {
5633 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname"
5634 },
5635 "remarks": "The name must be unique in the Region where you create your stack set.\n\n*Maximum* : `128`\n\n*Pattern* : `^[a-zA-Z][a-zA-Z0-9-]{0,127}$`\n\n> The `StackSetName` property is required.",
5636 "stability": "external",
5637 "summary": "The name to associate with the stack set."
5638 },
5639 "locationInModule": {
5640 "filename": "lib/cloudformation.generated.ts",
5641 "line": 3219
5642 },
5643 "name": "stackSetName",
5644 "type": {
5645 "primitive": "string"
5646 }
5647 },
5648 {
5649 "docs": {
5650 "custom": {
5651 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn"
5652 },
5653 "remarks": "Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.\n\nUse customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see [Prerequisites: Granting Permissions for Stack Set Operations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the *AWS CloudFormation User Guide* .\n\n*Minimum* : `20`\n\n*Maximum* : `2048`",
5654 "stability": "external",
5655 "summary": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set."
5656 },
5657 "locationInModule": {
5658 "filename": "lib/cloudformation.generated.ts",
5659 "line": 3232
5660 },
5661 "name": "administrationRoleArn",
5662 "optional": true,
5663 "type": {
5664 "primitive": "string"
5665 }
5666 },
5667 {
5668 "docs": {
5669 "custom": {
5670 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment"
5671 },
5672 "stability": "external",
5673 "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU)."
5674 },
5675 "locationInModule": {
5676 "filename": "lib/cloudformation.generated.ts",
5677 "line": 3239
5678 },
5679 "name": "autoDeployment",
5680 "optional": true,
5681 "type": {
5682 "union": {
5683 "types": [
5684 {
5685 "fqn": "@aws-cdk/core.IResolvable"
5686 },
5687 {
5688 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty"
5689 }
5690 ]
5691 }
5692 }
5693 },
5694 {
5695 "docs": {
5696 "custom": {
5697 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas"
5698 },
5699 "remarks": "By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions.\n\n- To create a stack set with service-managed permissions while signed in to the management account, specify `SELF` .\n- To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .\n\nYour AWS account must be registered as a delegated admin in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *AWS CloudFormation User Guide* .\n\nStack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.\n\n*Valid Values* : `SELF` | `DELEGATED_ADMIN`",
5700 "stability": "external",
5701 "summary": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account."
5702 },
5703 "locationInModule": {
5704 "filename": "lib/cloudformation.generated.ts",
5705 "line": 3257
5706 },
5707 "name": "callAs",
5708 "optional": true,
5709 "type": {
5710 "primitive": "string"
5711 }
5712 },
5713 {
5714 "docs": {
5715 "custom": {
5716 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities"
5717 },
5718 "remarks": "Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .",
5719 "stability": "external",
5720 "summary": "The capabilities that are allowed in the stack set."
5721 },
5722 "locationInModule": {
5723 "filename": "lib/cloudformation.generated.ts",
5724 "line": 3264
5725 },
5726 "name": "capabilities",
5727 "optional": true,
5728 "type": {
5729 "collection": {
5730 "elementtype": {
5731 "primitive": "string"
5732 },
5733 "kind": "array"
5734 }
5735 }
5736 },
5737 {
5738 "docs": {
5739 "custom": {
5740 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description"
5741 },
5742 "remarks": "*Minimum* : `1`\n\n*Maximum* : `1024`",
5743 "stability": "external",
5744 "summary": "A description of the stack set."
5745 },
5746 "locationInModule": {
5747 "filename": "lib/cloudformation.generated.ts",
5748 "line": 3275
5749 },
5750 "name": "description",
5751 "optional": true,
5752 "type": {
5753 "primitive": "string"
5754 }
5755 },
5756 {
5757 "docs": {
5758 "custom": {
5759 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename"
5760 },
5761 "remarks": "If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation.\n\n*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `[a-zA-Z_0-9+=,.@-]+`",
5762 "stability": "external",
5763 "summary": "The name of the IAM execution role to use to create the stack set."
5764 },
5765 "locationInModule": {
5766 "filename": "lib/cloudformation.generated.ts",
5767 "line": 3288
5768 },
5769 "name": "executionRoleName",
5770 "optional": true,
5771 "type": {
5772 "primitive": "string"
5773 }
5774 },
5775 {
5776 "docs": {
5777 "custom": {
5778 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences"
5779 },
5780 "stability": "external",
5781 "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation."
5782 },
5783 "locationInModule": {
5784 "filename": "lib/cloudformation.generated.ts",
5785 "line": 3310
5786 },
5787 "name": "operationPreferences",
5788 "optional": true,
5789 "type": {
5790 "union": {
5791 "types": [
5792 {
5793 "fqn": "@aws-cdk/core.IResolvable"
5794 },
5795 {
5796 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty"
5797 }
5798 ]
5799 }
5800 }
5801 },
5802 {
5803 "docs": {
5804 "custom": {
5805 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters"
5806 },
5807 "stability": "external",
5808 "summary": "The input parameters for the stack set template."
5809 },
5810 "locationInModule": {
5811 "filename": "lib/cloudformation.generated.ts",
5812 "line": 3317
5813 },
5814 "name": "parameters",
5815 "optional": true,
5816 "type": {
5817 "union": {
5818 "types": [
5819 {
5820 "fqn": "@aws-cdk/core.IResolvable"
5821 },
5822 {
5823 "collection": {
5824 "elementtype": {
5825 "union": {
5826 "types": [
5827 {
5828 "fqn": "@aws-cdk/core.IResolvable"
5829 },
5830 {
5831 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty"
5832 }
5833 ]
5834 }
5835 },
5836 "kind": "array"
5837 }
5838 }
5839 ]
5840 }
5841 }
5842 },
5843 {
5844 "docs": {
5845 "custom": {
5846 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup"
5847 },
5848 "stability": "external",
5849 "summary": "A group of stack instances with parameters in some specific accounts and Regions."
5850 },
5851 "locationInModule": {
5852 "filename": "lib/cloudformation.generated.ts",
5853 "line": 3324
5854 },
5855 "name": "stackInstancesGroup",
5856 "optional": true,
5857 "type": {
5858 "union": {
5859 "types": [
5860 {
5861 "fqn": "@aws-cdk/core.IResolvable"
5862 },
5863 {
5864 "collection": {
5865 "elementtype": {
5866 "union": {
5867 "types": [
5868 {
5869 "fqn": "@aws-cdk/core.IResolvable"
5870 },
5871 {
5872 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty"
5873 }
5874 ]
5875 }
5876 },
5877 "kind": "array"
5878 }
5879 }
5880 ]
5881 }
5882 }
5883 },
5884 {
5885 "docs": {
5886 "custom": {
5887 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody"
5888 },
5889 "remarks": "You must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both. Dynamic references in the `TemplateBody` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through `TemplateUrl` instead.\n\n*Minimum* : `1`\n\n*Maximum* : `51200`",
5890 "stability": "external",
5891 "summary": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes."
5892 },
5893 "locationInModule": {
5894 "filename": "lib/cloudformation.generated.ts",
5895 "line": 3344
5896 },
5897 "name": "templateBody",
5898 "optional": true,
5899 "type": {
5900 "primitive": "string"
5901 }
5902 },
5903 {
5904 "docs": {
5905 "custom": {
5906 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl"
5907 },
5908 "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.\n\nYou must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both.\n\n*Minimum* : `1`\n\n*Maximum* : `1024`",
5909 "stability": "external",
5910 "summary": "Location of file containing the template body."
5911 },
5912 "locationInModule": {
5913 "filename": "lib/cloudformation.generated.ts",
5914 "line": 3357
5915 },
5916 "name": "templateUrl",
5917 "optional": true,
5918 "type": {
5919 "primitive": "string"
5920 }
5921 }
5922 ],
5923 "symbolId": "lib/cloudformation.generated:CfnStackSet"
5924 },
5925 "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty": {
5926 "assembly": "@aws-cdk/aws-cloudformation",
5927 "datatype": true,
5928 "docs": {
5929 "custom": {
5930 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html",
5931 "exampleMetadata": "fixture=_generated"
5932 },
5933 "stability": "external",
5934 "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).",
5935 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst autoDeploymentProperty: cloudformation.CfnStackSet.AutoDeploymentProperty = {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n};"
5936 },
5937 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty",
5938 "kind": "interface",
5939 "locationInModule": {
5940 "filename": "lib/cloudformation.generated.ts",
5941 "line": 3434
5942 },
5943 "name": "AutoDeploymentProperty",
5944 "namespace": "CfnStackSet",
5945 "properties": [
5946 {
5947 "abstract": true,
5948 "docs": {
5949 "custom": {
5950 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled"
5951 },
5952 "remarks": "If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.",
5953 "stability": "external",
5954 "summary": "If set to `true` , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions."
5955 },
5956 "immutable": true,
5957 "locationInModule": {
5958 "filename": "lib/cloudformation.generated.ts",
5959 "line": 3440
5960 },
5961 "name": "enabled",
5962 "optional": true,
5963 "type": {
5964 "union": {
5965 "types": [
5966 {
5967 "primitive": "boolean"
5968 },
5969 {
5970 "fqn": "@aws-cdk/core.IResolvable"
5971 }
5972 ]
5973 }
5974 }
5975 },
5976 {
5977 "abstract": true,
5978 "docs": {
5979 "custom": {
5980 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval"
5981 },
5982 "remarks": "If set to `false` , stack resources are deleted. Specify only if `Enabled` is set to `True` .",
5983 "stability": "external",
5984 "summary": "If set to `true` , stack resources are retained when an account is removed from a target organization or OU."
5985 },
5986 "immutable": true,
5987 "locationInModule": {
5988 "filename": "lib/cloudformation.generated.ts",
5989 "line": 3446
5990 },
5991 "name": "retainStacksOnAccountRemoval",
5992 "optional": true,
5993 "type": {
5994 "union": {
5995 "types": [
5996 {
5997 "primitive": "boolean"
5998 },
5999 {
6000 "fqn": "@aws-cdk/core.IResolvable"
6001 }
6002 ]
6003 }
6004 }
6005 }
6006 ],
6007 "symbolId": "lib/cloudformation.generated:CfnStackSet.AutoDeploymentProperty"
6008 },
6009 "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty": {
6010 "assembly": "@aws-cdk/aws-cloudformation",
6011 "datatype": true,
6012 "docs": {
6013 "custom": {
6014 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html",
6015 "exampleMetadata": "fixture=_generated"
6016 },
6017 "stability": "external",
6018 "summary": "The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.",
6019 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst deploymentTargetsProperty: cloudformation.CfnStackSet.DeploymentTargetsProperty = {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n};"
6020 },
6021 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty",
6022 "kind": "interface",
6023 "locationInModule": {
6024 "filename": "lib/cloudformation.generated.ts",
6025 "line": 3510
6026 },
6027 "name": "DeploymentTargetsProperty",
6028 "namespace": "CfnStackSet",
6029 "properties": [
6030 {
6031 "abstract": true,
6032 "docs": {
6033 "custom": {
6034 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype"
6035 },
6036 "remarks": "The following is a list of possible values for the `AccountFilterType` operation.\n\n- `INTERSECTION` : StackSets deploys to the accounts specified in `Accounts` parameter.\n- `DIFFERENCE` : StackSets excludes the accounts specified in `Accounts` parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.\n- `UNION` : StackSets includes additional accounts deployment targets.\n\nThis is the default value if `AccountFilterType` is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.\n- `NONE` : Deploys to all the accounts in specified organizational units (OU).",
6037 "stability": "external",
6038 "summary": "Limit deployment targets to individual accounts or include additional accounts with provided OUs."
6039 },
6040 "immutable": true,
6041 "locationInModule": {
6042 "filename": "lib/cloudformation.generated.ts",
6043 "line": 3525
6044 },
6045 "name": "accountFilterType",
6046 "optional": true,
6047 "type": {
6048 "primitive": "string"
6049 }
6050 },
6051 {
6052 "abstract": true,
6053 "docs": {
6054 "custom": {
6055 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts"
6056 },
6057 "remarks": "*Pattern* : `^[0-9]{12}$`",
6058 "stability": "external",
6059 "summary": "The names of one or more AWS accounts for which you want to deploy stack set updates."
6060 },
6061 "immutable": true,
6062 "locationInModule": {
6063 "filename": "lib/cloudformation.generated.ts",
6064 "line": 3533
6065 },
6066 "name": "accounts",
6067 "optional": true,
6068 "type": {
6069 "collection": {
6070 "elementtype": {
6071 "primitive": "string"
6072 },
6073 "kind": "array"
6074 }
6075 }
6076 },
6077 {
6078 "abstract": true,
6079 "docs": {
6080 "custom": {
6081 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids"
6082 },
6083 "remarks": "*Pattern* : `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`",
6084 "stability": "external",
6085 "summary": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys."
6086 },
6087 "immutable": true,
6088 "locationInModule": {
6089 "filename": "lib/cloudformation.generated.ts",
6090 "line": 3541
6091 },
6092 "name": "organizationalUnitIds",
6093 "optional": true,
6094 "type": {
6095 "collection": {
6096 "elementtype": {
6097 "primitive": "string"
6098 },
6099 "kind": "array"
6100 }
6101 }
6102 }
6103 ],
6104 "symbolId": "lib/cloudformation.generated:CfnStackSet.DeploymentTargetsProperty"
6105 },
6106 "@aws-cdk/aws-cloudformation.CfnStackSet.ManagedExecutionProperty": {
6107 "assembly": "@aws-cdk/aws-cloudformation",
6108 "datatype": true,
6109 "docs": {
6110 "custom": {
6111 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html",
6112 "exampleMetadata": "fixture=_generated"
6113 },
6114 "stability": "external",
6115 "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.",
6116 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst managedExecutionProperty: cloudformation.CfnStackSet.ManagedExecutionProperty = {\n active: false,\n};"
6117 },
6118 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ManagedExecutionProperty",
6119 "kind": "interface",
6120 "locationInModule": {
6121 "filename": "lib/cloudformation.generated.ts",
6122 "line": 3608
6123 },
6124 "name": "ManagedExecutionProperty",
6125 "namespace": "CfnStackSet",
6126 "properties": [
6127 {
6128 "abstract": true,
6129 "docs": {
6130 "custom": {
6131 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html#cfn-cloudformation-stackset-managedexecution-active"
6132 },
6133 "remarks": "After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen `false` (default), StackSets performs one operation at a time in request order.",
6134 "stability": "external",
6135 "summary": "When `true` , StackSets performs non-conflicting operations concurrently and queues conflicting operations."
6136 },
6137 "immutable": true,
6138 "locationInModule": {
6139 "filename": "lib/cloudformation.generated.ts",
6140 "line": 3620
6141 },
6142 "name": "active",
6143 "optional": true,
6144 "type": {
6145 "union": {
6146 "types": [
6147 {
6148 "primitive": "boolean"
6149 },
6150 {
6151 "fqn": "@aws-cdk/core.IResolvable"
6152 }
6153 ]
6154 }
6155 }
6156 }
6157 ],
6158 "symbolId": "lib/cloudformation.generated:CfnStackSet.ManagedExecutionProperty"
6159 },
6160 "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty": {
6161 "assembly": "@aws-cdk/aws-cloudformation",
6162 "datatype": true,
6163 "docs": {
6164 "custom": {
6165 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html",
6166 "exampleMetadata": "fixture=_generated"
6167 },
6168 "remarks": "For more information on maximum concurrent accounts and failure tolerance, see [Stack set operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) .",
6169 "stability": "external",
6170 "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation.",
6171 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst operationPreferencesProperty: cloudformation.CfnStackSet.OperationPreferencesProperty = {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n};"
6172 },
6173 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty",
6174 "kind": "interface",
6175 "locationInModule": {
6176 "filename": "lib/cloudformation.generated.ts",
6177 "line": 3681
6178 },
6179 "name": "OperationPreferencesProperty",
6180 "namespace": "CfnStackSet",
6181 "properties": [
6182 {
6183 "abstract": true,
6184 "docs": {
6185 "custom": {
6186 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount"
6187 },
6188 "remarks": "If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` (but not both).",
6189 "stability": "external",
6190 "summary": "The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region."
6191 },
6192 "immutable": true,
6193 "locationInModule": {
6194 "filename": "lib/cloudformation.generated.ts",
6195 "line": 3689
6196 },
6197 "name": "failureToleranceCount",
6198 "optional": true,
6199 "type": {
6200 "primitive": "number"
6201 }
6202 },
6203 {
6204 "abstract": true,
6205 "docs": {
6206 "custom": {
6207 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage"
6208 },
6209 "remarks": "If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds *down* to the next whole number.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.",
6210 "stability": "external",
6211 "summary": "The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region."
6212 },
6213 "immutable": true,
6214 "locationInModule": {
6215 "filename": "lib/cloudformation.generated.ts",
6216 "line": 3699
6217 },
6218 "name": "failureTolerancePercentage",
6219 "optional": true,
6220 "type": {
6221 "primitive": "number"
6222 }
6223 },
6224 {
6225 "abstract": true,
6226 "docs": {
6227 "custom": {
6228 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount"
6229 },
6230 "remarks": "This is dependent on the value of `FailureToleranceCount` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` .\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.",
6231 "stability": "external",
6232 "summary": "The maximum number of accounts in which to perform this operation at one time."
6233 },
6234 "immutable": true,
6235 "locationInModule": {
6236 "filename": "lib/cloudformation.generated.ts",
6237 "line": 3709
6238 },
6239 "name": "maxConcurrentCount",
6240 "optional": true,
6241 "type": {
6242 "primitive": "number"
6243 }
6244 },
6245 {
6246 "abstract": true,
6247 "docs": {
6248 "custom": {
6249 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage"
6250 },
6251 "remarks": "When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.",
6252 "stability": "external",
6253 "summary": "The maximum percentage of accounts in which to perform this operation at one time."
6254 },
6255 "immutable": true,
6256 "locationInModule": {
6257 "filename": "lib/cloudformation.generated.ts",
6258 "line": 3721
6259 },
6260 "name": "maxConcurrentPercentage",
6261 "optional": true,
6262 "type": {
6263 "primitive": "number"
6264 }
6265 },
6266 {
6267 "abstract": true,
6268 "docs": {
6269 "custom": {
6270 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype"
6271 },
6272 "stability": "external",
6273 "summary": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time."
6274 },
6275 "immutable": true,
6276 "locationInModule": {
6277 "filename": "lib/cloudformation.generated.ts",
6278 "line": 3727
6279 },
6280 "name": "regionConcurrencyType",
6281 "optional": true,
6282 "type": {
6283 "primitive": "string"
6284 }
6285 },
6286 {
6287 "abstract": true,
6288 "docs": {
6289 "custom": {
6290 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder"
6291 },
6292 "stability": "external",
6293 "summary": "The order of the Regions where you want to perform the stack operation."
6294 },
6295 "immutable": true,
6296 "locationInModule": {
6297 "filename": "lib/cloudformation.generated.ts",
6298 "line": 3733
6299 },
6300 "name": "regionOrder",
6301 "optional": true,
6302 "type": {
6303 "collection": {
6304 "elementtype": {
6305 "primitive": "string"
6306 },
6307 "kind": "array"
6308 }
6309 }
6310 }
6311 ],
6312 "symbolId": "lib/cloudformation.generated:CfnStackSet.OperationPreferencesProperty"
6313 },
6314 "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty": {
6315 "assembly": "@aws-cdk/aws-cloudformation",
6316 "datatype": true,
6317 "docs": {
6318 "custom": {
6319 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html",
6320 "exampleMetadata": "fixture=_generated"
6321 },
6322 "stability": "external",
6323 "summary": "The Parameter data type.",
6324 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst parameterProperty: cloudformation.CfnStackSet.ParameterProperty = {\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n};"
6325 },
6326 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty",
6327 "kind": "interface",
6328 "locationInModule": {
6329 "filename": "lib/cloudformation.generated.ts",
6330 "line": 3809
6331 },
6332 "name": "ParameterProperty",
6333 "namespace": "CfnStackSet",
6334 "properties": [
6335 {
6336 "abstract": true,
6337 "docs": {
6338 "custom": {
6339 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parameterkey"
6340 },
6341 "remarks": "If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that's specified in your template.",
6342 "stability": "external",
6343 "summary": "The key associated with the parameter."
6344 },
6345 "immutable": true,
6346 "locationInModule": {
6347 "filename": "lib/cloudformation.generated.ts",
6348 "line": 3815
6349 },
6350 "name": "parameterKey",
6351 "type": {
6352 "primitive": "string"
6353 }
6354 },
6355 {
6356 "abstract": true,
6357 "docs": {
6358 "custom": {
6359 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parametervalue"
6360 },
6361 "stability": "external",
6362 "summary": "The input value associated with the parameter."
6363 },
6364 "immutable": true,
6365 "locationInModule": {
6366 "filename": "lib/cloudformation.generated.ts",
6367 "line": 3821
6368 },
6369 "name": "parameterValue",
6370 "type": {
6371 "primitive": "string"
6372 }
6373 }
6374 ],
6375 "symbolId": "lib/cloudformation.generated:CfnStackSet.ParameterProperty"
6376 },
6377 "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty": {
6378 "assembly": "@aws-cdk/aws-cloudformation",
6379 "datatype": true,
6380 "docs": {
6381 "custom": {
6382 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html",
6383 "exampleMetadata": "fixture=_generated"
6384 },
6385 "stability": "external",
6386 "summary": "Stack instances in some specific accounts and Regions.",
6387 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst stackInstancesProperty: cloudformation.CfnStackSet.StackInstancesProperty = {\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n};"
6388 },
6389 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty",
6390 "kind": "interface",
6391 "locationInModule": {
6392 "filename": "lib/cloudformation.generated.ts",
6393 "line": 3887
6394 },
6395 "name": "StackInstancesProperty",
6396 "namespace": "CfnStackSet",
6397 "properties": [
6398 {
6399 "abstract": true,
6400 "docs": {
6401 "custom": {
6402 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-deploymenttargets"
6403 },
6404 "stability": "external",
6405 "summary": "The AWS `OrganizationalUnitIds` or `Accounts` for which to create stack instances in the specified Regions."
6406 },
6407 "immutable": true,
6408 "locationInModule": {
6409 "filename": "lib/cloudformation.generated.ts",
6410 "line": 3893
6411 },
6412 "name": "deploymentTargets",
6413 "type": {
6414 "union": {
6415 "types": [
6416 {
6417 "fqn": "@aws-cdk/core.IResolvable"
6418 },
6419 {
6420 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty"
6421 }
6422 ]
6423 }
6424 }
6425 },
6426 {
6427 "abstract": true,
6428 "docs": {
6429 "custom": {
6430 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-regions"
6431 },
6432 "stability": "external",
6433 "summary": "The names of one or more Regions where you want to create stack instances using the specified AWS accounts ."
6434 },
6435 "immutable": true,
6436 "locationInModule": {
6437 "filename": "lib/cloudformation.generated.ts",
6438 "line": 3905
6439 },
6440 "name": "regions",
6441 "type": {
6442 "collection": {
6443 "elementtype": {
6444 "primitive": "string"
6445 },
6446 "kind": "array"
6447 }
6448 }
6449 },
6450 {
6451 "abstract": true,
6452 "docs": {
6453 "custom": {
6454 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-parameteroverrides"
6455 },
6456 "stability": "external",
6457 "summary": "A list of stack set parameters whose values you want to override in the selected stack instances."
6458 },
6459 "immutable": true,
6460 "locationInModule": {
6461 "filename": "lib/cloudformation.generated.ts",
6462 "line": 3899
6463 },
6464 "name": "parameterOverrides",
6465 "optional": true,
6466 "type": {
6467 "union": {
6468 "types": [
6469 {
6470 "fqn": "@aws-cdk/core.IResolvable"
6471 },
6472 {
6473 "collection": {
6474 "elementtype": {
6475 "union": {
6476 "types": [
6477 {
6478 "fqn": "@aws-cdk/core.IResolvable"
6479 },
6480 {
6481 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty"
6482 }
6483 ]
6484 }
6485 },
6486 "kind": "array"
6487 }
6488 }
6489 ]
6490 }
6491 }
6492 }
6493 ],
6494 "symbolId": "lib/cloudformation.generated:CfnStackSet.StackInstancesProperty"
6495 },
6496 "@aws-cdk/aws-cloudformation.CfnStackSetProps": {
6497 "assembly": "@aws-cdk/aws-cloudformation",
6498 "datatype": true,
6499 "docs": {
6500 "custom": {
6501 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html",
6502 "exampleMetadata": "fixture=_generated"
6503 },
6504 "stability": "external",
6505 "summary": "Properties for defining a `CfnStackSet`.",
6506 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\n\ndeclare const managedExecution: any;\nconst cfnStackSetProps: cloudformation.CfnStackSetProps = {\n permissionModel: 'permissionModel',\n stackSetName: 'stackSetName',\n\n // the properties below are optional\n administrationRoleArn: 'administrationRoleArn',\n autoDeployment: {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n },\n callAs: 'callAs',\n capabilities: ['capabilities'],\n description: 'description',\n executionRoleName: 'executionRoleName',\n managedExecution: managedExecution,\n operationPreferences: {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n },\n parameters: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n stackInstancesGroup: [{\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n templateBody: 'templateBody',\n templateUrl: 'templateUrl',\n};"
6507 },
6508 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSetProps",
6509 "kind": "interface",
6510 "locationInModule": {
6511 "filename": "lib/cloudformation.generated.ts",
6512 "line": 2904
6513 },
6514 "name": "CfnStackSetProps",
6515 "properties": [
6516 {
6517 "abstract": true,
6518 "docs": {
6519 "custom": {
6520 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel"
6521 },
6522 "remarks": "- With `SELF_MANAGED` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant Self-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) .\n- With `SERVICE_MANAGED` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see [Grant Service-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) .",
6523 "stability": "external",
6524 "summary": "Describes how the IAM roles required for stack set operations are created."
6525 },
6526 "immutable": true,
6527 "locationInModule": {
6528 "filename": "lib/cloudformation.generated.ts",
6529 "line": 2914
6530 },
6531 "name": "permissionModel",
6532 "type": {
6533 "primitive": "string"
6534 }
6535 },
6536 {
6537 "abstract": true,
6538 "docs": {
6539 "custom": {
6540 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname"
6541 },
6542 "remarks": "The name must be unique in the Region where you create your stack set.\n\n*Maximum* : `128`\n\n*Pattern* : `^[a-zA-Z][a-zA-Z0-9-]{0,127}$`\n\n> The `StackSetName` property is required.",
6543 "stability": "external",
6544 "summary": "The name to associate with the stack set."
6545 },
6546 "immutable": true,
6547 "locationInModule": {
6548 "filename": "lib/cloudformation.generated.ts",
6549 "line": 2927
6550 },
6551 "name": "stackSetName",
6552 "type": {
6553 "primitive": "string"
6554 }
6555 },
6556 {
6557 "abstract": true,
6558 "docs": {
6559 "custom": {
6560 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn"
6561 },
6562 "remarks": "Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.\n\nUse customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see [Prerequisites: Granting Permissions for Stack Set Operations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the *AWS CloudFormation User Guide* .\n\n*Minimum* : `20`\n\n*Maximum* : `2048`",
6563 "stability": "external",
6564 "summary": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set."
6565 },
6566 "immutable": true,
6567 "locationInModule": {
6568 "filename": "lib/cloudformation.generated.ts",
6569 "line": 2940
6570 },
6571 "name": "administrationRoleArn",
6572 "optional": true,
6573 "type": {
6574 "primitive": "string"
6575 }
6576 },
6577 {
6578 "abstract": true,
6579 "docs": {
6580 "custom": {
6581 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment"
6582 },
6583 "stability": "external",
6584 "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU)."
6585 },
6586 "immutable": true,
6587 "locationInModule": {
6588 "filename": "lib/cloudformation.generated.ts",
6589 "line": 2947
6590 },
6591 "name": "autoDeployment",
6592 "optional": true,
6593 "type": {
6594 "union": {
6595 "types": [
6596 {
6597 "fqn": "@aws-cdk/core.IResolvable"
6598 },
6599 {
6600 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty"
6601 }
6602 ]
6603 }
6604 }
6605 },
6606 {
6607 "abstract": true,
6608 "docs": {
6609 "custom": {
6610 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas"
6611 },
6612 "remarks": "By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions.\n\n- To create a stack set with service-managed permissions while signed in to the management account, specify `SELF` .\n- To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .\n\nYour AWS account must be registered as a delegated admin in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *AWS CloudFormation User Guide* .\n\nStack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.\n\n*Valid Values* : `SELF` | `DELEGATED_ADMIN`",
6613 "stability": "external",
6614 "summary": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account."
6615 },
6616 "immutable": true,
6617 "locationInModule": {
6618 "filename": "lib/cloudformation.generated.ts",
6619 "line": 2965
6620 },
6621 "name": "callAs",
6622 "optional": true,
6623 "type": {
6624 "primitive": "string"
6625 }
6626 },
6627 {
6628 "abstract": true,
6629 "docs": {
6630 "custom": {
6631 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities"
6632 },
6633 "remarks": "Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .",
6634 "stability": "external",
6635 "summary": "The capabilities that are allowed in the stack set."
6636 },
6637 "immutable": true,
6638 "locationInModule": {
6639 "filename": "lib/cloudformation.generated.ts",
6640 "line": 2972
6641 },
6642 "name": "capabilities",
6643 "optional": true,
6644 "type": {
6645 "collection": {
6646 "elementtype": {
6647 "primitive": "string"
6648 },
6649 "kind": "array"
6650 }
6651 }
6652 },
6653 {
6654 "abstract": true,
6655 "docs": {
6656 "custom": {
6657 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description"
6658 },
6659 "remarks": "*Minimum* : `1`\n\n*Maximum* : `1024`",
6660 "stability": "external",
6661 "summary": "A description of the stack set."
6662 },
6663 "immutable": true,
6664 "locationInModule": {
6665 "filename": "lib/cloudformation.generated.ts",
6666 "line": 2983
6667 },
6668 "name": "description",
6669 "optional": true,
6670 "type": {
6671 "primitive": "string"
6672 }
6673 },
6674 {
6675 "abstract": true,
6676 "docs": {
6677 "custom": {
6678 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename"
6679 },
6680 "remarks": "If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation.\n\n*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `[a-zA-Z_0-9+=,.@-]+`",
6681 "stability": "external",
6682 "summary": "The name of the IAM execution role to use to create the stack set."
6683 },
6684 "immutable": true,
6685 "locationInModule": {
6686 "filename": "lib/cloudformation.generated.ts",
6687 "line": 2996
6688 },
6689 "name": "executionRoleName",
6690 "optional": true,
6691 "type": {
6692 "primitive": "string"
6693 }
6694 },
6695 {
6696 "abstract": true,
6697 "docs": {
6698 "custom": {
6699 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution"
6700 },
6701 "remarks": "When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen inactive (default), StackSets performs one operation at a time in request order.",
6702 "stability": "external",
6703 "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations."
6704 },
6705 "immutable": true,
6706 "locationInModule": {
6707 "filename": "lib/cloudformation.generated.ts",
6708 "line": 3011
6709 },
6710 "name": "managedExecution",
6711 "optional": true,
6712 "type": {
6713 "primitive": "any"
6714 }
6715 },
6716 {
6717 "abstract": true,
6718 "docs": {
6719 "custom": {
6720 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences"
6721 },
6722 "stability": "external",
6723 "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation."
6724 },
6725 "immutable": true,
6726 "locationInModule": {
6727 "filename": "lib/cloudformation.generated.ts",
6728 "line": 3018
6729 },
6730 "name": "operationPreferences",
6731 "optional": true,
6732 "type": {
6733 "union": {
6734 "types": [
6735 {
6736 "fqn": "@aws-cdk/core.IResolvable"
6737 },
6738 {
6739 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty"
6740 }
6741 ]
6742 }
6743 }
6744 },
6745 {
6746 "abstract": true,
6747 "docs": {
6748 "custom": {
6749 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters"
6750 },
6751 "stability": "external",
6752 "summary": "The input parameters for the stack set template."
6753 },
6754 "immutable": true,
6755 "locationInModule": {
6756 "filename": "lib/cloudformation.generated.ts",
6757 "line": 3025
6758 },
6759 "name": "parameters",
6760 "optional": true,
6761 "type": {
6762 "union": {
6763 "types": [
6764 {
6765 "fqn": "@aws-cdk/core.IResolvable"
6766 },
6767 {
6768 "collection": {
6769 "elementtype": {
6770 "union": {
6771 "types": [
6772 {
6773 "fqn": "@aws-cdk/core.IResolvable"
6774 },
6775 {
6776 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty"
6777 }
6778 ]
6779 }
6780 },
6781 "kind": "array"
6782 }
6783 }
6784 ]
6785 }
6786 }
6787 },
6788 {
6789 "abstract": true,
6790 "docs": {
6791 "custom": {
6792 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup"
6793 },
6794 "stability": "external",
6795 "summary": "A group of stack instances with parameters in some specific accounts and Regions."
6796 },
6797 "immutable": true,
6798 "locationInModule": {
6799 "filename": "lib/cloudformation.generated.ts",
6800 "line": 3032
6801 },
6802 "name": "stackInstancesGroup",
6803 "optional": true,
6804 "type": {
6805 "union": {
6806 "types": [
6807 {
6808 "fqn": "@aws-cdk/core.IResolvable"
6809 },
6810 {
6811 "collection": {
6812 "elementtype": {
6813 "union": {
6814 "types": [
6815 {
6816 "fqn": "@aws-cdk/core.IResolvable"
6817 },
6818 {
6819 "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty"
6820 }
6821 ]
6822 }
6823 },
6824 "kind": "array"
6825 }
6826 }
6827 ]
6828 }
6829 }
6830 },
6831 {
6832 "abstract": true,
6833 "docs": {
6834 "custom": {
6835 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags"
6836 },
6837 "remarks": "AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.",
6838 "stability": "external",
6839 "summary": "The key-value pairs to associate with this stack set and the stacks created from it."
6840 },
6841 "immutable": true,
6842 "locationInModule": {
6843 "filename": "lib/cloudformation.generated.ts",
6844 "line": 3039
6845 },
6846 "name": "tags",
6847 "optional": true,
6848 "type": {
6849 "collection": {
6850 "elementtype": {
6851 "fqn": "@aws-cdk/core.CfnTag"
6852 },
6853 "kind": "array"
6854 }
6855 }
6856 },
6857 {
6858 "abstract": true,
6859 "docs": {
6860 "custom": {
6861 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody"
6862 },
6863 "remarks": "You must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both. Dynamic references in the `TemplateBody` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through `TemplateUrl` instead.\n\n*Minimum* : `1`\n\n*Maximum* : `51200`",
6864 "stability": "external",
6865 "summary": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes."
6866 },
6867 "immutable": true,
6868 "locationInModule": {
6869 "filename": "lib/cloudformation.generated.ts",
6870 "line": 3052
6871 },
6872 "name": "templateBody",
6873 "optional": true,
6874 "type": {
6875 "primitive": "string"
6876 }
6877 },
6878 {
6879 "abstract": true,
6880 "docs": {
6881 "custom": {
6882 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl"
6883 },
6884 "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.\n\nYou must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both.\n\n*Minimum* : `1`\n\n*Maximum* : `1024`",
6885 "stability": "external",
6886 "summary": "Location of file containing the template body."
6887 },
6888 "immutable": true,
6889 "locationInModule": {
6890 "filename": "lib/cloudformation.generated.ts",
6891 "line": 3065
6892 },
6893 "name": "templateUrl",
6894 "optional": true,
6895 "type": {
6896 "primitive": "string"
6897 }
6898 }
6899 ],
6900 "symbolId": "lib/cloudformation.generated:CfnStackSetProps"
6901 },
6902 "@aws-cdk/aws-cloudformation.CfnTypeActivation": {
6903 "assembly": "@aws-cdk/aws-cloudformation",
6904 "base": "@aws-cdk/core.CfnResource",
6905 "docs": {
6906 "custom": {
6907 "cloudformationResource": "AWS::CloudFormation::TypeActivation",
6908 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html",
6909 "exampleMetadata": "fixture=_generated"
6910 },
6911 "remarks": "Activates a public third-party extension, making it available for use in stack templates. For more information, see [Using public extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) in the *AWS CloudFormation User Guide* .\n\nOnce you have activated a public third-party extension in your account and Region, use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see [Configuring extensions at the account level](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the *CloudFormation User Guide* .",
6912 "stability": "external",
6913 "summary": "A CloudFormation `AWS::CloudFormation::TypeActivation`.",
6914 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnTypeActivation = new cloudformation.CfnTypeActivation(this, 'MyCfnTypeActivation', /* all optional props */ {\n autoUpdate: false,\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n majorVersion: 'majorVersion',\n publicTypeArn: 'publicTypeArn',\n publisherId: 'publisherId',\n type: 'type',\n typeName: 'typeName',\n typeNameAlias: 'typeNameAlias',\n versionBump: 'versionBump',\n});"
6915 },
6916 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation",
6917 "initializer": {
6918 "docs": {
6919 "stability": "external",
6920 "summary": "Create a new `AWS::CloudFormation::TypeActivation`."
6921 },
6922 "locationInModule": {
6923 "filename": "lib/cloudformation.generated.ts",
6924 "line": 4272
6925 },
6926 "parameters": [
6927 {
6928 "docs": {
6929 "summary": "- scope in which this resource is defined."
6930 },
6931 "name": "scope",
6932 "type": {
6933 "fqn": "@aws-cdk/core.Construct"
6934 }
6935 },
6936 {
6937 "docs": {
6938 "summary": "- scoped id of the resource."
6939 },
6940 "name": "id",
6941 "type": {
6942 "primitive": "string"
6943 }
6944 },
6945 {
6946 "docs": {
6947 "summary": "- resource properties."
6948 },
6949 "name": "props",
6950 "optional": true,
6951 "type": {
6952 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivationProps"
6953 }
6954 }
6955 ]
6956 },
6957 "interfaces": [
6958 "@aws-cdk/core.IInspectable"
6959 ],
6960 "kind": "class",
6961 "locationInModule": {
6962 "filename": "lib/cloudformation.generated.ts",
6963 "line": 4147
6964 },
6965 "methods": [
6966 {
6967 "docs": {
6968 "stability": "external",
6969 "summary": "Examines the CloudFormation resource and discloses attributes."
6970 },
6971 "locationInModule": {
6972 "filename": "lib/cloudformation.generated.ts",
6973 "line": 4294
6974 },
6975 "name": "inspect",
6976 "overrides": "@aws-cdk/core.IInspectable",
6977 "parameters": [
6978 {
6979 "docs": {
6980 "summary": "- tree inspector to collect and process attributes."
6981 },
6982 "name": "inspector",
6983 "type": {
6984 "fqn": "@aws-cdk/core.TreeInspector"
6985 }
6986 }
6987 ]
6988 },
6989 {
6990 "docs": {
6991 "stability": "external"
6992 },
6993 "locationInModule": {
6994 "filename": "lib/cloudformation.generated.ts",
6995 "line": 4314
6996 },
6997 "name": "renderProperties",
6998 "overrides": "@aws-cdk/core.CfnResource",
6999 "parameters": [
7000 {
7001 "name": "props",
7002 "type": {
7003 "collection": {
7004 "elementtype": {
7005 "primitive": "any"
7006 },
7007 "kind": "map"
7008 }
7009 }
7010 }
7011 ],
7012 "protected": true,
7013 "returns": {
7014 "type": {
7015 "collection": {
7016 "elementtype": {
7017 "primitive": "any"
7018 },
7019 "kind": "map"
7020 }
7021 }
7022 }
7023 }
7024 ],
7025 "name": "CfnTypeActivation",
7026 "properties": [
7027 {
7028 "const": true,
7029 "docs": {
7030 "stability": "external",
7031 "summary": "The CloudFormation resource type name for this resource class."
7032 },
7033 "immutable": true,
7034 "locationInModule": {
7035 "filename": "lib/cloudformation.generated.ts",
7036 "line": 4151
7037 },
7038 "name": "CFN_RESOURCE_TYPE_NAME",
7039 "static": true,
7040 "type": {
7041 "primitive": "string"
7042 }
7043 },
7044 {
7045 "docs": {
7046 "custom": {
7047 "cloudformationAttribute": "Arn"
7048 },
7049 "stability": "external",
7050 "summary": "The Amazon Resource Number (ARN) of the activated extension, in this account and Region."
7051 },
7052 "immutable": true,
7053 "locationInModule": {
7054 "filename": "lib/cloudformation.generated.ts",
7055 "line": 4176
7056 },
7057 "name": "attrArn",
7058 "type": {
7059 "primitive": "string"
7060 }
7061 },
7062 {
7063 "docs": {
7064 "stability": "external"
7065 },
7066 "immutable": true,
7067 "locationInModule": {
7068 "filename": "lib/cloudformation.generated.ts",
7069 "line": 4299
7070 },
7071 "name": "cfnProperties",
7072 "overrides": "@aws-cdk/core.CfnResource",
7073 "protected": true,
7074 "type": {
7075 "collection": {
7076 "elementtype": {
7077 "primitive": "any"
7078 },
7079 "kind": "map"
7080 }
7081 }
7082 },
7083 {
7084 "docs": {
7085 "custom": {
7086 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate"
7087 },
7088 "remarks": "Major versions released by the publisher must be manually updated.\n\nThe default is `true` .",
7089 "stability": "external",
7090 "summary": "Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher."
7091 },
7092 "locationInModule": {
7093 "filename": "lib/cloudformation.generated.ts",
7094 "line": 4185
7095 },
7096 "name": "autoUpdate",
7097 "optional": true,
7098 "type": {
7099 "union": {
7100 "types": [
7101 {
7102 "primitive": "boolean"
7103 },
7104 {
7105 "fqn": "@aws-cdk/core.IResolvable"
7106 }
7107 ]
7108 }
7109 }
7110 },
7111 {
7112 "docs": {
7113 "custom": {
7114 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn"
7115 },
7116 "stability": "external",
7117 "summary": "The name of the IAM execution role to use to activate the extension."
7118 },
7119 "locationInModule": {
7120 "filename": "lib/cloudformation.generated.ts",
7121 "line": 4192
7122 },
7123 "name": "executionRoleArn",
7124 "optional": true,
7125 "type": {
7126 "primitive": "string"
7127 }
7128 },
7129 {
7130 "docs": {
7131 "custom": {
7132 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig"
7133 },
7134 "stability": "external",
7135 "summary": "Specifies logging configuration information for an extension."
7136 },
7137 "locationInModule": {
7138 "filename": "lib/cloudformation.generated.ts",
7139 "line": 4199
7140 },
7141 "name": "loggingConfig",
7142 "optional": true,
7143 "type": {
7144 "union": {
7145 "types": [
7146 {
7147 "fqn": "@aws-cdk/core.IResolvable"
7148 },
7149 {
7150 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty"
7151 }
7152 ]
7153 }
7154 }
7155 },
7156 {
7157 "docs": {
7158 "custom": {
7159 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion"
7160 },
7161 "remarks": "The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.\n\nYou can specify `MajorVersion` or `VersionBump` , but not both.",
7162 "stability": "external",
7163 "summary": "The major version of this extension you want to activate, if multiple major versions are available."
7164 },
7165 "locationInModule": {
7166 "filename": "lib/cloudformation.generated.ts",
7167 "line": 4208
7168 },
7169 "name": "majorVersion",
7170 "optional": true,
7171 "type": {
7172 "primitive": "string"
7173 }
7174 },
7175 {
7176 "docs": {
7177 "custom": {
7178 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn"
7179 },
7180 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7181 "stability": "external",
7182 "summary": "The Amazon Resource Number (ARN) of the public extension."
7183 },
7184 "locationInModule": {
7185 "filename": "lib/cloudformation.generated.ts",
7186 "line": 4217
7187 },
7188 "name": "publicTypeArn",
7189 "optional": true,
7190 "type": {
7191 "primitive": "string"
7192 }
7193 },
7194 {
7195 "docs": {
7196 "custom": {
7197 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid"
7198 },
7199 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7200 "stability": "external",
7201 "summary": "The ID of the extension publisher."
7202 },
7203 "locationInModule": {
7204 "filename": "lib/cloudformation.generated.ts",
7205 "line": 4226
7206 },
7207 "name": "publisherId",
7208 "optional": true,
7209 "type": {
7210 "primitive": "string"
7211 }
7212 },
7213 {
7214 "docs": {
7215 "custom": {
7216 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type"
7217 },
7218 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7219 "stability": "external",
7220 "summary": "The extension type."
7221 },
7222 "locationInModule": {
7223 "filename": "lib/cloudformation.generated.ts",
7224 "line": 4235
7225 },
7226 "name": "type",
7227 "optional": true,
7228 "type": {
7229 "primitive": "string"
7230 }
7231 },
7232 {
7233 "docs": {
7234 "custom": {
7235 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename"
7236 },
7237 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7238 "stability": "external",
7239 "summary": "The name of the extension."
7240 },
7241 "locationInModule": {
7242 "filename": "lib/cloudformation.generated.ts",
7243 "line": 4244
7244 },
7245 "name": "typeName",
7246 "optional": true,
7247 "type": {
7248 "primitive": "string"
7249 }
7250 },
7251 {
7252 "docs": {
7253 "custom": {
7254 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias"
7255 },
7256 "remarks": "If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.\n\nAn extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.",
7257 "stability": "external",
7258 "summary": "An alias to assign to the public extension, in this account and Region."
7259 },
7260 "locationInModule": {
7261 "filename": "lib/cloudformation.generated.ts",
7262 "line": 4253
7263 },
7264 "name": "typeNameAlias",
7265 "optional": true,
7266 "type": {
7267 "primitive": "string"
7268 }
7269 },
7270 {
7271 "docs": {
7272 "custom": {
7273 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump"
7274 },
7275 "remarks": "You can also use this parameter to update the value of `AutoUpdate` .\n\n- `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.\n- `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.",
7276 "stability": "external",
7277 "summary": "Manually updates a previously-activated type to a new major or minor version, if available."
7278 },
7279 "locationInModule": {
7280 "filename": "lib/cloudformation.generated.ts",
7281 "line": 4263
7282 },
7283 "name": "versionBump",
7284 "optional": true,
7285 "type": {
7286 "primitive": "string"
7287 }
7288 }
7289 ],
7290 "symbolId": "lib/cloudformation.generated:CfnTypeActivation"
7291 },
7292 "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty": {
7293 "assembly": "@aws-cdk/aws-cloudformation",
7294 "datatype": true,
7295 "docs": {
7296 "custom": {
7297 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html",
7298 "exampleMetadata": "fixture=_generated"
7299 },
7300 "stability": "external",
7301 "summary": "Contains logging configuration information for an extension.",
7302 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnTypeActivation.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};"
7303 },
7304 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty",
7305 "kind": "interface",
7306 "locationInModule": {
7307 "filename": "lib/cloudformation.generated.ts",
7308 "line": 4328
7309 },
7310 "name": "LoggingConfigProperty",
7311 "namespace": "CfnTypeActivation",
7312 "properties": [
7313 {
7314 "abstract": true,
7315 "docs": {
7316 "custom": {
7317 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-loggroupname"
7318 },
7319 "stability": "external",
7320 "summary": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers."
7321 },
7322 "immutable": true,
7323 "locationInModule": {
7324 "filename": "lib/cloudformation.generated.ts",
7325 "line": 4334
7326 },
7327 "name": "logGroupName",
7328 "optional": true,
7329 "type": {
7330 "primitive": "string"
7331 }
7332 },
7333 {
7334 "abstract": true,
7335 "docs": {
7336 "custom": {
7337 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-logrolearn"
7338 },
7339 "stability": "external",
7340 "summary": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs."
7341 },
7342 "immutable": true,
7343 "locationInModule": {
7344 "filename": "lib/cloudformation.generated.ts",
7345 "line": 4340
7346 },
7347 "name": "logRoleArn",
7348 "optional": true,
7349 "type": {
7350 "primitive": "string"
7351 }
7352 }
7353 ],
7354 "symbolId": "lib/cloudformation.generated:CfnTypeActivation.LoggingConfigProperty"
7355 },
7356 "@aws-cdk/aws-cloudformation.CfnTypeActivationProps": {
7357 "assembly": "@aws-cdk/aws-cloudformation",
7358 "datatype": true,
7359 "docs": {
7360 "custom": {
7361 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html",
7362 "exampleMetadata": "fixture=_generated"
7363 },
7364 "stability": "external",
7365 "summary": "Properties for defining a `CfnTypeActivation`.",
7366 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnTypeActivationProps: cloudformation.CfnTypeActivationProps = {\n autoUpdate: false,\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n majorVersion: 'majorVersion',\n publicTypeArn: 'publicTypeArn',\n publisherId: 'publisherId',\n type: 'type',\n typeName: 'typeName',\n typeNameAlias: 'typeNameAlias',\n versionBump: 'versionBump',\n};"
7367 },
7368 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivationProps",
7369 "kind": "interface",
7370 "locationInModule": {
7371 "filename": "lib/cloudformation.generated.ts",
7372 "line": 3973
7373 },
7374 "name": "CfnTypeActivationProps",
7375 "properties": [
7376 {
7377 "abstract": true,
7378 "docs": {
7379 "custom": {
7380 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate"
7381 },
7382 "remarks": "Major versions released by the publisher must be manually updated.\n\nThe default is `true` .",
7383 "stability": "external",
7384 "summary": "Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher."
7385 },
7386 "immutable": true,
7387 "locationInModule": {
7388 "filename": "lib/cloudformation.generated.ts",
7389 "line": 3982
7390 },
7391 "name": "autoUpdate",
7392 "optional": true,
7393 "type": {
7394 "union": {
7395 "types": [
7396 {
7397 "primitive": "boolean"
7398 },
7399 {
7400 "fqn": "@aws-cdk/core.IResolvable"
7401 }
7402 ]
7403 }
7404 }
7405 },
7406 {
7407 "abstract": true,
7408 "docs": {
7409 "custom": {
7410 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn"
7411 },
7412 "stability": "external",
7413 "summary": "The name of the IAM execution role to use to activate the extension."
7414 },
7415 "immutable": true,
7416 "locationInModule": {
7417 "filename": "lib/cloudformation.generated.ts",
7418 "line": 3989
7419 },
7420 "name": "executionRoleArn",
7421 "optional": true,
7422 "type": {
7423 "primitive": "string"
7424 }
7425 },
7426 {
7427 "abstract": true,
7428 "docs": {
7429 "custom": {
7430 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig"
7431 },
7432 "stability": "external",
7433 "summary": "Specifies logging configuration information for an extension."
7434 },
7435 "immutable": true,
7436 "locationInModule": {
7437 "filename": "lib/cloudformation.generated.ts",
7438 "line": 3996
7439 },
7440 "name": "loggingConfig",
7441 "optional": true,
7442 "type": {
7443 "union": {
7444 "types": [
7445 {
7446 "fqn": "@aws-cdk/core.IResolvable"
7447 },
7448 {
7449 "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty"
7450 }
7451 ]
7452 }
7453 }
7454 },
7455 {
7456 "abstract": true,
7457 "docs": {
7458 "custom": {
7459 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion"
7460 },
7461 "remarks": "The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.\n\nYou can specify `MajorVersion` or `VersionBump` , but not both.",
7462 "stability": "external",
7463 "summary": "The major version of this extension you want to activate, if multiple major versions are available."
7464 },
7465 "immutable": true,
7466 "locationInModule": {
7467 "filename": "lib/cloudformation.generated.ts",
7468 "line": 4005
7469 },
7470 "name": "majorVersion",
7471 "optional": true,
7472 "type": {
7473 "primitive": "string"
7474 }
7475 },
7476 {
7477 "abstract": true,
7478 "docs": {
7479 "custom": {
7480 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn"
7481 },
7482 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7483 "stability": "external",
7484 "summary": "The Amazon Resource Number (ARN) of the public extension."
7485 },
7486 "immutable": true,
7487 "locationInModule": {
7488 "filename": "lib/cloudformation.generated.ts",
7489 "line": 4014
7490 },
7491 "name": "publicTypeArn",
7492 "optional": true,
7493 "type": {
7494 "primitive": "string"
7495 }
7496 },
7497 {
7498 "abstract": true,
7499 "docs": {
7500 "custom": {
7501 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid"
7502 },
7503 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7504 "stability": "external",
7505 "summary": "The ID of the extension publisher."
7506 },
7507 "immutable": true,
7508 "locationInModule": {
7509 "filename": "lib/cloudformation.generated.ts",
7510 "line": 4023
7511 },
7512 "name": "publisherId",
7513 "optional": true,
7514 "type": {
7515 "primitive": "string"
7516 }
7517 },
7518 {
7519 "abstract": true,
7520 "docs": {
7521 "custom": {
7522 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type"
7523 },
7524 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7525 "stability": "external",
7526 "summary": "The extension type."
7527 },
7528 "immutable": true,
7529 "locationInModule": {
7530 "filename": "lib/cloudformation.generated.ts",
7531 "line": 4032
7532 },
7533 "name": "type",
7534 "optional": true,
7535 "type": {
7536 "primitive": "string"
7537 }
7538 },
7539 {
7540 "abstract": true,
7541 "docs": {
7542 "custom": {
7543 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename"
7544 },
7545 "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .",
7546 "stability": "external",
7547 "summary": "The name of the extension."
7548 },
7549 "immutable": true,
7550 "locationInModule": {
7551 "filename": "lib/cloudformation.generated.ts",
7552 "line": 4041
7553 },
7554 "name": "typeName",
7555 "optional": true,
7556 "type": {
7557 "primitive": "string"
7558 }
7559 },
7560 {
7561 "abstract": true,
7562 "docs": {
7563 "custom": {
7564 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias"
7565 },
7566 "remarks": "If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.\n\nAn extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.",
7567 "stability": "external",
7568 "summary": "An alias to assign to the public extension, in this account and Region."
7569 },
7570 "immutable": true,
7571 "locationInModule": {
7572 "filename": "lib/cloudformation.generated.ts",
7573 "line": 4050
7574 },
7575 "name": "typeNameAlias",
7576 "optional": true,
7577 "type": {
7578 "primitive": "string"
7579 }
7580 },
7581 {
7582 "abstract": true,
7583 "docs": {
7584 "custom": {
7585 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump"
7586 },
7587 "remarks": "You can also use this parameter to update the value of `AutoUpdate` .\n\n- `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.\n- `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.",
7588 "stability": "external",
7589 "summary": "Manually updates a previously-activated type to a new major or minor version, if available."
7590 },
7591 "immutable": true,
7592 "locationInModule": {
7593 "filename": "lib/cloudformation.generated.ts",
7594 "line": 4060
7595 },
7596 "name": "versionBump",
7597 "optional": true,
7598 "type": {
7599 "primitive": "string"
7600 }
7601 }
7602 ],
7603 "symbolId": "lib/cloudformation.generated:CfnTypeActivationProps"
7604 },
7605 "@aws-cdk/aws-cloudformation.CfnWaitCondition": {
7606 "assembly": "@aws-cdk/aws-cloudformation",
7607 "base": "@aws-cdk/core.CfnResource",
7608 "docs": {
7609 "custom": {
7610 "cloudformationResource": "AWS::CloudFormation::WaitCondition",
7611 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html",
7612 "exampleMetadata": "fixture=_generated"
7613 },
7614 "remarks": "> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.\n\nYou can use a wait condition for situations like the following:\n\n- To coordinate stack resource creation with configuration actions that are external to the stack creation.\n- To track the status of a configuration process.\n\nFor these situations, we recommend that you associate a [CreationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html) attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see [Creating wait conditions in a template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.\n\n> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .",
7615 "stability": "external",
7616 "summary": "A CloudFormation `AWS::CloudFormation::WaitCondition`.",
7617 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitCondition = new cloudformation.CfnWaitCondition(this, 'MyCfnWaitCondition', /* all optional props */ {\n count: 123,\n handle: 'handle',\n timeout: 'timeout',\n});"
7618 },
7619 "fqn": "@aws-cdk/aws-cloudformation.CfnWaitCondition",
7620 "initializer": {
7621 "docs": {
7622 "stability": "external",
7623 "summary": "Create a new `AWS::CloudFormation::WaitCondition`."
7624 },
7625 "locationInModule": {
7626 "filename": "lib/cloudformation.generated.ts",
7627 "line": 4576
7628 },
7629 "parameters": [
7630 {
7631 "docs": {
7632 "summary": "- scope in which this resource is defined."
7633 },
7634 "name": "scope",
7635 "type": {
7636 "fqn": "@aws-cdk/core.Construct"
7637 }
7638 },
7639 {
7640 "docs": {
7641 "summary": "- scoped id of the resource."
7642 },
7643 "name": "id",
7644 "type": {
7645 "primitive": "string"
7646 }
7647 },
7648 {
7649 "docs": {
7650 "summary": "- resource properties."
7651 },
7652 "name": "props",
7653 "optional": true,
7654 "type": {
7655 "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionProps"
7656 }
7657 }
7658 ]
7659 },
7660 "interfaces": [
7661 "@aws-cdk/core.IInspectable"
7662 ],
7663 "kind": "class",
7664 "locationInModule": {
7665 "filename": "lib/cloudformation.generated.ts",
7666 "line": 4505
7667 },
7668 "methods": [
7669 {
7670 "docs": {
7671 "stability": "external",
7672 "summary": "Examines the CloudFormation resource and discloses attributes."
7673 },
7674 "locationInModule": {
7675 "filename": "lib/cloudformation.generated.ts",
7676 "line": 4591
7677 },
7678 "name": "inspect",
7679 "overrides": "@aws-cdk/core.IInspectable",
7680 "parameters": [
7681 {
7682 "docs": {
7683 "summary": "- tree inspector to collect and process attributes."
7684 },
7685 "name": "inspector",
7686 "type": {
7687 "fqn": "@aws-cdk/core.TreeInspector"
7688 }
7689 }
7690 ]
7691 },
7692 {
7693 "docs": {
7694 "stability": "external"
7695 },
7696 "locationInModule": {
7697 "filename": "lib/cloudformation.generated.ts",
7698 "line": 4604
7699 },
7700 "name": "renderProperties",
7701 "overrides": "@aws-cdk/core.CfnResource",
7702 "parameters": [
7703 {
7704 "name": "props",
7705 "type": {
7706 "collection": {
7707 "elementtype": {
7708 "primitive": "any"
7709 },
7710 "kind": "map"
7711 }
7712 }
7713 }
7714 ],
7715 "protected": true,
7716 "returns": {
7717 "type": {
7718 "collection": {
7719 "elementtype": {
7720 "primitive": "any"
7721 },
7722 "kind": "map"
7723 }
7724 }
7725 }
7726 }
7727 ],
7728 "name": "CfnWaitCondition",
7729 "properties": [
7730 {
7731 "const": true,
7732 "docs": {
7733 "stability": "external",
7734 "summary": "The CloudFormation resource type name for this resource class."
7735 },
7736 "immutable": true,
7737 "locationInModule": {
7738 "filename": "lib/cloudformation.generated.ts",
7739 "line": 4509
7740 },
7741 "name": "CFN_RESOURCE_TYPE_NAME",
7742 "static": true,
7743 "type": {
7744 "primitive": "string"
7745 }
7746 },
7747 {
7748 "docs": {
7749 "custom": {
7750 "cloudformationAttribute": "Data"
7751 },
7752 "remarks": "For more information about wait condition signals, see [Wait condition signal JSON format](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html#using-cfn-waitcondition-signaljson) .\n\nExample return value for a wait condition with 2 signals:\n\n`{ \"Signal1\" : \"Step 1 complete.\" , \"Signal2\" : \"Step 2 complete.\" }`",
7753 "stability": "external",
7754 "summary": "A JSON object that contains the `UniqueId` and `Data` values from the wait condition signal(s) for the specified wait condition."
7755 },
7756 "immutable": true,
7757 "locationInModule": {
7758 "filename": "lib/cloudformation.generated.ts",
7759 "line": 4538
7760 },
7761 "name": "attrData",
7762 "type": {
7763 "fqn": "@aws-cdk/core.IResolvable"
7764 }
7765 },
7766 {
7767 "docs": {
7768 "stability": "external"
7769 },
7770 "immutable": true,
7771 "locationInModule": {
7772 "filename": "lib/cloudformation.generated.ts",
7773 "line": 4596
7774 },
7775 "name": "cfnProperties",
7776 "overrides": "@aws-cdk/core.CfnResource",
7777 "protected": true,
7778 "type": {
7779 "collection": {
7780 "elementtype": {
7781 "primitive": "any"
7782 },
7783 "kind": "map"
7784 }
7785 }
7786 },
7787 {
7788 "docs": {
7789 "custom": {
7790 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count"
7791 },
7792 "remarks": "When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.\n\nUpdates aren't supported.",
7793 "stability": "external",
7794 "summary": "The number of success signals that CloudFormation must receive before it continues the stack creation process."
7795 },
7796 "locationInModule": {
7797 "filename": "lib/cloudformation.generated.ts",
7798 "line": 4547
7799 },
7800 "name": "count",
7801 "optional": true,
7802 "type": {
7803 "primitive": "number"
7804 }
7805 },
7806 {
7807 "docs": {
7808 "custom": {
7809 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle"
7810 },
7811 "remarks": "Use the `Ref` intrinsic function to specify an [`AWS::CloudFormation::WaitConditionHandle`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html) resource.\n\nAnytime you add a `WaitCondition` resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.\n\nUpdates aren't supported.",
7812 "stability": "external",
7813 "summary": "A reference to the wait condition handle used to signal this wait condition."
7814 },
7815 "locationInModule": {
7816 "filename": "lib/cloudformation.generated.ts",
7817 "line": 4558
7818 },
7819 "name": "handle",
7820 "optional": true,
7821 "type": {
7822 "primitive": "string"
7823 }
7824 },
7825 {
7826 "docs": {
7827 "custom": {
7828 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout"
7829 },
7830 "remarks": "`Timeout` is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).\n\nUpdates aren't supported.",
7831 "stability": "external",
7832 "summary": "The length of time (in seconds) to wait for the number of signals that the `Count` property specifies."
7833 },
7834 "locationInModule": {
7835 "filename": "lib/cloudformation.generated.ts",
7836 "line": 4567
7837 },
7838 "name": "timeout",
7839 "optional": true,
7840 "type": {
7841 "primitive": "string"
7842 }
7843 }
7844 ],
7845 "symbolId": "lib/cloudformation.generated:CfnWaitCondition"
7846 },
7847 "@aws-cdk/aws-cloudformation.CfnWaitConditionHandle": {
7848 "assembly": "@aws-cdk/aws-cloudformation",
7849 "base": "@aws-cdk/core.CfnResource",
7850 "docs": {
7851 "custom": {
7852 "cloudformationResource": "AWS::CloudFormation::WaitConditionHandle",
7853 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html",
7854 "exampleMetadata": "fixture=_generated"
7855 },
7856 "remarks": "> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a `CreationPolicy` attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.\n>\n> For more information, see [Deploying applications on Amazon EC2 with AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/deploying.applications.html) .\n\nThe `AWS::CloudFormation::WaitConditionHandle` type has no properties. When you reference the `WaitConditionHandle` resource by using the `Ref` function, AWS CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated `AWS::CloudFormation::WaitCondition` resource checks the URL for the required number of success signals or for a failure signal.\n\n> Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. > Updates aren't supported for this resource.",
7857 "stability": "external",
7858 "summary": "A CloudFormation `AWS::CloudFormation::WaitConditionHandle`.",
7859 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitConditionHandle = new cloudformation.CfnWaitConditionHandle(this, 'MyCfnWaitConditionHandle');"
7860 },
7861 "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionHandle",
7862 "initializer": {
7863 "docs": {
7864 "stability": "external",
7865 "summary": "Create a new `AWS::CloudFormation::WaitConditionHandle`."
7866 },
7867 "locationInModule": {
7868 "filename": "lib/cloudformation.generated.ts",
7869 "line": 4652
7870 },
7871 "parameters": [
7872 {
7873 "docs": {
7874 "summary": "- scope in which this resource is defined."
7875 },
7876 "name": "scope",
7877 "type": {
7878 "fqn": "@aws-cdk/core.Construct"
7879 }
7880 },
7881 {
7882 "docs": {
7883 "summary": "- scoped id of the resource."
7884 },
7885 "name": "id",
7886 "type": {
7887 "primitive": "string"
7888 }
7889 }
7890 ]
7891 },
7892 "interfaces": [
7893 "@aws-cdk/core.IInspectable"
7894 ],
7895 "kind": "class",
7896 "locationInModule": {
7897 "filename": "lib/cloudformation.generated.ts",
7898 "line": 4625
7899 },
7900 "methods": [
7901 {
7902 "docs": {
7903 "stability": "external",
7904 "summary": "Examines the CloudFormation resource and discloses attributes."
7905 },
7906 "locationInModule": {
7907 "filename": "lib/cloudformation.generated.ts",
7908 "line": 4662
7909 },
7910 "name": "inspect",
7911 "overrides": "@aws-cdk/core.IInspectable",
7912 "parameters": [
7913 {
7914 "docs": {
7915 "summary": "- tree inspector to collect and process attributes."
7916 },
7917 "name": "inspector",
7918 "type": {
7919 "fqn": "@aws-cdk/core.TreeInspector"
7920 }
7921 }
7922 ]
7923 }
7924 ],
7925 "name": "CfnWaitConditionHandle",
7926 "properties": [
7927 {
7928 "const": true,
7929 "docs": {
7930 "stability": "external",
7931 "summary": "The CloudFormation resource type name for this resource class."
7932 },
7933 "immutable": true,
7934 "locationInModule": {
7935 "filename": "lib/cloudformation.generated.ts",
7936 "line": 4629
7937 },
7938 "name": "CFN_RESOURCE_TYPE_NAME",
7939 "static": true,
7940 "type": {
7941 "primitive": "string"
7942 }
7943 }
7944 ],
7945 "symbolId": "lib/cloudformation.generated:CfnWaitConditionHandle"
7946 },
7947 "@aws-cdk/aws-cloudformation.CfnWaitConditionProps": {
7948 "assembly": "@aws-cdk/aws-cloudformation",
7949 "datatype": true,
7950 "docs": {
7951 "custom": {
7952 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html",
7953 "exampleMetadata": "fixture=_generated"
7954 },
7955 "stability": "external",
7956 "summary": "Properties for defining a `CfnWaitCondition`.",
7957 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitConditionProps: cloudformation.CfnWaitConditionProps = {\n count: 123,\n handle: 'handle',\n timeout: 'timeout',\n};"
7958 },
7959 "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionProps",
7960 "kind": "interface",
7961 "locationInModule": {
7962 "filename": "lib/cloudformation.generated.ts",
7963 "line": 4403
7964 },
7965 "name": "CfnWaitConditionProps",
7966 "properties": [
7967 {
7968 "abstract": true,
7969 "docs": {
7970 "custom": {
7971 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count"
7972 },
7973 "remarks": "When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.\n\nUpdates aren't supported.",
7974 "stability": "external",
7975 "summary": "The number of success signals that CloudFormation must receive before it continues the stack creation process."
7976 },
7977 "immutable": true,
7978 "locationInModule": {
7979 "filename": "lib/cloudformation.generated.ts",
7980 "line": 4412
7981 },
7982 "name": "count",
7983 "optional": true,
7984 "type": {
7985 "primitive": "number"
7986 }
7987 },
7988 {
7989 "abstract": true,
7990 "docs": {
7991 "custom": {
7992 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle"
7993 },
7994 "remarks": "Use the `Ref` intrinsic function to specify an [`AWS::CloudFormation::WaitConditionHandle`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html) resource.\n\nAnytime you add a `WaitCondition` resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.\n\nUpdates aren't supported.",
7995 "stability": "external",
7996 "summary": "A reference to the wait condition handle used to signal this wait condition."
7997 },
7998 "immutable": true,
7999 "locationInModule": {
8000 "filename": "lib/cloudformation.generated.ts",
8001 "line": 4423
8002 },
8003 "name": "handle",
8004 "optional": true,
8005 "type": {
8006 "primitive": "string"
8007 }
8008 },
8009 {
8010 "abstract": true,
8011 "docs": {
8012 "custom": {
8013 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout"
8014 },
8015 "remarks": "`Timeout` is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).\n\nUpdates aren't supported.",
8016 "stability": "external",
8017 "summary": "The length of time (in seconds) to wait for the number of signals that the `Count` property specifies."
8018 },
8019 "immutable": true,
8020 "locationInModule": {
8021 "filename": "lib/cloudformation.generated.ts",
8022 "line": 4432
8023 },
8024 "name": "timeout",
8025 "optional": true,
8026 "type": {
8027 "primitive": "string"
8028 }
8029 }
8030 ],
8031 "symbolId": "lib/cloudformation.generated:CfnWaitConditionProps"
8032 },
8033 "@aws-cdk/aws-cloudformation.CloudFormationCapabilities": {
8034 "assembly": "@aws-cdk/aws-cloudformation",
8035 "docs": {
8036 "deprecated": "use `core.CfnCapabilities`",
8037 "stability": "deprecated",
8038 "summary": "Capabilities that affect whether CloudFormation is allowed to change IAM resources."
8039 },
8040 "fqn": "@aws-cdk/aws-cloudformation.CloudFormationCapabilities",
8041 "kind": "enum",
8042 "locationInModule": {
8043 "filename": "lib/cloud-formation-capabilities.ts",
8044 "line": 5
8045 },
8046 "members": [
8047 {
8048 "docs": {
8049 "custom": {
8050 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities"
8051 },
8052 "remarks": "Pass this capability if you wish to block the creation IAM resources.",
8053 "stability": "deprecated",
8054 "summary": "No IAM Capabilities."
8055 },
8056 "name": "NONE"
8057 },
8058 {
8059 "docs": {
8060 "custom": {
8061 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities"
8062 },
8063 "remarks": "Pass this capability if you're only creating anonymous resources.",
8064 "stability": "deprecated",
8065 "summary": "Capability to create anonymous IAM resources."
8066 },
8067 "name": "ANONYMOUS_IAM"
8068 },
8069 {
8070 "docs": {
8071 "custom": {
8072 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities"
8073 },
8074 "remarks": "Pass this capability if you're creating IAM resources that have physical\nnames.\n\n`CloudFormationCapabilities.NamedIAM` implies `CloudFormationCapabilities.IAM`; you don't have to pass both.",
8075 "stability": "deprecated",
8076 "summary": "Capability to create named IAM resources."
8077 },
8078 "name": "NAMED_IAM"
8079 },
8080 {
8081 "docs": {
8082 "custom": {
8083 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html"
8084 },
8085 "remarks": "Pass this capability if your template includes macros, for example AWS::Include or AWS::Serverless.",
8086 "stability": "deprecated",
8087 "summary": "Capability to run CloudFormation macros."
8088 },
8089 "name": "AUTO_EXPAND"
8090 }
8091 ],
8092 "name": "CloudFormationCapabilities",
8093 "symbolId": "lib/cloud-formation-capabilities:CloudFormationCapabilities"
8094 },
8095 "@aws-cdk/aws-cloudformation.CustomResource": {
8096 "assembly": "@aws-cdk/aws-cloudformation",
8097 "base": "@aws-cdk/core.CustomResource",
8098 "docs": {
8099 "deprecated": "use `core.CustomResource`",
8100 "stability": "deprecated",
8101 "summary": "Deprecated.",
8102 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const customResourceProvider: cloudformation.CustomResourceProvider;\ndeclare const properties: any;\nconst customResource = new cloudformation.CustomResource(this, 'MyCustomResource', {\n provider: customResourceProvider,\n\n // the properties below are optional\n properties: {\n propertiesKey: properties,\n },\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n resourceType: 'resourceType',\n});",
8103 "custom": {
8104 "exampleMetadata": "fixture=_generated"
8105 }
8106 },
8107 "fqn": "@aws-cdk/aws-cloudformation.CustomResource",
8108 "initializer": {
8109 "docs": {
8110 "stability": "deprecated"
8111 },
8112 "locationInModule": {
8113 "filename": "lib/custom-resource.ts",
8114 "line": 178
8115 },
8116 "parameters": [
8117 {
8118 "name": "scope",
8119 "type": {
8120 "fqn": "@aws-cdk/core.Construct"
8121 }
8122 },
8123 {
8124 "name": "id",
8125 "type": {
8126 "primitive": "string"
8127 }
8128 },
8129 {
8130 "name": "props",
8131 "type": {
8132 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProps"
8133 }
8134 }
8135 ]
8136 },
8137 "kind": "class",
8138 "locationInModule": {
8139 "filename": "lib/custom-resource.ts",
8140 "line": 177
8141 },
8142 "name": "CustomResource",
8143 "symbolId": "lib/custom-resource:CustomResource"
8144 },
8145 "@aws-cdk/aws-cloudformation.CustomResourceProps": {
8146 "assembly": "@aws-cdk/aws-cloudformation",
8147 "datatype": true,
8148 "docs": {
8149 "deprecated": "use `core.CustomResourceProps`",
8150 "stability": "deprecated",
8151 "summary": "Properties to provide a Lambda-backed custom resource.",
8152 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const customResourceProvider: cloudformation.CustomResourceProvider;\ndeclare const properties: any;\nconst customResourceProps: cloudformation.CustomResourceProps = {\n provider: customResourceProvider,\n\n // the properties below are optional\n properties: {\n propertiesKey: properties,\n },\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n resourceType: 'resourceType',\n};",
8153 "custom": {
8154 "exampleMetadata": "fixture=_generated"
8155 }
8156 },
8157 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProps",
8158 "kind": "interface",
8159 "locationInModule": {
8160 "filename": "lib/custom-resource.ts",
8161 "line": 90
8162 },
8163 "name": "CustomResourceProps",
8164 "properties": [
8165 {
8166 "abstract": true,
8167 "docs": {
8168 "remarks": "You can implement a provider by listening to raw AWS CloudFormation events\nthrough an SNS topic or an AWS Lambda function or use the CDK's custom\n[resource provider framework] which makes it easier to implement robust\nproviders.\n\n[resource provider framework]: https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html\n\n```ts\nimport * as custom_resources from '@aws-cdk/custom-resources';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { Stack } from '@aws-cdk/core';\ndeclare const myOnEventLambda: lambda.Function;\ndeclare const myIsCompleteLambda: lambda.Function;\nconst stack = new Stack();\n\nconst provider = new custom_resources.Provider(stack, 'myProvider', {\n onEventHandler: myOnEventLambda,\n isCompleteHandler: myIsCompleteLambda, // optional\n});\n```\n\n```ts\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as lambda from '@aws-cdk/aws-lambda';\ndeclare const myFunction: lambda.Function;\n\n// invoke an AWS Lambda function when a lifecycle event occurs:\nconst provider = cloudformation.CustomResourceProvider.fromLambda(myFunction);\n```\n\n```ts\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as sns from '@aws-cdk/aws-sns';\ndeclare const myTopic: sns.Topic;\n\n// publish lifecycle events to an SNS topic:\nconst provider = cloudformation.CustomResourceProvider.fromTopic(myTopic);\n```",
8169 "stability": "deprecated",
8170 "summary": "The provider which implements the custom resource."
8171 },
8172 "immutable": true,
8173 "locationInModule": {
8174 "filename": "lib/custom-resource.ts",
8175 "line": 133
8176 },
8177 "name": "provider",
8178 "type": {
8179 "fqn": "@aws-cdk/aws-cloudformation.ICustomResourceProvider"
8180 }
8181 },
8182 {
8183 "abstract": true,
8184 "docs": {
8185 "default": "- No properties.",
8186 "stability": "deprecated",
8187 "summary": "Properties to pass to the Lambda."
8188 },
8189 "immutable": true,
8190 "locationInModule": {
8191 "filename": "lib/custom-resource.ts",
8192 "line": 140
8193 },
8194 "name": "properties",
8195 "optional": true,
8196 "type": {
8197 "collection": {
8198 "elementtype": {
8199 "primitive": "any"
8200 },
8201 "kind": "map"
8202 }
8203 }
8204 },
8205 {
8206 "abstract": true,
8207 "docs": {
8208 "default": "cdk.RemovalPolicy.Destroy",
8209 "stability": "deprecated",
8210 "summary": "The policy to apply when this resource is removed from the application."
8211 },
8212 "immutable": true,
8213 "locationInModule": {
8214 "filename": "lib/custom-resource.ts",
8215 "line": 170
8216 },
8217 "name": "removalPolicy",
8218 "optional": true,
8219 "type": {
8220 "fqn": "@aws-cdk/core.RemovalPolicy"
8221 }
8222 },
8223 {
8224 "abstract": true,
8225 "docs": {
8226 "default": "- AWS::CloudFormation::CustomResource",
8227 "remarks": "For example, you can use \"Custom::MyCustomResourceTypeName\".\n\nCustom resource type names must begin with \"Custom::\" and can include\nalphanumeric characters and the following characters: _@-. You can specify\na custom resource type name up to a maximum length of 60 characters. You\ncannot change the type during an update.\n\nUsing your own resource type names helps you quickly differentiate the\ntypes of custom resources in your stack. For example, if you had two custom\nresources that conduct two different ping tests, you could name their type\nas Custom::PingTester to make them easily identifiable as ping testers\n(instead of using AWS::CloudFormation::CustomResource).",
8228 "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#aws-cfn-resource-type-name",
8229 "stability": "deprecated",
8230 "summary": "For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name."
8231 },
8232 "immutable": true,
8233 "locationInModule": {
8234 "filename": "lib/custom-resource.ts",
8235 "line": 163
8236 },
8237 "name": "resourceType",
8238 "optional": true,
8239 "type": {
8240 "primitive": "string"
8241 }
8242 }
8243 ],
8244 "symbolId": "lib/custom-resource:CustomResourceProps"
8245 },
8246 "@aws-cdk/aws-cloudformation.CustomResourceProvider": {
8247 "assembly": "@aws-cdk/aws-cloudformation",
8248 "docs": {
8249 "deprecated": "use core.CustomResource instead",
8250 "stability": "deprecated",
8251 "summary": "Represents a provider for an AWS CloudFormation custom resources.",
8252 "example": "import * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as lambda from '@aws-cdk/aws-lambda';\ndeclare const myFunction: lambda.Function;\n\n// invoke an AWS Lambda function when a lifecycle event occurs:\nconst provider = cloudformation.CustomResourceProvider.fromLambda(myFunction);",
8253 "custom": {
8254 "exampleMetadata": "infused"
8255 }
8256 },
8257 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider",
8258 "interfaces": [
8259 "@aws-cdk/aws-cloudformation.ICustomResourceProvider"
8260 ],
8261 "kind": "class",
8262 "locationInModule": {
8263 "filename": "lib/custom-resource.ts",
8264 "line": 47
8265 },
8266 "methods": [
8267 {
8268 "docs": {
8269 "remarks": "We recommend using a lambda.SingletonFunction for this.",
8270 "stability": "deprecated",
8271 "summary": "The Lambda provider that implements this custom resource."
8272 },
8273 "locationInModule": {
8274 "filename": "lib/custom-resource.ts",
8275 "line": 53
8276 },
8277 "name": "fromLambda",
8278 "parameters": [
8279 {
8280 "name": "handler",
8281 "type": {
8282 "fqn": "@aws-cdk/aws-lambda.IFunction"
8283 }
8284 }
8285 ],
8286 "returns": {
8287 "type": {
8288 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider"
8289 }
8290 },
8291 "static": true
8292 },
8293 {
8294 "docs": {
8295 "stability": "deprecated",
8296 "summary": "The SNS Topic for the provider that implements this custom resource."
8297 },
8298 "locationInModule": {
8299 "filename": "lib/custom-resource.ts",
8300 "line": 60
8301 },
8302 "name": "fromTopic",
8303 "parameters": [
8304 {
8305 "name": "topic",
8306 "type": {
8307 "fqn": "@aws-cdk/aws-sns.ITopic"
8308 }
8309 }
8310 ],
8311 "returns": {
8312 "type": {
8313 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider"
8314 }
8315 },
8316 "static": true
8317 },
8318 {
8319 "docs": {
8320 "deprecated": "use `fromLambda`",
8321 "stability": "deprecated",
8322 "summary": "Use AWS Lambda as a provider."
8323 },
8324 "locationInModule": {
8325 "filename": "lib/custom-resource.ts",
8326 "line": 68
8327 },
8328 "name": "lambda",
8329 "parameters": [
8330 {
8331 "name": "handler",
8332 "type": {
8333 "fqn": "@aws-cdk/aws-lambda.IFunction"
8334 }
8335 }
8336 ],
8337 "returns": {
8338 "type": {
8339 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider"
8340 }
8341 },
8342 "static": true
8343 },
8344 {
8345 "docs": {
8346 "deprecated": "use `fromTopic`",
8347 "stability": "deprecated",
8348 "summary": "Use an SNS topic as the provider."
8349 },
8350 "locationInModule": {
8351 "filename": "lib/custom-resource.ts",
8352 "line": 74
8353 },
8354 "name": "topic",
8355 "parameters": [
8356 {
8357 "name": "topic",
8358 "type": {
8359 "fqn": "@aws-cdk/aws-sns.ITopic"
8360 }
8361 }
8362 ],
8363 "returns": {
8364 "type": {
8365 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider"
8366 }
8367 },
8368 "static": true
8369 },
8370 {
8371 "docs": {
8372 "stability": "deprecated",
8373 "summary": "Called when this provider is used by a `CustomResource`."
8374 },
8375 "locationInModule": {
8376 "filename": "lib/custom-resource.ts",
8377 "line": 81
8378 },
8379 "name": "bind",
8380 "overrides": "@aws-cdk/aws-cloudformation.ICustomResourceProvider",
8381 "parameters": [
8382 {
8383 "name": "_",
8384 "type": {
8385 "fqn": "@aws-cdk/core.Construct"
8386 }
8387 }
8388 ],
8389 "returns": {
8390 "type": {
8391 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig"
8392 }
8393 }
8394 }
8395 ],
8396 "name": "CustomResourceProvider",
8397 "properties": [
8398 {
8399 "docs": {
8400 "stability": "deprecated",
8401 "summary": "the ServiceToken which contains the ARN for this provider."
8402 },
8403 "immutable": true,
8404 "locationInModule": {
8405 "filename": "lib/custom-resource.ts",
8406 "line": 79
8407 },
8408 "name": "serviceToken",
8409 "type": {
8410 "primitive": "string"
8411 }
8412 }
8413 ],
8414 "symbolId": "lib/custom-resource:CustomResourceProvider"
8415 },
8416 "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig": {
8417 "assembly": "@aws-cdk/aws-cloudformation",
8418 "datatype": true,
8419 "docs": {
8420 "deprecated": "used in {@link ICustomResourceProvider} which is now deprecated",
8421 "stability": "deprecated",
8422 "summary": "Configuration options for custom resource providers.",
8423 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst customResourceProviderConfig: cloudformation.CustomResourceProviderConfig = {\n serviceToken: 'serviceToken',\n};",
8424 "custom": {
8425 "exampleMetadata": "fixture=_generated"
8426 }
8427 },
8428 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig",
8429 "kind": "interface",
8430 "locationInModule": {
8431 "filename": "lib/custom-resource.ts",
8432 "line": 21
8433 },
8434 "name": "CustomResourceProviderConfig",
8435 "properties": [
8436 {
8437 "abstract": true,
8438 "docs": {
8439 "stability": "deprecated",
8440 "summary": "The ARN of the SNS topic or the AWS Lambda function which implements this provider."
8441 },
8442 "immutable": true,
8443 "locationInModule": {
8444 "filename": "lib/custom-resource.ts",
8445 "line": 26
8446 },
8447 "name": "serviceToken",
8448 "type": {
8449 "primitive": "string"
8450 }
8451 }
8452 ],
8453 "symbolId": "lib/custom-resource:CustomResourceProviderConfig"
8454 },
8455 "@aws-cdk/aws-cloudformation.ICustomResourceProvider": {
8456 "assembly": "@aws-cdk/aws-cloudformation",
8457 "docs": {
8458 "deprecated": "use `core.ICustomResourceProvider`",
8459 "stability": "deprecated",
8460 "summary": "Represents a provider for an AWS CloudFormation custom resources."
8461 },
8462 "fqn": "@aws-cdk/aws-cloudformation.ICustomResourceProvider",
8463 "kind": "interface",
8464 "locationInModule": {
8465 "filename": "lib/custom-resource.ts",
8466 "line": 33
8467 },
8468 "methods": [
8469 {
8470 "abstract": true,
8471 "docs": {
8472 "returns": "provider configuration",
8473 "stability": "deprecated",
8474 "summary": "Called when this provider is used by a `CustomResource`."
8475 },
8476 "locationInModule": {
8477 "filename": "lib/custom-resource.ts",
8478 "line": 39
8479 },
8480 "name": "bind",
8481 "parameters": [
8482 {
8483 "docs": {
8484 "summary": "The resource that uses this provider."
8485 },
8486 "name": "scope",
8487 "type": {
8488 "fqn": "@aws-cdk/core.Construct"
8489 }
8490 }
8491 ],
8492 "returns": {
8493 "type": {
8494 "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig"
8495 }
8496 }
8497 }
8498 ],
8499 "name": "ICustomResourceProvider",
8500 "symbolId": "lib/custom-resource:ICustomResourceProvider"
8501 },
8502 "@aws-cdk/aws-cloudformation.NestedStack": {
8503 "assembly": "@aws-cdk/aws-cloudformation",
8504 "base": "@aws-cdk/core.NestedStack",
8505 "docs": {
8506 "deprecated": "use core.NestedStack instead",
8507 "remarks": "When you apply template changes to update a top-level stack, CloudFormation\nupdates the top-level stack and initiates an update to its nested stacks.\nCloudFormation updates the resources of modified nested stacks, but does not\nupdate the resources of unmodified nested stacks.\n\nFurthermore, this stack will not be treated as an independent deployment\nartifact (won't be listed in \"cdk list\" or deployable through \"cdk deploy\"),\nbut rather only synthesized as a template and uploaded as an asset to S3.\n\nCross references of resource attributes between the parent stack and the\nnested stack will automatically be translated to stack parameters and\noutputs.",
8508 "stability": "deprecated",
8509 "summary": "A CloudFormation nested stack.",
8510 "example": "class MyNestedStack extends cfn.NestedStack {\n constructor(scope: Construct, id: string, props?: cfn.NestedStackProps) {\n super(scope, id, props);\n\n new s3.Bucket(this, 'NestedBucket');\n }\n}\n\nclass MyParentStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n new MyNestedStack(this, 'Nested1');\n new MyNestedStack(this, 'Nested2');\n }\n}",
8511 "custom": {
8512 "exampleMetadata": "infused"
8513 }
8514 },
8515 "fqn": "@aws-cdk/aws-cloudformation.NestedStack",
8516 "initializer": {
8517 "docs": {
8518 "stability": "deprecated"
8519 },
8520 "locationInModule": {
8521 "filename": "lib/nested-stack.ts",
8522 "line": 70
8523 },
8524 "parameters": [
8525 {
8526 "name": "scope",
8527 "type": {
8528 "fqn": "@aws-cdk/core.Construct"
8529 }
8530 },
8531 {
8532 "name": "id",
8533 "type": {
8534 "primitive": "string"
8535 }
8536 },
8537 {
8538 "name": "props",
8539 "optional": true,
8540 "type": {
8541 "fqn": "@aws-cdk/aws-cloudformation.NestedStackProps"
8542 }
8543 }
8544 ]
8545 },
8546 "kind": "class",
8547 "locationInModule": {
8548 "filename": "lib/nested-stack.ts",
8549 "line": 69
8550 },
8551 "name": "NestedStack",
8552 "symbolId": "lib/nested-stack:NestedStack"
8553 },
8554 "@aws-cdk/aws-cloudformation.NestedStackProps": {
8555 "assembly": "@aws-cdk/aws-cloudformation",
8556 "datatype": true,
8557 "docs": {
8558 "deprecated": "use core.NestedStackProps instead",
8559 "stability": "deprecated",
8560 "summary": "Initialization props for the `NestedStack` construct.",
8561 "example": "class MyNestedStack extends cfn.NestedStack {\n constructor(scope: Construct, id: string, props?: cfn.NestedStackProps) {\n super(scope, id, props);\n\n new s3.Bucket(this, 'NestedBucket');\n }\n}\n\nclass MyParentStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n new MyNestedStack(this, 'Nested1');\n new MyNestedStack(this, 'Nested2');\n }\n}",
8562 "custom": {
8563 "exampleMetadata": "infused"
8564 }
8565 },
8566 "fqn": "@aws-cdk/aws-cloudformation.NestedStackProps",
8567 "kind": "interface",
8568 "locationInModule": {
8569 "filename": "lib/nested-stack.ts",
8570 "line": 13
8571 },
8572 "name": "NestedStackProps",
8573 "properties": [
8574 {
8575 "abstract": true,
8576 "docs": {
8577 "default": "- notifications are not sent for this stack.",
8578 "stability": "deprecated",
8579 "summary": "The Simple Notification Service (SNS) topics to publish stack related events."
8580 },
8581 "immutable": true,
8582 "locationInModule": {
8583 "filename": "lib/nested-stack.ts",
8584 "line": 48
8585 },
8586 "name": "notifications",
8587 "optional": true,
8588 "type": {
8589 "collection": {
8590 "elementtype": {
8591 "fqn": "@aws-cdk/aws-sns.ITopic"
8592 },
8593 "kind": "array"
8594 }
8595 }
8596 },
8597 {
8598 "abstract": true,
8599 "docs": {
8600 "default": "- no user-defined parameters are passed to the nested stack",
8601 "remarks": "Each parameter has a name corresponding\nto a parameter defined in the embedded template and a value representing\nthe value that you want to set for the parameter.\n\nThe nested stack construct will automatically synthesize parameters in order\nto bind references from the parent stack(s) into the nested stack.",
8602 "stability": "deprecated",
8603 "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created."
8604 },
8605 "immutable": true,
8606 "locationInModule": {
8607 "filename": "lib/nested-stack.ts",
8608 "line": 25
8609 },
8610 "name": "parameters",
8611 "optional": true,
8612 "type": {
8613 "collection": {
8614 "elementtype": {
8615 "primitive": "string"
8616 },
8617 "kind": "map"
8618 }
8619 }
8620 },
8621 {
8622 "abstract": true,
8623 "docs": {
8624 "default": "- no timeout",
8625 "remarks": "When CloudFormation detects that the nested stack has reached the\nCREATE_COMPLETE state, it marks the nested stack resource as\nCREATE_COMPLETE in the parent stack and resumes creating the parent stack.\nIf the timeout period expires before the nested stack reaches\nCREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls\nback both the nested stack and parent stack.",
8626 "stability": "deprecated",
8627 "summary": "The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state."
8628 },
8629 "immutable": true,
8630 "locationInModule": {
8631 "filename": "lib/nested-stack.ts",
8632 "line": 40
8633 },
8634 "name": "timeout",
8635 "optional": true,
8636 "type": {
8637 "fqn": "@aws-cdk/core.Duration"
8638 }
8639 }
8640 ],
8641 "symbolId": "lib/nested-stack:NestedStackProps"
8642 }
8643 },
8644 "version": "1.203.0",
8645 "fingerprint": "**********"
8646}
\No newline at end of file