.jsii
1 { 2 "author": { 3 "name": "Amazon Web Services", 4 "organization": true, 5 "roles": [ 6 "author" 7 ], 8 "url": "https://aws.amazon.com" 9 }, 10 "bundled": { 11 "semver": "^7.3.5" 12 }, 13 "dependencies": { 14 "@aws-cdk/cloud-assembly-schema": "1.121.0" 15 }, 16 "dependencyClosure": { 17 "@aws-cdk/cloud-assembly-schema": { 18 "targets": { 19 "dotnet": { 20 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", 21 "namespace": "Amazon.CDK.CloudAssembly.Schema", 22 "packageId": "Amazon.CDK.CloudAssembly.Schema" 23 }, 24 "java": { 25 "maven": { 26 "artifactId": "cdk-cloud-assembly-schema", 27 "groupId": "software.amazon.awscdk" 28 }, 29 "package": "software.amazon.awscdk.cloudassembly.schema" 30 }, 31 "js": { 32 "npm": "@aws-cdk/cloud-assembly-schema" 33 }, 34 "python": { 35 "classifiers": [ 36 "Framework :: AWS CDK", 37 "Framework :: AWS CDK :: 1" 38 ], 39 "distName": "aws-cdk.cloud-assembly-schema", 40 "module": "aws_cdk.cloud_assembly_schema" 41 } 42 } 43 } 44 }, 45 "description": "Cloud executable protocol", 46 "docs": { 47 "stability": "stable" 48 }, 49 "homepage": "https://github.com/aws/aws-cdk", 50 "jsiiVersion": "1.34.0 (build 9b72778)", 51 "keywords": [ 52 "aws", 53 "cdk" 54 ], 55 "license": "Apache-2.0", 56 "metadata": { 57 "jsii": { 58 "pacmak": { 59 "hasDefaultInterfaces": true 60 }, 61 "rosetta": { 62 "strict": true 63 } 64 } 65 }, 66 "name": "@aws-cdk/cx-api", 67 "readme": { 68 "markdown": "# Cloud Executable API\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\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" 69 }, 70 "repository": { 71 "directory": "packages/@aws-cdk/cx-api", 72 "type": "git", 73 "url": "https://github.com/aws/aws-cdk.git" 74 }, 75 "schema": "jsii/0.10.0", 76 "targets": { 77 "dotnet": { 78 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", 79 "namespace": "Amazon.CDK.CXAPI", 80 "packageId": "Amazon.CDK.CXAPI" 81 }, 82 "java": { 83 "maven": { 84 "artifactId": "cdk-cx-api", 85 "groupId": "software.amazon.awscdk" 86 }, 87 "package": "software.amazon.awscdk.cxapi" 88 }, 89 "js": { 90 "npm": "@aws-cdk/cx-api" 91 }, 92 "python": { 93 "classifiers": [ 94 "Framework :: AWS CDK", 95 "Framework :: AWS CDK :: 1" 96 ], 97 "distName": "aws-cdk.cx-api", 98 "module": "aws_cdk.cx_api" 99 } 100 }, 101 "types": { 102 "@aws-cdk/cx-api.AssemblyBuildOptions": { 103 "assembly": "@aws-cdk/cx-api", 104 "datatype": true, 105 "docs": { 106 "stability": "stable" 107 }, 108 "fqn": "@aws-cdk/cx-api.AssemblyBuildOptions", 109 "kind": "interface", 110 "locationInModule": { 111 "filename": "lib/cloud-assembly.ts", 112 "line": 416 113 }, 114 "name": "AssemblyBuildOptions", 115 "properties": [ 116 { 117 "abstract": true, 118 "docs": { 119 "default": "- if this option is not specified, runtime info will not be included", 120 "deprecated": "All template modifications that should result from this should\nhave already been inserted into the template.", 121 "stability": "deprecated", 122 "summary": "Include the specified runtime information (module versions) in manifest." 123 }, 124 "immutable": true, 125 "locationInModule": { 126 "filename": "lib/cloud-assembly.ts", 127 "line": 423 128 }, 129 "name": "runtimeInfo", 130 "optional": true, 131 "type": { 132 "fqn": "@aws-cdk/cx-api.RuntimeInfo" 133 } 134 } 135 ] 136 }, 137 "@aws-cdk/cx-api.AssetManifestArtifact": { 138 "assembly": "@aws-cdk/cx-api", 139 "base": "@aws-cdk/cx-api.CloudArtifact", 140 "docs": { 141 "stability": "stable", 142 "summary": "Asset manifest is a description of a set of assets which need to be built and published." 143 }, 144 "fqn": "@aws-cdk/cx-api.AssetManifestArtifact", 145 "initializer": { 146 "docs": { 147 "stability": "stable" 148 }, 149 "locationInModule": { 150 "filename": "lib/artifacts/asset-manifest-artifact.ts", 151 "line": 27 152 }, 153 "parameters": [ 154 { 155 "name": "assembly", 156 "type": { 157 "fqn": "@aws-cdk/cx-api.CloudAssembly" 158 } 159 }, 160 { 161 "name": "name", 162 "type": { 163 "primitive": "string" 164 } 165 }, 166 { 167 "name": "artifact", 168 "type": { 169 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 170 } 171 } 172 ] 173 }, 174 "kind": "class", 175 "locationInModule": { 176 "filename": "lib/artifacts/asset-manifest-artifact.ts", 177 "line": 9 178 }, 179 "name": "AssetManifestArtifact", 180 "properties": [ 181 { 182 "docs": { 183 "stability": "stable", 184 "summary": "The file name of the asset manifest." 185 }, 186 "immutable": true, 187 "locationInModule": { 188 "filename": "lib/artifacts/asset-manifest-artifact.ts", 189 "line": 13 190 }, 191 "name": "file", 192 "type": { 193 "primitive": "string" 194 } 195 }, 196 { 197 "docs": { 198 "stability": "stable", 199 "summary": "Version of bootstrap stack required to deploy this stack." 200 }, 201 "immutable": true, 202 "locationInModule": { 203 "filename": "lib/artifacts/asset-manifest-artifact.ts", 204 "line": 18 205 }, 206 "name": "requiresBootstrapStackVersion", 207 "type": { 208 "primitive": "number" 209 } 210 }, 211 { 212 "docs": { 213 "default": "- Discover SSM parameter by reading stack", 214 "stability": "stable", 215 "summary": "Name of SSM parameter with bootstrap stack version." 216 }, 217 "immutable": true, 218 "locationInModule": { 219 "filename": "lib/artifacts/asset-manifest-artifact.ts", 220 "line": 25 221 }, 222 "name": "bootstrapStackVersionSsmParameter", 223 "optional": true, 224 "type": { 225 "primitive": "string" 226 } 227 } 228 ] 229 }, 230 "@aws-cdk/cx-api.AwsCloudFormationStackProperties": { 231 "assembly": "@aws-cdk/cx-api", 232 "datatype": true, 233 "docs": { 234 "stability": "stable", 235 "summary": "Artifact properties for CloudFormation stacks." 236 }, 237 "fqn": "@aws-cdk/cx-api.AwsCloudFormationStackProperties", 238 "kind": "interface", 239 "locationInModule": { 240 "filename": "lib/cloud-artifact.ts", 241 "line": 8 242 }, 243 "name": "AwsCloudFormationStackProperties", 244 "properties": [ 245 { 246 "abstract": true, 247 "docs": { 248 "stability": "stable", 249 "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack." 250 }, 251 "immutable": true, 252 "locationInModule": { 253 "filename": "lib/cloud-artifact.ts", 254 "line": 12 255 }, 256 "name": "templateFile", 257 "type": { 258 "primitive": "string" 259 } 260 }, 261 { 262 "abstract": true, 263 "docs": { 264 "stability": "stable", 265 "summary": "Values for CloudFormation stack parameters that should be passed when the stack is deployed." 266 }, 267 "immutable": true, 268 "locationInModule": { 269 "filename": "lib/cloud-artifact.ts", 270 "line": 17 271 }, 272 "name": "parameters", 273 "optional": true, 274 "type": { 275 "collection": { 276 "elementtype": { 277 "primitive": "string" 278 }, 279 "kind": "map" 280 } 281 } 282 }, 283 { 284 "abstract": true, 285 "docs": { 286 "default": "- name derived from artifact ID", 287 "stability": "stable", 288 "summary": "The name to use for the CloudFormation stack." 289 }, 290 "immutable": true, 291 "locationInModule": { 292 "filename": "lib/cloud-artifact.ts", 293 "line": 23 294 }, 295 "name": "stackName", 296 "optional": true, 297 "type": { 298 "primitive": "string" 299 } 300 }, 301 { 302 "abstract": true, 303 "docs": { 304 "default": "false", 305 "stability": "stable", 306 "summary": "Whether to enable termination protection for this stack." 307 }, 308 "immutable": true, 309 "locationInModule": { 310 "filename": "lib/cloud-artifact.ts", 311 "line": 30 312 }, 313 "name": "terminationProtection", 314 "optional": true, 315 "type": { 316 "primitive": "boolean" 317 } 318 } 319 ] 320 }, 321 "@aws-cdk/cx-api.CloudArtifact": { 322 "assembly": "@aws-cdk/cx-api", 323 "docs": { 324 "stability": "stable", 325 "summary": "Represents an artifact within a cloud assembly." 326 }, 327 "fqn": "@aws-cdk/cx-api.CloudArtifact", 328 "initializer": { 329 "docs": { 330 "stability": "stable" 331 }, 332 "locationInModule": { 333 "filename": "lib/cloud-artifact.ts", 334 "line": 80 335 }, 336 "parameters": [ 337 { 338 "name": "assembly", 339 "type": { 340 "fqn": "@aws-cdk/cx-api.CloudAssembly" 341 } 342 }, 343 { 344 "name": "id", 345 "type": { 346 "primitive": "string" 347 } 348 }, 349 { 350 "name": "manifest", 351 "type": { 352 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 353 } 354 } 355 ], 356 "protected": true 357 }, 358 "kind": "class", 359 "locationInModule": { 360 "filename": "lib/cloud-artifact.ts", 361 "line": 36 362 }, 363 "methods": [ 364 { 365 "docs": { 366 "returns": "the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.", 367 "stability": "stable", 368 "summary": "Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest." 369 }, 370 "locationInModule": { 371 "filename": "lib/cloud-artifact.ts", 372 "line": 44 373 }, 374 "name": "fromManifest", 375 "parameters": [ 376 { 377 "docs": { 378 "summary": "The cloud assembly from which to load the artifact." 379 }, 380 "name": "assembly", 381 "type": { 382 "fqn": "@aws-cdk/cx-api.CloudAssembly" 383 } 384 }, 385 { 386 "docs": { 387 "summary": "The artifact ID." 388 }, 389 "name": "id", 390 "type": { 391 "primitive": "string" 392 } 393 }, 394 { 395 "docs": { 396 "summary": "The artifact manifest." 397 }, 398 "name": "artifact", 399 "type": { 400 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 401 } 402 } 403 ], 404 "returns": { 405 "optional": true, 406 "type": { 407 "fqn": "@aws-cdk/cx-api.CloudArtifact" 408 } 409 }, 410 "static": true 411 }, 412 { 413 "docs": { 414 "returns": "all the metadata entries of a specific type in this artifact.", 415 "stability": "stable" 416 }, 417 "locationInModule": { 418 "filename": "lib/cloud-artifact.ts", 419 "line": 107 420 }, 421 "name": "findMetadataByType", 422 "parameters": [ 423 { 424 "name": "type", 425 "type": { 426 "primitive": "string" 427 } 428 } 429 ], 430 "returns": { 431 "type": { 432 "collection": { 433 "elementtype": { 434 "fqn": "@aws-cdk/cx-api.MetadataEntryResult" 435 }, 436 "kind": "array" 437 } 438 } 439 } 440 } 441 ], 442 "name": "CloudArtifact", 443 "properties": [ 444 { 445 "docs": { 446 "stability": "stable" 447 }, 448 "immutable": true, 449 "locationInModule": { 450 "filename": "lib/cloud-artifact.ts", 451 "line": 80 452 }, 453 "name": "assembly", 454 "type": { 455 "fqn": "@aws-cdk/cx-api.CloudAssembly" 456 } 457 }, 458 { 459 "docs": { 460 "stability": "stable", 461 "summary": "Returns all the artifacts that this artifact depends on." 462 }, 463 "immutable": true, 464 "locationInModule": { 465 "filename": "lib/cloud-artifact.ts", 466 "line": 89 467 }, 468 "name": "dependencies", 469 "type": { 470 "collection": { 471 "elementtype": { 472 "fqn": "@aws-cdk/cx-api.CloudArtifact" 473 }, 474 "kind": "array" 475 } 476 } 477 }, 478 { 479 "docs": { 480 "remarks": "Defaults to the normal\nid. Should only be used in user interfaces.", 481 "stability": "stable", 482 "summary": "An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests." 483 }, 484 "immutable": true, 485 "locationInModule": { 486 "filename": "lib/cloud-artifact.ts", 487 "line": 151 488 }, 489 "name": "hierarchicalId", 490 "type": { 491 "primitive": "string" 492 } 493 }, 494 { 495 "docs": { 496 "stability": "stable" 497 }, 498 "immutable": true, 499 "locationInModule": { 500 "filename": "lib/cloud-artifact.ts", 501 "line": 80 502 }, 503 "name": "id", 504 "type": { 505 "primitive": "string" 506 } 507 }, 508 { 509 "docs": { 510 "stability": "stable", 511 "summary": "The artifact's manifest." 512 }, 513 "immutable": true, 514 "locationInModule": { 515 "filename": "lib/cloud-artifact.ts", 516 "line": 62 517 }, 518 "name": "manifest", 519 "type": { 520 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 521 } 522 }, 523 { 524 "docs": { 525 "stability": "stable", 526 "summary": "The set of messages extracted from the artifact's metadata." 527 }, 528 "immutable": true, 529 "locationInModule": { 530 "filename": "lib/cloud-artifact.ts", 531 "line": 67 532 }, 533 "name": "messages", 534 "type": { 535 "collection": { 536 "elementtype": { 537 "fqn": "@aws-cdk/cx-api.SynthesisMessage" 538 }, 539 "kind": "array" 540 } 541 } 542 } 543 ] 544 }, 545 "@aws-cdk/cx-api.CloudAssembly": { 546 "assembly": "@aws-cdk/cx-api", 547 "docs": { 548 "stability": "stable", 549 "summary": "Represents a deployable cloud application." 550 }, 551 "fqn": "@aws-cdk/cx-api.CloudAssembly", 552 "initializer": { 553 "docs": { 554 "stability": "stable", 555 "summary": "Reads a cloud assembly from the specified directory." 556 }, 557 "locationInModule": { 558 "filename": "lib/cloud-assembly.ts", 559 "line": 49 560 }, 561 "parameters": [ 562 { 563 "docs": { 564 "summary": "The root directory of the assembly." 565 }, 566 "name": "directory", 567 "type": { 568 "primitive": "string" 569 } 570 } 571 ] 572 }, 573 "kind": "class", 574 "locationInModule": { 575 "filename": "lib/cloud-assembly.ts", 576 "line": 19 577 }, 578 "methods": [ 579 { 580 "docs": { 581 "stability": "stable", 582 "summary": "Returns a nested assembly." 583 }, 584 "locationInModule": { 585 "filename": "lib/cloud-assembly.ts", 586 "line": 168 587 }, 588 "name": "getNestedAssembly", 589 "parameters": [ 590 { 591 "docs": { 592 "summary": "The artifact ID of the nested assembly." 593 }, 594 "name": "artifactId", 595 "type": { 596 "primitive": "string" 597 } 598 } 599 ], 600 "returns": { 601 "type": { 602 "fqn": "@aws-cdk/cx-api.CloudAssembly" 603 } 604 } 605 }, 606 { 607 "docs": { 608 "stability": "stable", 609 "summary": "Returns a nested assembly artifact." 610 }, 611 "locationInModule": { 612 "filename": "lib/cloud-assembly.ts", 613 "line": 150 614 }, 615 "name": "getNestedAssemblyArtifact", 616 "parameters": [ 617 { 618 "docs": { 619 "summary": "The artifact ID of the nested assembly." 620 }, 621 "name": "artifactId", 622 "type": { 623 "primitive": "string" 624 } 625 } 626 ], 627 "returns": { 628 "type": { 629 "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact" 630 } 631 } 632 }, 633 { 634 "docs": { 635 "deprecated": "renamed to `getStackByName` (or `getStackArtifact(id)`)", 636 "stability": "deprecated", 637 "summary": "Returns a CloudFormation stack artifact by name from this assembly." 638 }, 639 "locationInModule": { 640 "filename": "lib/cloud-assembly.ts", 641 "line": 99 642 }, 643 "name": "getStack", 644 "parameters": [ 645 { 646 "name": "stackName", 647 "type": { 648 "primitive": "string" 649 } 650 } 651 ], 652 "returns": { 653 "type": { 654 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" 655 } 656 } 657 }, 658 { 659 "docs": { 660 "custom": { 661 "throws": "if there is no stack artifact with that id" 662 }, 663 "returns": "a `CloudFormationStackArtifact` object.", 664 "stability": "stable", 665 "summary": "Returns a CloudFormation stack artifact from this assembly." 666 }, 667 "locationInModule": { 668 "filename": "lib/cloud-assembly.ts", 669 "line": 110 670 }, 671 "name": "getStackArtifact", 672 "parameters": [ 673 { 674 "docs": { 675 "summary": "the artifact id of the stack (can be obtained through `stack.artifactId`)." 676 }, 677 "name": "artifactId", 678 "type": { 679 "primitive": "string" 680 } 681 } 682 ], 683 "returns": { 684 "type": { 685 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" 686 } 687 } 688 }, 689 { 690 "docs": { 691 "custom": { 692 "throws": "if there is more than one stack with the same stack name. You can\nuse `getStackArtifact(stack.artifactId)` instead." 693 }, 694 "remarks": "Will only search the current assembly.", 695 "returns": "a `CloudFormationStackArtifact` object.", 696 "stability": "stable", 697 "summary": "Returns a CloudFormation stack artifact from this assembly." 698 }, 699 "locationInModule": { 700 "filename": "lib/cloud-assembly.ts", 701 "line": 81 702 }, 703 "name": "getStackByName", 704 "parameters": [ 705 { 706 "docs": { 707 "summary": "the name of the CloudFormation stack." 708 }, 709 "name": "stackName", 710 "type": { 711 "primitive": "string" 712 } 713 } 714 ], 715 "returns": { 716 "type": { 717 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" 718 } 719 } 720 }, 721 { 722 "docs": { 723 "custom": { 724 "throws": "if there is no metadata artifact by that name" 725 }, 726 "returns": "a `TreeCloudArtifact` object if there is one defined in the manifest, `undefined` otherwise.", 727 "stability": "stable", 728 "summary": "Returns the tree metadata artifact from this assembly." 729 }, 730 "locationInModule": { 731 "filename": "lib/cloud-assembly.ts", 732 "line": 177 733 }, 734 "name": "tree", 735 "returns": { 736 "optional": true, 737 "type": { 738 "fqn": "@aws-cdk/cx-api.TreeCloudArtifact" 739 } 740 } 741 }, 742 { 743 "docs": { 744 "returns": "A `CloudArtifact` object or `undefined` if the artifact does not exist in this assembly.", 745 "stability": "stable", 746 "summary": "Attempts to find an artifact with a specific identity." 747 }, 748 "locationInModule": { 749 "filename": "lib/cloud-assembly.ts", 750 "line": 66 751 }, 752 "name": "tryGetArtifact", 753 "parameters": [ 754 { 755 "docs": { 756 "summary": "The artifact ID." 757 }, 758 "name": "id", 759 "type": { 760 "primitive": "string" 761 } 762 } 763 ], 764 "returns": { 765 "optional": true, 766 "type": { 767 "fqn": "@aws-cdk/cx-api.CloudArtifact" 768 } 769 } 770 } 771 ], 772 "name": "CloudAssembly", 773 "properties": [ 774 { 775 "docs": { 776 "stability": "stable", 777 "summary": "All artifacts included in this assembly." 778 }, 779 "immutable": true, 780 "locationInModule": { 781 "filename": "lib/cloud-assembly.ts", 782 "line": 33 783 }, 784 "name": "artifacts", 785 "type": { 786 "collection": { 787 "elementtype": { 788 "fqn": "@aws-cdk/cx-api.CloudArtifact" 789 }, 790 "kind": "array" 791 } 792 } 793 }, 794 { 795 "docs": { 796 "stability": "stable", 797 "summary": "The root directory of the cloud assembly." 798 }, 799 "immutable": true, 800 "locationInModule": { 801 "filename": "lib/cloud-assembly.ts", 802 "line": 23 803 }, 804 "name": "directory", 805 "type": { 806 "primitive": "string" 807 } 808 }, 809 { 810 "docs": { 811 "stability": "stable", 812 "summary": "The raw assembly manifest." 813 }, 814 "immutable": true, 815 "locationInModule": { 816 "filename": "lib/cloud-assembly.ts", 817 "line": 43 818 }, 819 "name": "manifest", 820 "type": { 821 "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest" 822 } 823 }, 824 { 825 "docs": { 826 "stability": "stable", 827 "summary": "The nested assembly artifacts in this assembly." 828 }, 829 "immutable": true, 830 "locationInModule": { 831 "filename": "lib/cloud-assembly.ts", 832 "line": 207 833 }, 834 "name": "nestedAssemblies", 835 "type": { 836 "collection": { 837 "elementtype": { 838 "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact" 839 }, 840 "kind": "array" 841 } 842 } 843 }, 844 { 845 "docs": { 846 "stability": "stable", 847 "summary": "Runtime information such as module versions used to synthesize this assembly." 848 }, 849 "immutable": true, 850 "locationInModule": { 851 "filename": "lib/cloud-assembly.ts", 852 "line": 38 853 }, 854 "name": "runtime", 855 "type": { 856 "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo" 857 } 858 }, 859 { 860 "docs": { 861 "returns": "all the CloudFormation stack artifacts that are included in this assembly.", 862 "stability": "stable" 863 }, 864 "immutable": true, 865 "locationInModule": { 866 "filename": "lib/cloud-assembly.ts", 867 "line": 196 868 }, 869 "name": "stacks", 870 "type": { 871 "collection": { 872 "elementtype": { 873 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" 874 }, 875 "kind": "array" 876 } 877 } 878 }, 879 { 880 "docs": { 881 "stability": "stable", 882 "summary": "Returns all the stacks, including the ones in nested assemblies." 883 }, 884 "immutable": true, 885 "locationInModule": { 886 "filename": "lib/cloud-assembly.ts", 887 "line": 131 888 }, 889 "name": "stacksRecursively", 890 "type": { 891 "collection": { 892 "elementtype": { 893 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" 894 }, 895 "kind": "array" 896 } 897 } 898 }, 899 { 900 "docs": { 901 "stability": "stable", 902 "summary": "The schema version of the assembly manifest." 903 }, 904 "immutable": true, 905 "locationInModule": { 906 "filename": "lib/cloud-assembly.ts", 907 "line": 28 908 }, 909 "name": "version", 910 "type": { 911 "primitive": "string" 912 } 913 } 914 ] 915 }, 916 "@aws-cdk/cx-api.CloudAssemblyBuilder": { 917 "assembly": "@aws-cdk/cx-api", 918 "docs": { 919 "stability": "stable", 920 "summary": "Can be used to build a cloud assembly." 921 }, 922 "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder", 923 "initializer": { 924 "docs": { 925 "stability": "stable", 926 "summary": "Initializes a cloud assembly builder." 927 }, 928 "locationInModule": { 929 "filename": "lib/cloud-assembly.ts", 930 "line": 275 931 }, 932 "parameters": [ 933 { 934 "docs": { 935 "summary": "The output directory, uses temporary directory if undefined." 936 }, 937 "name": "outdir", 938 "optional": true, 939 "type": { 940 "primitive": "string" 941 } 942 }, 943 { 944 "name": "props", 945 "optional": true, 946 "type": { 947 "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilderProps" 948 } 949 } 950 ] 951 }, 952 "kind": "class", 953 "locationInModule": { 954 "filename": "lib/cloud-assembly.ts", 955 "line": 256 956 }, 957 "methods": [ 958 { 959 "docs": { 960 "stability": "stable", 961 "summary": "Adds an artifact into the cloud assembly." 962 }, 963 "locationInModule": { 964 "filename": "lib/cloud-assembly.ts", 965 "line": 292 966 }, 967 "name": "addArtifact", 968 "parameters": [ 969 { 970 "docs": { 971 "summary": "The ID of the artifact." 972 }, 973 "name": "id", 974 "type": { 975 "primitive": "string" 976 } 977 }, 978 { 979 "docs": { 980 "summary": "The artifact manifest." 981 }, 982 "name": "manifest", 983 "type": { 984 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 985 } 986 } 987 ] 988 }, 989 { 990 "docs": { 991 "stability": "stable", 992 "summary": "Reports that some context is missing in order for this cloud assembly to be fully synthesized." 993 }, 994 "locationInModule": { 995 "filename": "lib/cloud-assembly.ts", 996 "line": 300 997 }, 998 "name": "addMissing", 999 "parameters": [ 1000 { 1001 "docs": { 1002 "summary": "Missing context information." 1003 }, 1004 "name": "missing", 1005 "type": { 1006 "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext" 1007 } 1008 } 1009 ] 1010 }, 1011 { 1012 "docs": { 1013 "stability": "stable", 1014 "summary": "Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly." 1015 }, 1016 "locationInModule": { 1017 "filename": "lib/cloud-assembly.ts", 1018 "line": 313 1019 }, 1020 "name": "buildAssembly", 1021 "parameters": [ 1022 { 1023 "name": "options", 1024 "optional": true, 1025 "type": { 1026 "fqn": "@aws-cdk/cx-api.AssemblyBuildOptions" 1027 } 1028 } 1029 ], 1030 "returns": { 1031 "type": { 1032 "fqn": "@aws-cdk/cx-api.CloudAssembly" 1033 } 1034 } 1035 }, 1036 { 1037 "docs": { 1038 "stability": "stable", 1039 "summary": "Creates a nested cloud assembly." 1040 }, 1041 "locationInModule": { 1042 "filename": "lib/cloud-assembly.ts", 1043 "line": 341 1044 }, 1045 "name": "createNestedAssembly", 1046 "parameters": [ 1047 { 1048 "name": "artifactId", 1049 "type": { 1050 "primitive": "string" 1051 } 1052 }, 1053 { 1054 "name": "displayName", 1055 "type": { 1056 "primitive": "string" 1057 } 1058 } 1059 ], 1060 "returns": { 1061 "type": { 1062 "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder" 1063 } 1064 } 1065 } 1066 ], 1067 "name": "CloudAssemblyBuilder", 1068 "properties": [ 1069 { 1070 "docs": { 1071 "stability": "stable", 1072 "summary": "The directory where assets of this Cloud Assembly should be stored." 1073 }, 1074 "immutable": true, 1075 "locationInModule": { 1076 "filename": "lib/cloud-assembly.ts", 1077 "line": 265 1078 }, 1079 "name": "assetOutdir", 1080 "type": { 1081 "primitive": "string" 1082 } 1083 }, 1084 { 1085 "docs": { 1086 "stability": "stable", 1087 "summary": "The root directory of the resulting cloud assembly." 1088 }, 1089 "immutable": true, 1090 "locationInModule": { 1091 "filename": "lib/cloud-assembly.ts", 1092 "line": 260 1093 }, 1094 "name": "outdir", 1095 "type": { 1096 "primitive": "string" 1097 } 1098 } 1099 ] 1100 }, 1101 "@aws-cdk/cx-api.CloudAssemblyBuilderProps": { 1102 "assembly": "@aws-cdk/cx-api", 1103 "datatype": true, 1104 "docs": { 1105 "stability": "stable", 1106 "summary": "Construction properties for CloudAssemblyBuilder." 1107 }, 1108 "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilderProps", 1109 "kind": "interface", 1110 "locationInModule": { 1111 "filename": "lib/cloud-assembly.ts", 1112 "line": 237 1113 }, 1114 "name": "CloudAssemblyBuilderProps", 1115 "properties": [ 1116 { 1117 "abstract": true, 1118 "docs": { 1119 "default": "- Same as the manifest outdir", 1120 "stability": "stable", 1121 "summary": "Use the given asset output directory." 1122 }, 1123 "immutable": true, 1124 "locationInModule": { 1125 "filename": "lib/cloud-assembly.ts", 1126 "line": 243 1127 }, 1128 "name": "assetOutdir", 1129 "optional": true, 1130 "type": { 1131 "primitive": "string" 1132 } 1133 }, 1134 { 1135 "abstract": true, 1136 "docs": { 1137 "default": "- This is a root assembly", 1138 "stability": "stable", 1139 "summary": "If this builder is for a nested assembly, the parent assembly builder." 1140 }, 1141 "immutable": true, 1142 "locationInModule": { 1143 "filename": "lib/cloud-assembly.ts", 1144 "line": 250 1145 }, 1146 "name": "parentBuilder", 1147 "optional": true, 1148 "type": { 1149 "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder" 1150 } 1151 } 1152 ] 1153 }, 1154 "@aws-cdk/cx-api.CloudFormationStackArtifact": { 1155 "assembly": "@aws-cdk/cx-api", 1156 "base": "@aws-cdk/cx-api.CloudArtifact", 1157 "docs": { 1158 "stability": "stable" 1159 }, 1160 "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact", 1161 "initializer": { 1162 "docs": { 1163 "stability": "stable" 1164 }, 1165 "locationInModule": { 1166 "filename": "lib/artifacts/cloudformation-artifact.ts", 1167 "line": 113 1168 }, 1169 "parameters": [ 1170 { 1171 "name": "assembly", 1172 "type": { 1173 "fqn": "@aws-cdk/cx-api.CloudAssembly" 1174 } 1175 }, 1176 { 1177 "name": "artifactId", 1178 "type": { 1179 "primitive": "string" 1180 } 1181 }, 1182 { 1183 "name": "artifact", 1184 "type": { 1185 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 1186 } 1187 } 1188 ] 1189 }, 1190 "kind": "class", 1191 "locationInModule": { 1192 "filename": "lib/artifacts/cloudformation-artifact.ts", 1193 "line": 8 1194 }, 1195 "name": "CloudFormationStackArtifact", 1196 "properties": [ 1197 { 1198 "docs": { 1199 "stability": "stable", 1200 "summary": "Any assets associated with this stack." 1201 }, 1202 "immutable": true, 1203 "locationInModule": { 1204 "filename": "lib/artifacts/cloudformation-artifact.ts", 1205 "line": 22 1206 }, 1207 "name": "assets", 1208 "type": { 1209 "collection": { 1210 "elementtype": { 1211 "union": { 1212 "types": [ 1213 { 1214 "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry" 1215 }, 1216 { 1217 "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry" 1218 } 1219 ] 1220 } 1221 }, 1222 "kind": "array" 1223 } 1224 } 1225 }, 1226 { 1227 "docs": { 1228 "remarks": "Should only be used in user interfaces.\nIf the stackName and artifactId are the same, it will just return that. Otherwise,\nit will return something like \"<artifactId> (<stackName>)\"", 1229 "stability": "stable", 1230 "summary": "A string that represents this stack." 1231 }, 1232 "immutable": true, 1233 "locationInModule": { 1234 "filename": "lib/artifacts/cloudformation-artifact.ts", 1235 "line": 44 1236 }, 1237 "name": "displayName", 1238 "type": { 1239 "primitive": "string" 1240 } 1241 }, 1242 { 1243 "docs": { 1244 "stability": "stable", 1245 "summary": "The environment into which to deploy this artifact." 1246 }, 1247 "immutable": true, 1248 "locationInModule": { 1249 "filename": "lib/artifacts/cloudformation-artifact.ts", 1250 "line": 55 1251 }, 1252 "name": "environment", 1253 "type": { 1254 "fqn": "@aws-cdk/cx-api.Environment" 1255 } 1256 }, 1257 { 1258 "docs": { 1259 "deprecated": "renamed to `stackName`", 1260 "stability": "deprecated", 1261 "summary": "The physical name of this stack." 1262 }, 1263 "immutable": true, 1264 "locationInModule": { 1265 "filename": "lib/artifacts/cloudformation-artifact.ts", 1266 "line": 50 1267 }, 1268 "name": "name", 1269 "type": { 1270 "primitive": "string" 1271 } 1272 }, 1273 { 1274 "docs": { 1275 "stability": "stable", 1276 "summary": "The original name as defined in the CDK app." 1277 }, 1278 "immutable": true, 1279 "locationInModule": { 1280 "filename": "lib/artifacts/cloudformation-artifact.ts", 1281 "line": 17 1282 }, 1283 "name": "originalName", 1284 "type": { 1285 "primitive": "string" 1286 } 1287 }, 1288 { 1289 "docs": { 1290 "stability": "stable", 1291 "summary": "CloudFormation parameters to pass to the stack." 1292 }, 1293 "immutable": true, 1294 "locationInModule": { 1295 "filename": "lib/artifacts/cloudformation-artifact.ts", 1296 "line": 27 1297 }, 1298 "name": "parameters", 1299 "type": { 1300 "collection": { 1301 "elementtype": { 1302 "primitive": "string" 1303 }, 1304 "kind": "map" 1305 } 1306 } 1307 }, 1308 { 1309 "docs": { 1310 "stability": "stable", 1311 "summary": "The physical name of this stack." 1312 }, 1313 "immutable": true, 1314 "locationInModule": { 1315 "filename": "lib/artifacts/cloudformation-artifact.ts", 1316 "line": 37 1317 }, 1318 "name": "stackName", 1319 "type": { 1320 "primitive": "string" 1321 } 1322 }, 1323 { 1324 "docs": { 1325 "stability": "stable", 1326 "summary": "CloudFormation tags to pass to the stack." 1327 }, 1328 "immutable": true, 1329 "locationInModule": { 1330 "filename": "lib/artifacts/cloudformation-artifact.ts", 1331 "line": 32 1332 }, 1333 "name": "tags", 1334 "type": { 1335 "collection": { 1336 "elementtype": { 1337 "primitive": "string" 1338 }, 1339 "kind": "map" 1340 } 1341 } 1342 }, 1343 { 1344 "docs": { 1345 "stability": "stable", 1346 "summary": "The CloudFormation template for this stack." 1347 }, 1348 "immutable": true, 1349 "locationInModule": { 1350 "filename": "lib/artifacts/cloudformation-artifact.ts", 1351 "line": 160 1352 }, 1353 "name": "template", 1354 "type": { 1355 "primitive": "any" 1356 } 1357 }, 1358 { 1359 "docs": { 1360 "stability": "stable", 1361 "summary": "The file name of the template." 1362 }, 1363 "immutable": true, 1364 "locationInModule": { 1365 "filename": "lib/artifacts/cloudformation-artifact.ts", 1366 "line": 12 1367 }, 1368 "name": "templateFile", 1369 "type": { 1370 "primitive": "string" 1371 } 1372 }, 1373 { 1374 "docs": { 1375 "stability": "stable", 1376 "summary": "Full path to the template file." 1377 }, 1378 "immutable": true, 1379 "locationInModule": { 1380 "filename": "lib/artifacts/cloudformation-artifact.ts", 1381 "line": 153 1382 }, 1383 "name": "templateFullPath", 1384 "type": { 1385 "primitive": "string" 1386 } 1387 }, 1388 { 1389 "docs": { 1390 "default": "- No role is assumed (current credentials are used)", 1391 "stability": "stable", 1392 "summary": "The role that needs to be assumed to deploy the stack." 1393 }, 1394 "immutable": true, 1395 "locationInModule": { 1396 "filename": "lib/artifacts/cloudformation-artifact.ts", 1397 "line": 62 1398 }, 1399 "name": "assumeRoleArn", 1400 "optional": true, 1401 "type": { 1402 "primitive": "string" 1403 } 1404 }, 1405 { 1406 "docs": { 1407 "default": "- No external ID", 1408 "stability": "stable", 1409 "summary": "External ID to use when assuming role for cloudformation deployments." 1410 }, 1411 "immutable": true, 1412 "locationInModule": { 1413 "filename": "lib/artifacts/cloudformation-artifact.ts", 1414 "line": 69 1415 }, 1416 "name": "assumeRoleExternalId", 1417 "optional": true, 1418 "type": { 1419 "primitive": "string" 1420 } 1421 }, 1422 { 1423 "docs": { 1424 "default": "- Discover SSM parameter by reading stack", 1425 "stability": "stable", 1426 "summary": "Name of SSM parameter with bootstrap stack version." 1427 }, 1428 "immutable": true, 1429 "locationInModule": { 1430 "filename": "lib/artifacts/cloudformation-artifact.ts", 1431 "line": 97 1432 }, 1433 "name": "bootstrapStackVersionSsmParameter", 1434 "optional": true, 1435 "type": { 1436 "primitive": "string" 1437 } 1438 }, 1439 { 1440 "docs": { 1441 "default": "- No role is passed (currently assumed role/credentials are used)", 1442 "stability": "stable", 1443 "summary": "The role that is passed to CloudFormation to execute the change set." 1444 }, 1445 "immutable": true, 1446 "locationInModule": { 1447 "filename": "lib/artifacts/cloudformation-artifact.ts", 1448 "line": 76 1449 }, 1450 "name": "cloudFormationExecutionRoleArn", 1451 "optional": true, 1452 "type": { 1453 "primitive": "string" 1454 } 1455 }, 1456 { 1457 "docs": { 1458 "default": "- No bootstrap stack required", 1459 "stability": "stable", 1460 "summary": "Version of bootstrap stack required to deploy this stack." 1461 }, 1462 "immutable": true, 1463 "locationInModule": { 1464 "filename": "lib/artifacts/cloudformation-artifact.ts", 1465 "line": 90 1466 }, 1467 "name": "requiresBootstrapStackVersion", 1468 "optional": true, 1469 "type": { 1470 "primitive": "number" 1471 } 1472 }, 1473 { 1474 "docs": { 1475 "default": "- Not uploaded yet, upload just before deploying", 1476 "stability": "stable", 1477 "summary": "If the stack template has already been included in the asset manifest, its asset URL." 1478 }, 1479 "immutable": true, 1480 "locationInModule": { 1481 "filename": "lib/artifacts/cloudformation-artifact.ts", 1482 "line": 83 1483 }, 1484 "name": "stackTemplateAssetObjectUrl", 1485 "optional": true, 1486 "type": { 1487 "primitive": "string" 1488 } 1489 }, 1490 { 1491 "docs": { 1492 "stability": "stable", 1493 "summary": "Whether termination protection is enabled for this stack." 1494 }, 1495 "immutable": true, 1496 "locationInModule": { 1497 "filename": "lib/artifacts/cloudformation-artifact.ts", 1498 "line": 102 1499 }, 1500 "name": "terminationProtection", 1501 "optional": true, 1502 "type": { 1503 "primitive": "boolean" 1504 } 1505 }, 1506 { 1507 "docs": { 1508 "default": "- false", 1509 "stability": "stable", 1510 "summary": "Whether this stack should be validated by the CLI after synthesis." 1511 }, 1512 "immutable": true, 1513 "locationInModule": { 1514 "filename": "lib/artifacts/cloudformation-artifact.ts", 1515 "line": 109 1516 }, 1517 "name": "validateOnSynth", 1518 "optional": true, 1519 "type": { 1520 "primitive": "boolean" 1521 } 1522 } 1523 ] 1524 }, 1525 "@aws-cdk/cx-api.EndpointServiceAvailabilityZonesContextQuery": { 1526 "assembly": "@aws-cdk/cx-api", 1527 "datatype": true, 1528 "docs": { 1529 "stability": "stable", 1530 "summary": "Query to hosted zone context provider." 1531 }, 1532 "fqn": "@aws-cdk/cx-api.EndpointServiceAvailabilityZonesContextQuery", 1533 "kind": "interface", 1534 "locationInModule": { 1535 "filename": "lib/context/endpoint-service-availability-zones.ts", 1536 "line": 6 1537 }, 1538 "name": "EndpointServiceAvailabilityZonesContextQuery", 1539 "properties": [ 1540 { 1541 "abstract": true, 1542 "docs": { 1543 "stability": "stable", 1544 "summary": "Query account." 1545 }, 1546 "immutable": true, 1547 "locationInModule": { 1548 "filename": "lib/context/endpoint-service-availability-zones.ts", 1549 "line": 10 1550 }, 1551 "name": "account", 1552 "optional": true, 1553 "type": { 1554 "primitive": "string" 1555 } 1556 }, 1557 { 1558 "abstract": true, 1559 "docs": { 1560 "stability": "stable", 1561 "summary": "Query region." 1562 }, 1563 "immutable": true, 1564 "locationInModule": { 1565 "filename": "lib/context/endpoint-service-availability-zones.ts", 1566 "line": 15 1567 }, 1568 "name": "region", 1569 "optional": true, 1570 "type": { 1571 "primitive": "string" 1572 } 1573 }, 1574 { 1575 "abstract": true, 1576 "docs": { 1577 "stability": "stable", 1578 "summary": "Query service name." 1579 }, 1580 "immutable": true, 1581 "locationInModule": { 1582 "filename": "lib/context/endpoint-service-availability-zones.ts", 1583 "line": 20 1584 }, 1585 "name": "serviceName", 1586 "optional": true, 1587 "type": { 1588 "primitive": "string" 1589 } 1590 } 1591 ] 1592 }, 1593 "@aws-cdk/cx-api.Environment": { 1594 "assembly": "@aws-cdk/cx-api", 1595 "datatype": true, 1596 "docs": { 1597 "stability": "stable", 1598 "summary": "Models an AWS execution environment, for use within the CDK toolkit." 1599 }, 1600 "fqn": "@aws-cdk/cx-api.Environment", 1601 "kind": "interface", 1602 "locationInModule": { 1603 "filename": "lib/environment.ts", 1604 "line": 11 1605 }, 1606 "name": "Environment", 1607 "properties": [ 1608 { 1609 "abstract": true, 1610 "docs": { 1611 "stability": "stable", 1612 "summary": "The AWS account this environment deploys into." 1613 }, 1614 "immutable": true, 1615 "locationInModule": { 1616 "filename": "lib/environment.ts", 1617 "line": 16 1618 }, 1619 "name": "account", 1620 "type": { 1621 "primitive": "string" 1622 } 1623 }, 1624 { 1625 "abstract": true, 1626 "docs": { 1627 "stability": "stable", 1628 "summary": "The arbitrary name of this environment (user-set, or at least user-meaningful)." 1629 }, 1630 "immutable": true, 1631 "locationInModule": { 1632 "filename": "lib/environment.ts", 1633 "line": 13 1634 }, 1635 "name": "name", 1636 "type": { 1637 "primitive": "string" 1638 } 1639 }, 1640 { 1641 "abstract": true, 1642 "docs": { 1643 "stability": "stable", 1644 "summary": "The AWS region name where this environment deploys into." 1645 }, 1646 "immutable": true, 1647 "locationInModule": { 1648 "filename": "lib/environment.ts", 1649 "line": 19 1650 }, 1651 "name": "region", 1652 "type": { 1653 "primitive": "string" 1654 } 1655 } 1656 ] 1657 }, 1658 "@aws-cdk/cx-api.EnvironmentPlaceholderValues": { 1659 "assembly": "@aws-cdk/cx-api", 1660 "datatype": true, 1661 "docs": { 1662 "stability": "stable", 1663 "summary": "Return the appropriate values for the environment placeholders." 1664 }, 1665 "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholderValues", 1666 "kind": "interface", 1667 "locationInModule": { 1668 "filename": "lib/placeholders.ts", 1669 "line": 81 1670 }, 1671 "name": "EnvironmentPlaceholderValues", 1672 "properties": [ 1673 { 1674 "abstract": true, 1675 "docs": { 1676 "stability": "stable", 1677 "summary": "Return the account." 1678 }, 1679 "immutable": true, 1680 "locationInModule": { 1681 "filename": "lib/placeholders.ts", 1682 "line": 90 1683 }, 1684 "name": "accountId", 1685 "type": { 1686 "primitive": "string" 1687 } 1688 }, 1689 { 1690 "abstract": true, 1691 "docs": { 1692 "stability": "stable", 1693 "summary": "Return the partition." 1694 }, 1695 "immutable": true, 1696 "locationInModule": { 1697 "filename": "lib/placeholders.ts", 1698 "line": 95 1699 }, 1700 "name": "partition", 1701 "type": { 1702 "primitive": "string" 1703 } 1704 }, 1705 { 1706 "abstract": true, 1707 "docs": { 1708 "stability": "stable", 1709 "summary": "Return the region." 1710 }, 1711 "immutable": true, 1712 "locationInModule": { 1713 "filename": "lib/placeholders.ts", 1714 "line": 85 1715 }, 1716 "name": "region", 1717 "type": { 1718 "primitive": "string" 1719 } 1720 } 1721 ] 1722 }, 1723 "@aws-cdk/cx-api.EnvironmentPlaceholders": { 1724 "assembly": "@aws-cdk/cx-api", 1725 "docs": { 1726 "remarks": "These can occur both in the Asset Manifest as well as the general\nCloud Assembly manifest.", 1727 "stability": "stable", 1728 "summary": "Placeholders which can be used manifests." 1729 }, 1730 "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholders", 1731 "initializer": { 1732 "docs": { 1733 "stability": "stable" 1734 } 1735 }, 1736 "kind": "class", 1737 "locationInModule": { 1738 "filename": "lib/placeholders.ts", 1739 "line": 7 1740 }, 1741 "methods": [ 1742 { 1743 "docs": { 1744 "remarks": "Duplicated between cdk-assets and aws-cdk CLI because we don't have a good single place to put it\n(they're nominally independent tools).", 1745 "stability": "stable", 1746 "summary": "Replace the environment placeholders in all strings found in a complex object." 1747 }, 1748 "locationInModule": { 1749 "filename": "lib/placeholders.ts", 1750 "line": 29 1751 }, 1752 "name": "replace", 1753 "parameters": [ 1754 { 1755 "name": "object", 1756 "type": { 1757 "primitive": "any" 1758 } 1759 }, 1760 { 1761 "name": "values", 1762 "type": { 1763 "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholderValues" 1764 } 1765 } 1766 ], 1767 "returns": { 1768 "type": { 1769 "primitive": "any" 1770 } 1771 }, 1772 "static": true 1773 }, 1774 { 1775 "async": true, 1776 "docs": { 1777 "stability": "stable", 1778 "summary": "Like 'replace', but asynchronous." 1779 }, 1780 "locationInModule": { 1781 "filename": "lib/placeholders.ts", 1782 "line": 41 1783 }, 1784 "name": "replaceAsync", 1785 "parameters": [ 1786 { 1787 "name": "object", 1788 "type": { 1789 "primitive": "any" 1790 } 1791 }, 1792 { 1793 "name": "provider", 1794 "type": { 1795 "fqn": "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider" 1796 } 1797 } 1798 ], 1799 "returns": { 1800 "type": { 1801 "primitive": "any" 1802 } 1803 }, 1804 "static": true 1805 } 1806 ], 1807 "name": "EnvironmentPlaceholders", 1808 "properties": [ 1809 { 1810 "const": true, 1811 "docs": { 1812 "stability": "stable", 1813 "summary": "Insert this into the destination fields to be replaced with the current account." 1814 }, 1815 "immutable": true, 1816 "locationInModule": { 1817 "filename": "lib/placeholders.ts", 1818 "line": 16 1819 }, 1820 "name": "CURRENT_ACCOUNT", 1821 "static": true, 1822 "type": { 1823 "primitive": "string" 1824 } 1825 }, 1826 { 1827 "const": true, 1828 "docs": { 1829 "stability": "stable", 1830 "summary": "Insert this into the destination fields to be replaced with the current partition." 1831 }, 1832 "immutable": true, 1833 "locationInModule": { 1834 "filename": "lib/placeholders.ts", 1835 "line": 21 1836 }, 1837 "name": "CURRENT_PARTITION", 1838 "static": true, 1839 "type": { 1840 "primitive": "string" 1841 } 1842 }, 1843 { 1844 "const": true, 1845 "docs": { 1846 "stability": "stable", 1847 "summary": "Insert this into the destination fields to be replaced with the current region." 1848 }, 1849 "immutable": true, 1850 "locationInModule": { 1851 "filename": "lib/placeholders.ts", 1852 "line": 11 1853 }, 1854 "name": "CURRENT_REGION", 1855 "static": true, 1856 "type": { 1857 "primitive": "string" 1858 } 1859 } 1860 ] 1861 }, 1862 "@aws-cdk/cx-api.EnvironmentUtils": { 1863 "assembly": "@aws-cdk/cx-api", 1864 "docs": { 1865 "stability": "stable" 1866 }, 1867 "fqn": "@aws-cdk/cx-api.EnvironmentUtils", 1868 "initializer": { 1869 "docs": { 1870 "stability": "stable" 1871 } 1872 }, 1873 "kind": "class", 1874 "locationInModule": { 1875 "filename": "lib/environment.ts", 1876 "line": 25 1877 }, 1878 "methods": [ 1879 { 1880 "docs": { 1881 "stability": "stable", 1882 "summary": "Format an environment string from an account and region." 1883 }, 1884 "locationInModule": { 1885 "filename": "lib/environment.ts", 1886 "line": 52 1887 }, 1888 "name": "format", 1889 "parameters": [ 1890 { 1891 "name": "account", 1892 "type": { 1893 "primitive": "string" 1894 } 1895 }, 1896 { 1897 "name": "region", 1898 "type": { 1899 "primitive": "string" 1900 } 1901 } 1902 ], 1903 "returns": { 1904 "type": { 1905 "primitive": "string" 1906 } 1907 }, 1908 "static": true 1909 }, 1910 { 1911 "docs": { 1912 "stability": "stable", 1913 "summary": "Build an environment object from an account and region." 1914 }, 1915 "locationInModule": { 1916 "filename": "lib/environment.ts", 1917 "line": 45 1918 }, 1919 "name": "make", 1920 "parameters": [ 1921 { 1922 "name": "account", 1923 "type": { 1924 "primitive": "string" 1925 } 1926 }, 1927 { 1928 "name": "region", 1929 "type": { 1930 "primitive": "string" 1931 } 1932 } 1933 ], 1934 "returns": { 1935 "type": { 1936 "fqn": "@aws-cdk/cx-api.Environment" 1937 } 1938 }, 1939 "static": true 1940 }, 1941 { 1942 "docs": { 1943 "stability": "stable" 1944 }, 1945 "locationInModule": { 1946 "filename": "lib/environment.ts", 1947 "line": 26 1948 }, 1949 "name": "parse", 1950 "parameters": [ 1951 { 1952 "name": "environment", 1953 "type": { 1954 "primitive": "string" 1955 } 1956 } 1957 ], 1958 "returns": { 1959 "type": { 1960 "fqn": "@aws-cdk/cx-api.Environment" 1961 } 1962 }, 1963 "static": true 1964 } 1965 ], 1966 "name": "EnvironmentUtils" 1967 }, 1968 "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider": { 1969 "assembly": "@aws-cdk/cx-api", 1970 "docs": { 1971 "stability": "stable", 1972 "summary": "Return the appropriate values for the environment placeholders." 1973 }, 1974 "fqn": "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider", 1975 "kind": "interface", 1976 "locationInModule": { 1977 "filename": "lib/placeholders.ts", 1978 "line": 101 1979 }, 1980 "methods": [ 1981 { 1982 "abstract": true, 1983 "async": true, 1984 "docs": { 1985 "stability": "stable", 1986 "summary": "Return the account." 1987 }, 1988 "locationInModule": { 1989 "filename": "lib/placeholders.ts", 1990 "line": 110 1991 }, 1992 "name": "accountId", 1993 "returns": { 1994 "type": { 1995 "primitive": "string" 1996 } 1997 } 1998 }, 1999 { 2000 "abstract": true, 2001 "async": true, 2002 "docs": { 2003 "stability": "stable", 2004 "summary": "Return the partition." 2005 }, 2006 "locationInModule": { 2007 "filename": "lib/placeholders.ts", 2008 "line": 115 2009 }, 2010 "name": "partition", 2011 "returns": { 2012 "type": { 2013 "primitive": "string" 2014 } 2015 } 2016 }, 2017 { 2018 "abstract": true, 2019 "async": true, 2020 "docs": { 2021 "stability": "stable", 2022 "summary": "Return the region." 2023 }, 2024 "locationInModule": { 2025 "filename": "lib/placeholders.ts", 2026 "line": 105 2027 }, 2028 "name": "region", 2029 "returns": { 2030 "type": { 2031 "primitive": "string" 2032 } 2033 } 2034 } 2035 ], 2036 "name": "IEnvironmentPlaceholderProvider" 2037 }, 2038 "@aws-cdk/cx-api.LoadBalancerContextResponse": { 2039 "assembly": "@aws-cdk/cx-api", 2040 "datatype": true, 2041 "docs": { 2042 "stability": "stable", 2043 "summary": "Properties of a discovered load balancer." 2044 }, 2045 "fqn": "@aws-cdk/cx-api.LoadBalancerContextResponse", 2046 "kind": "interface", 2047 "locationInModule": { 2048 "filename": "lib/context/load-balancer.ts", 2049 "line": 19 2050 }, 2051 "name": "LoadBalancerContextResponse", 2052 "properties": [ 2053 { 2054 "abstract": true, 2055 "docs": { 2056 "stability": "stable", 2057 "summary": "Type of IP address." 2058 }, 2059 "immutable": true, 2060 "locationInModule": { 2061 "filename": "lib/context/load-balancer.ts", 2062 "line": 38 2063 }, 2064 "name": "ipAddressType", 2065 "type": { 2066 "fqn": "@aws-cdk/cx-api.LoadBalancerIpAddressType" 2067 } 2068 }, 2069 { 2070 "abstract": true, 2071 "docs": { 2072 "stability": "stable", 2073 "summary": "The ARN of the load balancer." 2074 }, 2075 "immutable": true, 2076 "locationInModule": { 2077 "filename": "lib/context/load-balancer.ts", 2078 "line": 23 2079 }, 2080 "name": "loadBalancerArn", 2081 "type": { 2082 "primitive": "string" 2083 } 2084 }, 2085 { 2086 "abstract": true, 2087 "docs": { 2088 "stability": "stable", 2089 "summary": "The hosted zone ID of the load balancer's name." 2090 }, 2091 "immutable": true, 2092 "locationInModule": { 2093 "filename": "lib/context/load-balancer.ts", 2094 "line": 28 2095 }, 2096 "name": "loadBalancerCanonicalHostedZoneId", 2097 "type": { 2098 "primitive": "string" 2099 } 2100 }, 2101 { 2102 "abstract": true, 2103 "docs": { 2104 "stability": "stable", 2105 "summary": "Load balancer's DNS name." 2106 }, 2107 "immutable": true, 2108 "locationInModule": { 2109 "filename": "lib/context/load-balancer.ts", 2110 "line": 33 2111 }, 2112 "name": "loadBalancerDnsName", 2113 "type": { 2114 "primitive": "string" 2115 } 2116 }, 2117 { 2118 "abstract": true, 2119 "docs": { 2120 "stability": "stable", 2121 "summary": "Load balancer's security groups." 2122 }, 2123 "immutable": true, 2124 "locationInModule": { 2125 "filename": "lib/context/load-balancer.ts", 2126 "line": 43 2127 }, 2128 "name": "securityGroupIds", 2129 "type": { 2130 "collection": { 2131 "elementtype": { 2132 "primitive": "string" 2133 }, 2134 "kind": "array" 2135 } 2136 } 2137 }, 2138 { 2139 "abstract": true, 2140 "docs": { 2141 "stability": "stable", 2142 "summary": "Load balancer's VPC." 2143 }, 2144 "immutable": true, 2145 "locationInModule": { 2146 "filename": "lib/context/load-balancer.ts", 2147 "line": 48 2148 }, 2149 "name": "vpcId", 2150 "type": { 2151 "primitive": "string" 2152 } 2153 } 2154 ] 2155 }, 2156 "@aws-cdk/cx-api.LoadBalancerIpAddressType": { 2157 "assembly": "@aws-cdk/cx-api", 2158 "docs": { 2159 "stability": "stable", 2160 "summary": "Load balancer ip address type." 2161 }, 2162 "fqn": "@aws-cdk/cx-api.LoadBalancerIpAddressType", 2163 "kind": "enum", 2164 "locationInModule": { 2165 "filename": "lib/context/load-balancer.ts", 2166 "line": 4 2167 }, 2168 "members": [ 2169 { 2170 "docs": { 2171 "stability": "stable", 2172 "summary": "IPV4 ip address." 2173 }, 2174 "name": "IPV4" 2175 }, 2176 { 2177 "docs": { 2178 "stability": "stable", 2179 "summary": "Dual stack address." 2180 }, 2181 "name": "DUAL_STACK" 2182 } 2183 ], 2184 "name": "LoadBalancerIpAddressType" 2185 }, 2186 "@aws-cdk/cx-api.LoadBalancerListenerContextResponse": { 2187 "assembly": "@aws-cdk/cx-api", 2188 "datatype": true, 2189 "docs": { 2190 "stability": "stable", 2191 "summary": "Properties of a discovered load balancer listener." 2192 }, 2193 "fqn": "@aws-cdk/cx-api.LoadBalancerListenerContextResponse", 2194 "kind": "interface", 2195 "locationInModule": { 2196 "filename": "lib/context/load-balancer.ts", 2197 "line": 54 2198 }, 2199 "name": "LoadBalancerListenerContextResponse", 2200 "properties": [ 2201 { 2202 "abstract": true, 2203 "docs": { 2204 "stability": "stable", 2205 "summary": "The ARN of the listener." 2206 }, 2207 "immutable": true, 2208 "locationInModule": { 2209 "filename": "lib/context/load-balancer.ts", 2210 "line": 58 2211 }, 2212 "name": "listenerArn", 2213 "type": { 2214 "primitive": "string" 2215 } 2216 }, 2217 { 2218 "abstract": true, 2219 "docs": { 2220 "stability": "stable", 2221 "summary": "The port the listener is listening on." 2222 }, 2223 "immutable": true, 2224 "locationInModule": { 2225 "filename": "lib/context/load-balancer.ts", 2226 "line": 63 2227 }, 2228 "name": "listenerPort", 2229 "type": { 2230 "primitive": "number" 2231 } 2232 }, 2233 { 2234 "abstract": true, 2235 "docs": { 2236 "stability": "stable", 2237 "summary": "The security groups of the load balancer." 2238 }, 2239 "immutable": true, 2240 "locationInModule": { 2241 "filename": "lib/context/load-balancer.ts", 2242 "line": 68 2243 }, 2244 "name": "securityGroupIds", 2245 "type": { 2246 "collection": { 2247 "elementtype": { 2248 "primitive": "string" 2249 }, 2250 "kind": "array" 2251 } 2252 } 2253 } 2254 ] 2255 }, 2256 "@aws-cdk/cx-api.MetadataEntry": { 2257 "assembly": "@aws-cdk/cx-api", 2258 "datatype": true, 2259 "docs": { 2260 "custom": { 2261 "aws-cdk": "/core library." 2262 }, 2263 "deprecated": "moved to package 'cloud-assembly-schema'", 2264 "remarks": "This is necessary because its used as an input in the stable", 2265 "see": "core.ConstructNode.metadata", 2266 "stability": "deprecated", 2267 "summary": "Backwards compatibility for when `MetadataEntry` was defined here." 2268 }, 2269 "fqn": "@aws-cdk/cx-api.MetadataEntry", 2270 "interfaces": [ 2271 "@aws-cdk/cloud-assembly-schema.MetadataEntry" 2272 ], 2273 "kind": "interface", 2274 "locationInModule": { 2275 "filename": "lib/cloud-assembly.ts", 2276 "line": 381 2277 }, 2278 "name": "MetadataEntry" 2279 }, 2280 "@aws-cdk/cx-api.MetadataEntryResult": { 2281 "assembly": "@aws-cdk/cx-api", 2282 "datatype": true, 2283 "docs": { 2284 "stability": "stable" 2285 }, 2286 "fqn": "@aws-cdk/cx-api.MetadataEntryResult", 2287 "interfaces": [ 2288 "@aws-cdk/cloud-assembly-schema.MetadataEntry" 2289 ], 2290 "kind": "interface", 2291 "locationInModule": { 2292 "filename": "lib/metadata.ts", 2293 "line": 14 2294 }, 2295 "name": "MetadataEntryResult", 2296 "properties": [ 2297 { 2298 "abstract": true, 2299 "docs": { 2300 "stability": "stable", 2301 "summary": "The path in which this entry was defined." 2302 }, 2303 "immutable": true, 2304 "locationInModule": { 2305 "filename": "lib/metadata.ts", 2306 "line": 18 2307 }, 2308 "name": "path", 2309 "type": { 2310 "primitive": "string" 2311 } 2312 } 2313 ] 2314 }, 2315 "@aws-cdk/cx-api.MissingContext": { 2316 "assembly": "@aws-cdk/cx-api", 2317 "datatype": true, 2318 "docs": { 2319 "custom": { 2320 "aws-cdk": "/core library." 2321 }, 2322 "deprecated": "moved to package 'cloud-assembly-schema'", 2323 "remarks": "This is necessary because its used as an input in the stable", 2324 "see": "core.Stack.reportMissingContext", 2325 "stability": "deprecated", 2326 "summary": "Backwards compatibility for when `MissingContext` was defined here." 2327 }, 2328 "fqn": "@aws-cdk/cx-api.MissingContext", 2329 "kind": "interface", 2330 "locationInModule": { 2331 "filename": "lib/cloud-assembly.ts", 2332 "line": 393 2333 }, 2334 "name": "MissingContext", 2335 "properties": [ 2336 { 2337 "abstract": true, 2338 "docs": { 2339 "stability": "deprecated", 2340 "summary": "The missing context key." 2341 }, 2342 "immutable": true, 2343 "locationInModule": { 2344 "filename": "lib/cloud-assembly.ts", 2345 "line": 397 2346 }, 2347 "name": "key", 2348 "type": { 2349 "primitive": "string" 2350 } 2351 }, 2352 { 2353 "abstract": true, 2354 "docs": { 2355 "remarks": "(This is the old untyped definition, which is necessary for backwards compatibility.\nSee cxschema for a type definition.)", 2356 "stability": "deprecated", 2357 "summary": "A set of provider-specific options." 2358 }, 2359 "immutable": true, 2360 "locationInModule": { 2361 "filename": "lib/cloud-assembly.ts", 2362 "line": 413 2363 }, 2364 "name": "props", 2365 "type": { 2366 "collection": { 2367 "elementtype": { 2368 "primitive": "any" 2369 }, 2370 "kind": "map" 2371 } 2372 } 2373 }, 2374 { 2375 "abstract": true, 2376 "docs": { 2377 "remarks": "(This is the old untyped definition, which is necessary for backwards compatibility.\nSee cxschema for a type definition.)", 2378 "stability": "deprecated", 2379 "summary": "The provider from which we expect this context key to be obtained." 2380 }, 2381 "immutable": true, 2382 "locationInModule": { 2383 "filename": "lib/cloud-assembly.ts", 2384 "line": 405 2385 }, 2386 "name": "provider", 2387 "type": { 2388 "primitive": "string" 2389 } 2390 } 2391 ] 2392 }, 2393 "@aws-cdk/cx-api.NestedCloudAssemblyArtifact": { 2394 "assembly": "@aws-cdk/cx-api", 2395 "base": "@aws-cdk/cx-api.CloudArtifact", 2396 "docs": { 2397 "stability": "stable", 2398 "summary": "Asset manifest is a description of a set of assets which need to be built and published." 2399 }, 2400 "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact", 2401 "initializer": { 2402 "docs": { 2403 "stability": "stable" 2404 }, 2405 "locationInModule": { 2406 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2407 "line": 25 2408 }, 2409 "parameters": [ 2410 { 2411 "name": "assembly", 2412 "type": { 2413 "fqn": "@aws-cdk/cx-api.CloudAssembly" 2414 } 2415 }, 2416 { 2417 "name": "name", 2418 "type": { 2419 "primitive": "string" 2420 } 2421 }, 2422 { 2423 "name": "artifact", 2424 "type": { 2425 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 2426 } 2427 } 2428 ] 2429 }, 2430 "kind": "class", 2431 "locationInModule": { 2432 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2433 "line": 9 2434 }, 2435 "name": "NestedCloudAssemblyArtifact", 2436 "properties": [ 2437 { 2438 "docs": { 2439 "stability": "stable", 2440 "summary": "The relative directory name of the asset manifest." 2441 }, 2442 "immutable": true, 2443 "locationInModule": { 2444 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2445 "line": 13 2446 }, 2447 "name": "directoryName", 2448 "type": { 2449 "primitive": "string" 2450 } 2451 }, 2452 { 2453 "docs": { 2454 "stability": "stable", 2455 "summary": "Display name." 2456 }, 2457 "immutable": true, 2458 "locationInModule": { 2459 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2460 "line": 18 2461 }, 2462 "name": "displayName", 2463 "type": { 2464 "primitive": "string" 2465 } 2466 }, 2467 { 2468 "docs": { 2469 "stability": "stable", 2470 "summary": "Full path to the nested assembly directory." 2471 }, 2472 "immutable": true, 2473 "locationInModule": { 2474 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2475 "line": 36 2476 }, 2477 "name": "fullPath", 2478 "type": { 2479 "primitive": "string" 2480 } 2481 }, 2482 { 2483 "docs": { 2484 "stability": "stable", 2485 "summary": "The nested Assembly." 2486 }, 2487 "immutable": true, 2488 "locationInModule": { 2489 "filename": "lib/artifacts/nested-cloud-assembly-artifact.ts", 2490 "line": 43 2491 }, 2492 "name": "nestedAssembly", 2493 "type": { 2494 "fqn": "@aws-cdk/cx-api.CloudAssembly" 2495 } 2496 } 2497 ] 2498 }, 2499 "@aws-cdk/cx-api.RuntimeInfo": { 2500 "assembly": "@aws-cdk/cx-api", 2501 "datatype": true, 2502 "docs": { 2503 "custom": { 2504 "aws-cdk": "/core library." 2505 }, 2506 "deprecated": "moved to package 'cloud-assembly-schema'", 2507 "remarks": "This is necessary because its used as an input in the stable", 2508 "see": "core.ConstructNode.synth", 2509 "stability": "deprecated", 2510 "summary": "Backwards compatibility for when `RuntimeInfo` was defined here." 2511 }, 2512 "fqn": "@aws-cdk/cx-api.RuntimeInfo", 2513 "interfaces": [ 2514 "@aws-cdk/cloud-assembly-schema.RuntimeInfo" 2515 ], 2516 "kind": "interface", 2517 "locationInModule": { 2518 "filename": "lib/cloud-assembly.ts", 2519 "line": 369 2520 }, 2521 "name": "RuntimeInfo" 2522 }, 2523 "@aws-cdk/cx-api.SecurityGroupContextResponse": { 2524 "assembly": "@aws-cdk/cx-api", 2525 "datatype": true, 2526 "docs": { 2527 "stability": "stable", 2528 "summary": "Properties of a discovered SecurityGroup." 2529 }, 2530 "fqn": "@aws-cdk/cx-api.SecurityGroupContextResponse", 2531 "kind": "interface", 2532 "locationInModule": { 2533 "filename": "lib/context/security-group.ts", 2534 "line": 5 2535 }, 2536 "name": "SecurityGroupContextResponse", 2537 "properties": [ 2538 { 2539 "abstract": true, 2540 "docs": { 2541 "remarks": "This will be true\nwhen the security group has all-protocol egress permissions to access both\n`0.0.0.0/0` and `::/0`.", 2542 "stability": "stable", 2543 "summary": "Whether the security group allows all outbound traffic." 2544 }, 2545 "immutable": true, 2546 "locationInModule": { 2547 "filename": "lib/context/security-group.ts", 2548 "line": 16 2549 }, 2550 "name": "allowAllOutbound", 2551 "type": { 2552 "primitive": "boolean" 2553 } 2554 }, 2555 { 2556 "abstract": true, 2557 "docs": { 2558 "stability": "stable", 2559 "summary": "The security group's id." 2560 }, 2561 "immutable": true, 2562 "locationInModule": { 2563 "filename": "lib/context/security-group.ts", 2564 "line": 9 2565 }, 2566 "name": "securityGroupId", 2567 "type": { 2568 "primitive": "string" 2569 } 2570 } 2571 ] 2572 }, 2573 "@aws-cdk/cx-api.SynthesisMessage": { 2574 "assembly": "@aws-cdk/cx-api", 2575 "datatype": true, 2576 "docs": { 2577 "stability": "stable" 2578 }, 2579 "fqn": "@aws-cdk/cx-api.SynthesisMessage", 2580 "kind": "interface", 2581 "locationInModule": { 2582 "filename": "lib/metadata.ts", 2583 "line": 26 2584 }, 2585 "name": "SynthesisMessage", 2586 "properties": [ 2587 { 2588 "abstract": true, 2589 "docs": { 2590 "stability": "stable" 2591 }, 2592 "immutable": true, 2593 "locationInModule": { 2594 "filename": "lib/metadata.ts", 2595 "line": 29 2596 }, 2597 "name": "entry", 2598 "type": { 2599 "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry" 2600 } 2601 }, 2602 { 2603 "abstract": true, 2604 "docs": { 2605 "stability": "stable" 2606 }, 2607 "immutable": true, 2608 "locationInModule": { 2609 "filename": "lib/metadata.ts", 2610 "line": 28 2611 }, 2612 "name": "id", 2613 "type": { 2614 "primitive": "string" 2615 } 2616 }, 2617 { 2618 "abstract": true, 2619 "docs": { 2620 "stability": "stable" 2621 }, 2622 "immutable": true, 2623 "locationInModule": { 2624 "filename": "lib/metadata.ts", 2625 "line": 27 2626 }, 2627 "name": "level", 2628 "type": { 2629 "fqn": "@aws-cdk/cx-api.SynthesisMessageLevel" 2630 } 2631 } 2632 ] 2633 }, 2634 "@aws-cdk/cx-api.SynthesisMessageLevel": { 2635 "assembly": "@aws-cdk/cx-api", 2636 "docs": { 2637 "stability": "stable" 2638 }, 2639 "fqn": "@aws-cdk/cx-api.SynthesisMessageLevel", 2640 "kind": "enum", 2641 "locationInModule": { 2642 "filename": "lib/metadata.ts", 2643 "line": 8 2644 }, 2645 "members": [ 2646 { 2647 "docs": { 2648 "stability": "stable" 2649 }, 2650 "name": "INFO" 2651 }, 2652 { 2653 "docs": { 2654 "stability": "stable" 2655 }, 2656 "name": "WARNING" 2657 }, 2658 { 2659 "docs": { 2660 "stability": "stable" 2661 }, 2662 "name": "ERROR" 2663 } 2664 ], 2665 "name": "SynthesisMessageLevel" 2666 }, 2667 "@aws-cdk/cx-api.TreeCloudArtifact": { 2668 "assembly": "@aws-cdk/cx-api", 2669 "base": "@aws-cdk/cx-api.CloudArtifact", 2670 "docs": { 2671 "stability": "stable" 2672 }, 2673 "fqn": "@aws-cdk/cx-api.TreeCloudArtifact", 2674 "initializer": { 2675 "docs": { 2676 "stability": "stable" 2677 }, 2678 "locationInModule": { 2679 "filename": "lib/artifacts/tree-cloud-artifact.ts", 2680 "line": 8 2681 }, 2682 "parameters": [ 2683 { 2684 "name": "assembly", 2685 "type": { 2686 "fqn": "@aws-cdk/cx-api.CloudAssembly" 2687 } 2688 }, 2689 { 2690 "name": "name", 2691 "type": { 2692 "primitive": "string" 2693 } 2694 }, 2695 { 2696 "name": "artifact", 2697 "type": { 2698 "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" 2699 } 2700 } 2701 ] 2702 }, 2703 "kind": "class", 2704 "locationInModule": { 2705 "filename": "lib/artifacts/tree-cloud-artifact.ts", 2706 "line": 5 2707 }, 2708 "name": "TreeCloudArtifact", 2709 "properties": [ 2710 { 2711 "docs": { 2712 "stability": "stable" 2713 }, 2714 "immutable": true, 2715 "locationInModule": { 2716 "filename": "lib/artifacts/tree-cloud-artifact.ts", 2717 "line": 6 2718 }, 2719 "name": "file", 2720 "type": { 2721 "primitive": "string" 2722 } 2723 } 2724 ] 2725 }, 2726 "@aws-cdk/cx-api.VpcContextResponse": { 2727 "assembly": "@aws-cdk/cx-api", 2728 "datatype": true, 2729 "docs": { 2730 "stability": "stable", 2731 "summary": "Properties of a discovered VPC." 2732 }, 2733 "fqn": "@aws-cdk/cx-api.VpcContextResponse", 2734 "kind": "interface", 2735 "locationInModule": { 2736 "filename": "lib/context/vpc.ts", 2737 "line": 67 2738 }, 2739 "name": "VpcContextResponse", 2740 "properties": [ 2741 { 2742 "abstract": true, 2743 "docs": { 2744 "stability": "stable", 2745 "summary": "AZs." 2746 }, 2747 "immutable": true, 2748 "locationInModule": { 2749 "filename": "lib/context/vpc.ts", 2750 "line": 84 2751 }, 2752 "name": "availabilityZones", 2753 "type": { 2754 "collection": { 2755 "elementtype": { 2756 "primitive": "string" 2757 }, 2758 "kind": "array" 2759 } 2760 } 2761 }, 2762 { 2763 "abstract": true, 2764 "docs": { 2765 "stability": "stable", 2766 "summary": "VPC id." 2767 }, 2768 "immutable": true, 2769 "locationInModule": { 2770 "filename": "lib/context/vpc.ts", 2771 "line": 72 2772 }, 2773 "name": "vpcId", 2774 "type": { 2775 "primitive": "string" 2776 } 2777 }, 2778 { 2779 "abstract": true, 2780 "docs": { 2781 "remarks": "Element count: #(availabilityZones) · #(isolatedGroups)", 2782 "stability": "stable", 2783 "summary": "IDs of all isolated subnets." 2784 }, 2785 "immutable": true, 2786 "locationInModule": { 2787 "filename": "lib/context/vpc.ts", 2788 "line": 133 2789 }, 2790 "name": "isolatedSubnetIds", 2791 "optional": true, 2792 "type": { 2793 "collection": { 2794 "elementtype": { 2795 "primitive": "string" 2796 }, 2797 "kind": "array" 2798 } 2799 } 2800 }, 2801 { 2802 "abstract": true, 2803 "docs": { 2804 "remarks": "Element count: #(isolatedGroups)", 2805 "stability": "stable", 2806 "summary": "Name of isolated subnet groups." 2807 }, 2808 "immutable": true, 2809 "locationInModule": { 2810 "filename": "lib/context/vpc.ts", 2811 "line": 140 2812 }, 2813 "name": "isolatedSubnetNames", 2814 "optional": true, 2815 "type": { 2816 "collection": { 2817 "elementtype": { 2818 "primitive": "string" 2819 }, 2820 "kind": "array" 2821 } 2822 } 2823 }, 2824 { 2825 "abstract": true, 2826 "docs": { 2827 "remarks": "Element count: #(availabilityZones) · #(isolatedGroups)", 2828 "stability": "stable", 2829 "summary": "Route Table IDs of isolated subnet groups." 2830 }, 2831 "immutable": true, 2832 "locationInModule": { 2833 "filename": "lib/context/vpc.ts", 2834 "line": 147 2835 }, 2836 "name": "isolatedSubnetRouteTableIds", 2837 "optional": true, 2838 "type": { 2839 "collection": { 2840 "elementtype": { 2841 "primitive": "string" 2842 }, 2843 "kind": "array" 2844 } 2845 } 2846 }, 2847 { 2848 "abstract": true, 2849 "docs": { 2850 "remarks": "Element count: #(availabilityZones) · #(privateGroups)", 2851 "stability": "stable", 2852 "summary": "IDs of all private subnets." 2853 }, 2854 "immutable": true, 2855 "locationInModule": { 2856 "filename": "lib/context/vpc.ts", 2857 "line": 112 2858 }, 2859 "name": "privateSubnetIds", 2860 "optional": true, 2861 "type": { 2862 "collection": { 2863 "elementtype": { 2864 "primitive": "string" 2865 }, 2866 "kind": "array" 2867 } 2868 } 2869 }, 2870 { 2871 "abstract": true, 2872 "docs": { 2873 "remarks": "Element count: #(privateGroups)", 2874 "stability": "stable", 2875 "summary": "Name of private subnet groups." 2876 }, 2877 "immutable": true, 2878 "locationInModule": { 2879 "filename": "lib/context/vpc.ts", 2880 "line": 119 2881 }, 2882 "name": "privateSubnetNames", 2883 "optional": true, 2884 "type": { 2885 "collection": { 2886 "elementtype": { 2887 "primitive": "string" 2888 }, 2889 "kind": "array" 2890 } 2891 } 2892 }, 2893 { 2894 "abstract": true, 2895 "docs": { 2896 "remarks": "Element count: #(availabilityZones) · #(privateGroups)", 2897 "stability": "stable", 2898 "summary": "Route Table IDs of private subnet groups." 2899 }, 2900 "immutable": true, 2901 "locationInModule": { 2902 "filename": "lib/context/vpc.ts", 2903 "line": 126 2904 }, 2905 "name": "privateSubnetRouteTableIds", 2906 "optional": true, 2907 "type": { 2908 "collection": { 2909 "elementtype": { 2910 "primitive": "string" 2911 }, 2912 "kind": "array" 2913 } 2914 } 2915 }, 2916 { 2917 "abstract": true, 2918 "docs": { 2919 "remarks": "Element count: #(availabilityZones) · #(publicGroups)", 2920 "stability": "stable", 2921 "summary": "IDs of all public subnets." 2922 }, 2923 "immutable": true, 2924 "locationInModule": { 2925 "filename": "lib/context/vpc.ts", 2926 "line": 91 2927 }, 2928 "name": "publicSubnetIds", 2929 "optional": true, 2930 "type": { 2931 "collection": { 2932 "elementtype": { 2933 "primitive": "string" 2934 }, 2935 "kind": "array" 2936 } 2937 } 2938 }, 2939 { 2940 "abstract": true, 2941 "docs": { 2942 "remarks": "Element count: #(publicGroups)", 2943 "stability": "stable", 2944 "summary": "Name of public subnet groups." 2945 }, 2946 "immutable": true, 2947 "locationInModule": { 2948 "filename": "lib/context/vpc.ts", 2949 "line": 98 2950 }, 2951 "name": "publicSubnetNames", 2952 "optional": true, 2953 "type": { 2954 "collection": { 2955 "elementtype": { 2956 "primitive": "string" 2957 }, 2958 "kind": "array" 2959 } 2960 } 2961 }, 2962 { 2963 "abstract": true, 2964 "docs": { 2965 "remarks": "Element count: #(availabilityZones) · #(publicGroups)", 2966 "stability": "stable", 2967 "summary": "Route Table IDs of public subnet groups." 2968 }, 2969 "immutable": true, 2970 "locationInModule": { 2971 "filename": "lib/context/vpc.ts", 2972 "line": 105 2973 }, 2974 "name": "publicSubnetRouteTableIds", 2975 "optional": true, 2976 "type": { 2977 "collection": { 2978 "elementtype": { 2979 "primitive": "string" 2980 }, 2981 "kind": "array" 2982 } 2983 } 2984 }, 2985 { 2986 "abstract": true, 2987 "docs": { 2988 "default": "- no subnet groups will be returned unless {@link VpcContextQuery.returnAsymmetricSubnets} is true", 2989 "remarks": "Unlike the above properties, this will include asymmetric subnets,\nif the VPC has any.\nThis property will only be populated if {@link VpcContextQuery.returnAsymmetricSubnets}\nis true.", 2990 "stability": "stable", 2991 "summary": "The subnet groups discovered for the given VPC." 2992 }, 2993 "immutable": true, 2994 "locationInModule": { 2995 "filename": "lib/context/vpc.ts", 2996 "line": 163 2997 }, 2998 "name": "subnetGroups", 2999 "optional": true, 3000 "type": { 3001 "collection": { 3002 "elementtype": { 3003 "fqn": "@aws-cdk/cx-api.VpcSubnetGroup" 3004 }, 3005 "kind": "array" 3006 } 3007 } 3008 }, 3009 { 3010 "abstract": true, 3011 "docs": { 3012 "default": "- CIDR information not available", 3013 "stability": "stable", 3014 "summary": "VPC cidr." 3015 }, 3016 "immutable": true, 3017 "locationInModule": { 3018 "filename": "lib/context/vpc.ts", 3019 "line": 79 3020 }, 3021 "name": "vpcCidrBlock", 3022 "optional": true, 3023 "type": { 3024 "primitive": "string" 3025 } 3026 }, 3027 { 3028 "abstract": true, 3029 "docs": { 3030 "stability": "stable", 3031 "summary": "The VPN gateway ID." 3032 }, 3033 "immutable": true, 3034 "locationInModule": { 3035 "filename": "lib/context/vpc.ts", 3036 "line": 152 3037 }, 3038 "name": "vpnGatewayId", 3039 "optional": true, 3040 "type": { 3041 "primitive": "string" 3042 } 3043 } 3044 ] 3045 }, 3046 "@aws-cdk/cx-api.VpcSubnet": { 3047 "assembly": "@aws-cdk/cx-api", 3048 "datatype": true, 3049 "docs": { 3050 "stability": "stable", 3051 "summary": "A subnet representation that the VPC provider uses." 3052 }, 3053 "fqn": "@aws-cdk/cx-api.VpcSubnet", 3054 "kind": "interface", 3055 "locationInModule": { 3056 "filename": "lib/context/vpc.ts", 3057 "line": 20 3058 }, 3059 "name": "VpcSubnet", 3060 "properties": [ 3061 { 3062 "abstract": true, 3063 "docs": { 3064 "stability": "stable", 3065 "summary": "The code of the availability zone this subnet is in (for example, 'us-west-2a')." 3066 }, 3067 "immutable": true, 3068 "locationInModule": { 3069 "filename": "lib/context/vpc.ts", 3070 "line": 28 3071 }, 3072 "name": "availabilityZone", 3073 "type": { 3074 "primitive": "string" 3075 } 3076 }, 3077 { 3078 "abstract": true, 3079 "docs": { 3080 "stability": "stable", 3081 "summary": "The identifier of the route table for this subnet." 3082 }, 3083 "immutable": true, 3084 "locationInModule": { 3085 "filename": "lib/context/vpc.ts", 3086 "line": 31 3087 }, 3088 "name": "routeTableId", 3089 "type": { 3090 "primitive": "string" 3091 } 3092 }, 3093 { 3094 "abstract": true, 3095 "docs": { 3096 "stability": "stable", 3097 "summary": "The identifier of the subnet." 3098 }, 3099 "immutable": true, 3100 "locationInModule": { 3101 "filename": "lib/context/vpc.ts", 3102 "line": 22 3103 }, 3104 "name": "subnetId", 3105 "type": { 3106 "primitive": "string" 3107 } 3108 }, 3109 { 3110 "abstract": true, 3111 "docs": { 3112 "default": "- CIDR information not available", 3113 "stability": "stable", 3114 "summary": "CIDR range of the subnet." 3115 }, 3116 "immutable": true, 3117 "locationInModule": { 3118 "filename": "lib/context/vpc.ts", 3119 "line": 38 3120 }, 3121 "name": "cidr", 3122 "optional": true, 3123 "type": { 3124 "primitive": "string" 3125 } 3126 } 3127 ] 3128 }, 3129 "@aws-cdk/cx-api.VpcSubnetGroup": { 3130 "assembly": "@aws-cdk/cx-api", 3131 "datatype": true, 3132 "docs": { 3133 "remarks": "The included subnets do NOT have to be symmetric!", 3134 "stability": "stable", 3135 "summary": "A group of subnets returned by the VPC provider." 3136 }, 3137 "fqn": "@aws-cdk/cx-api.VpcSubnetGroup", 3138 "kind": "interface", 3139 "locationInModule": { 3140 "filename": "lib/context/vpc.ts", 3141 "line": 45 3142 }, 3143 "name": "VpcSubnetGroup", 3144 "properties": [ 3145 { 3146 "abstract": true, 3147 "docs": { 3148 "stability": "stable", 3149 "summary": "The name of the subnet group, determined by looking at the tags of of the subnets that belong to it." 3150 }, 3151 "immutable": true, 3152 "locationInModule": { 3153 "filename": "lib/context/vpc.ts", 3154 "line": 51 3155 }, 3156 "name": "name", 3157 "type": { 3158 "primitive": "string" 3159 } 3160 }, 3161 { 3162 "abstract": true, 3163 "docs": { 3164 "remarks": "There is no condition that the subnets have to be symmetric\nin the group.", 3165 "stability": "stable", 3166 "summary": "The subnets that are part of this group." 3167 }, 3168 "immutable": true, 3169 "locationInModule": { 3170 "filename": "lib/context/vpc.ts", 3171 "line": 61 3172 }, 3173 "name": "subnets", 3174 "type": { 3175 "collection": { 3176 "elementtype": { 3177 "fqn": "@aws-cdk/cx-api.VpcSubnet" 3178 }, 3179 "kind": "array" 3180 } 3181 } 3182 }, 3183 { 3184 "abstract": true, 3185 "docs": { 3186 "stability": "stable", 3187 "summary": "The type of the subnet group." 3188 }, 3189 "immutable": true, 3190 "locationInModule": { 3191 "filename": "lib/context/vpc.ts", 3192 "line": 54 3193 }, 3194 "name": "type", 3195 "type": { 3196 "fqn": "@aws-cdk/cx-api.VpcSubnetGroupType" 3197 } 3198 } 3199 ] 3200 }, 3201 "@aws-cdk/cx-api.VpcSubnetGroupType": { 3202 "assembly": "@aws-cdk/cx-api", 3203 "docs": { 3204 "remarks": "Same as SubnetType in the @aws-cdk/aws-ec2 package,\nbut we can't use that because of cyclical dependencies.", 3205 "stability": "stable", 3206 "summary": "The type of subnet group." 3207 }, 3208 "fqn": "@aws-cdk/cx-api.VpcSubnetGroupType", 3209 "kind": "enum", 3210 "locationInModule": { 3211 "filename": "lib/context/vpc.ts", 3212 "line": 6 3213 }, 3214 "members": [ 3215 { 3216 "docs": { 3217 "stability": "stable", 3218 "summary": "Public subnet group type." 3219 }, 3220 "name": "PUBLIC" 3221 }, 3222 { 3223 "docs": { 3224 "stability": "stable", 3225 "summary": "Private subnet group type." 3226 }, 3227 "name": "PRIVATE" 3228 }, 3229 { 3230 "docs": { 3231 "stability": "stable", 3232 "summary": "Isolated subnet group type." 3233 }, 3234 "name": "ISOLATED" 3235 } 3236 ], 3237 "name": "VpcSubnetGroupType" 3238 } 3239 }, 3240 "version": "1.121.0", 3241 "fingerprint": "p2pd1ZB549zhJ7l3t/skK+nKfQWezCuORjh06szdAgo=" 3242 }