@aws-cdk/cloud-assembly-schema 1.132.0 → 1.133.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -16,7 +16,7 @@
16
16
  "stability": "stable"
17
17
  },
18
18
  "homepage": "https://github.com/aws/aws-cdk",
19
- "jsiiVersion": "1.42.0 (build 5f6b62c)",
19
+ "jsiiVersion": "1.45.0 (build 61747b6)",
20
20
  "keywords": [
21
21
  "aws",
22
22
  "cdk"
@@ -24,6 +24,7 @@
24
24
  "license": "Apache-2.0",
25
25
  "metadata": {
26
26
  "jsii": {
27
+ "compiledWithDeprecationWarnings": true,
27
28
  "pacmak": {
28
29
  "hasDefaultInterfaces": true
29
30
  },
@@ -73,7 +74,8 @@
73
74
  "datatype": true,
74
75
  "docs": {
75
76
  "stability": "stable",
76
- "summary": "Query to AMI context provider."
77
+ "summary": "Query to AMI context provider.",
78
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst amiContextQuery: cloud_assembly_schema.AmiContextQuery = {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n};"
77
79
  },
78
80
  "fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
79
81
  "kind": "interface",
@@ -125,22 +127,6 @@
125
127
  }
126
128
  }
127
129
  },
128
- {
129
- "abstract": true,
130
- "docs": {
131
- "stability": "stable",
132
- "summary": "Region to query."
133
- },
134
- "immutable": true,
135
- "locationInModule": {
136
- "filename": "lib/cloud-assembly/context-queries.ts",
137
- "line": 70
138
- },
139
- "name": "region",
140
- "type": {
141
- "primitive": "string"
142
- }
143
- },
144
130
  {
145
131
  "abstract": true,
146
132
  "docs": {
@@ -181,6 +167,22 @@
181
167
  "kind": "array"
182
168
  }
183
169
  }
170
+ },
171
+ {
172
+ "abstract": true,
173
+ "docs": {
174
+ "stability": "stable",
175
+ "summary": "Region to query."
176
+ },
177
+ "immutable": true,
178
+ "locationInModule": {
179
+ "filename": "lib/cloud-assembly/context-queries.ts",
180
+ "line": 70
181
+ },
182
+ "name": "region",
183
+ "type": {
184
+ "primitive": "string"
185
+ }
184
186
  }
185
187
  ],
186
188
  "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
@@ -190,7 +192,8 @@
190
192
  "datatype": true,
191
193
  "docs": {
192
194
  "stability": "stable",
193
- "summary": "A manifest for a single artifact within the cloud assembly."
195
+ "summary": "A manifest for a single artifact within the cloud assembly.",
196
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n};"
194
197
  },
195
198
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
196
199
  "kind": "interface",
@@ -200,22 +203,6 @@
200
203
  },
201
204
  "name": "ArtifactManifest",
202
205
  "properties": [
203
- {
204
- "abstract": true,
205
- "docs": {
206
- "stability": "stable",
207
- "summary": "The type of artifact."
208
- },
209
- "immutable": true,
210
- "locationInModule": {
211
- "filename": "lib/cloud-assembly/schema.ts",
212
- "line": 72
213
- },
214
- "name": "type",
215
- "type": {
216
- "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
217
- }
218
- },
219
206
  {
220
207
  "abstract": true,
221
208
  "docs": {
@@ -336,6 +323,22 @@
336
323
  ]
337
324
  }
338
325
  }
326
+ },
327
+ {
328
+ "abstract": true,
329
+ "docs": {
330
+ "stability": "stable",
331
+ "summary": "The type of artifact."
332
+ },
333
+ "immutable": true,
334
+ "locationInModule": {
335
+ "filename": "lib/cloud-assembly/schema.ts",
336
+ "line": 72
337
+ },
338
+ "name": "type",
339
+ "type": {
340
+ "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
341
+ }
339
342
  }
340
343
  ],
341
344
  "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
@@ -415,9 +418,9 @@
415
418
  {
416
419
  "docs": {
417
420
  "stability": "stable",
418
- "summary": "Stub required because of JSII."
421
+ "summary": "Manifest for all assets in the Cloud Assembly."
419
422
  },
420
- "name": "NONE"
423
+ "name": "ASSET_MANIFEST"
421
424
  },
422
425
  {
423
426
  "docs": {
@@ -436,16 +439,16 @@
436
439
  {
437
440
  "docs": {
438
441
  "stability": "stable",
439
- "summary": "Manifest for all assets in the Cloud Assembly."
442
+ "summary": "Nested Cloud Assembly."
440
443
  },
441
- "name": "ASSET_MANIFEST"
444
+ "name": "NESTED_CLOUD_ASSEMBLY"
442
445
  },
443
446
  {
444
447
  "docs": {
445
448
  "stability": "stable",
446
- "summary": "Nested Cloud Assembly."
449
+ "summary": "Stub required because of JSII."
447
450
  },
448
- "name": "NESTED_CLOUD_ASSEMBLY"
451
+ "name": "NONE"
449
452
  }
450
453
  ],
451
454
  "name": "ArtifactType",
@@ -456,7 +459,8 @@
456
459
  "datatype": true,
457
460
  "docs": {
458
461
  "stability": "stable",
459
- "summary": "A manifest which describes the cloud assembly."
462
+ "summary": "A manifest which describes the cloud assembly.",
463
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n version: 'version',\n\n // the properties below are optional\n artifacts: {\n artifactsKey: {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n },\n },\n missing: [{\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n }],\n runtime: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};"
460
464
  },
461
465
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
462
466
  "kind": "interface",
@@ -466,22 +470,6 @@
466
470
  },
467
471
  "name": "AssemblyManifest",
468
472
  "properties": [
469
- {
470
- "abstract": true,
471
- "docs": {
472
- "stability": "stable",
473
- "summary": "Protocol version."
474
- },
475
- "immutable": true,
476
- "locationInModule": {
477
- "filename": "lib/cloud-assembly/schema.ts",
478
- "line": 117
479
- },
480
- "name": "version",
481
- "type": {
482
- "primitive": "string"
483
- }
484
- },
485
473
  {
486
474
  "abstract": true,
487
475
  "docs": {
@@ -546,6 +534,22 @@
546
534
  "type": {
547
535
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
548
536
  }
537
+ },
538
+ {
539
+ "abstract": true,
540
+ "docs": {
541
+ "stability": "stable",
542
+ "summary": "Protocol version."
543
+ },
544
+ "immutable": true,
545
+ "locationInModule": {
546
+ "filename": "lib/cloud-assembly/schema.ts",
547
+ "line": 117
548
+ },
549
+ "name": "version",
550
+ "type": {
551
+ "primitive": "string"
552
+ }
549
553
  }
550
554
  ],
551
555
  "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
@@ -555,7 +559,8 @@
555
559
  "datatype": true,
556
560
  "docs": {
557
561
  "stability": "stable",
558
- "summary": "Definitions for the asset manifest."
562
+ "summary": "Definitions for the asset manifest.",
563
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assetManifest: cloud_assembly_schema.AssetManifest = {\n version: 'version',\n\n // the properties below are optional\n dockerImages: {\n dockerImagesKey: {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n },\n },\n files: {\n filesKey: {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n },\n },\n};"
559
564
  },
560
565
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
561
566
  "kind": "interface",
@@ -565,22 +570,6 @@
565
570
  },
566
571
  "name": "AssetManifest",
567
572
  "properties": [
568
- {
569
- "abstract": true,
570
- "docs": {
571
- "stability": "stable",
572
- "summary": "Version of the manifest."
573
- },
574
- "immutable": true,
575
- "locationInModule": {
576
- "filename": "lib/assets/schema.ts",
577
- "line": 11
578
- },
579
- "name": "version",
580
- "type": {
581
- "primitive": "string"
582
- }
583
- },
584
573
  {
585
574
  "abstract": true,
586
575
  "docs": {
@@ -626,6 +615,22 @@
626
615
  "kind": "map"
627
616
  }
628
617
  }
618
+ },
619
+ {
620
+ "abstract": true,
621
+ "docs": {
622
+ "stability": "stable",
623
+ "summary": "Version of the manifest."
624
+ },
625
+ "immutable": true,
626
+ "locationInModule": {
627
+ "filename": "lib/assets/schema.ts",
628
+ "line": 11
629
+ },
630
+ "name": "version",
631
+ "type": {
632
+ "primitive": "string"
633
+ }
629
634
  }
630
635
  ],
631
636
  "symbolId": "lib/assets/schema:AssetManifest"
@@ -635,7 +640,8 @@
635
640
  "datatype": true,
636
641
  "docs": {
637
642
  "stability": "stable",
638
- "summary": "Artifact properties for the Asset Manifest."
643
+ "summary": "Artifact properties for the Asset Manifest.",
644
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assetManifestProperties: cloud_assembly_schema.AssetManifestProperties = {\n file: 'file',\n\n // the properties below are optional\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};"
639
645
  },
640
646
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
641
647
  "kind": "interface",
@@ -648,15 +654,18 @@
648
654
  {
649
655
  "abstract": true,
650
656
  "docs": {
657
+ "default": "- Bootstrap stack version number looked up",
658
+ "remarks": "- If this value is not set, the bootstrap stack name must be known at\n deployment time so the stack version can be looked up from the stack\n outputs.\n- If this value is set, the bootstrap stack can have any name because\n we won't need to look it up.",
651
659
  "stability": "stable",
652
- "summary": "Filename of the asset manifest."
660
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
653
661
  },
654
662
  "immutable": true,
655
663
  "locationInModule": {
656
664
  "filename": "lib/cloud-assembly/artifact-schema.ts",
657
- "line": 103
665
+ "line": 123
658
666
  },
659
- "name": "file",
667
+ "name": "bootstrapStackVersionSsmParameter",
668
+ "optional": true,
660
669
  "type": {
661
670
  "primitive": "string"
662
671
  }
@@ -664,18 +673,15 @@
664
673
  {
665
674
  "abstract": true,
666
675
  "docs": {
667
- "default": "- Bootstrap stack version number looked up",
668
- "remarks": "- If this value is not set, the bootstrap stack name must be known at\n deployment time so the stack version can be looked up from the stack\n outputs.\n- If this value is set, the bootstrap stack can have any name because\n we won't need to look it up.",
669
676
  "stability": "stable",
670
- "summary": "SSM parameter where the bootstrap stack version number can be found."
677
+ "summary": "Filename of the asset manifest."
671
678
  },
672
679
  "immutable": true,
673
680
  "locationInModule": {
674
681
  "filename": "lib/cloud-assembly/artifact-schema.ts",
675
- "line": 123
682
+ "line": 103
676
683
  },
677
- "name": "bootstrapStackVersionSsmParameter",
678
- "optional": true,
684
+ "name": "file",
679
685
  "type": {
680
686
  "primitive": "string"
681
687
  }
@@ -706,7 +712,8 @@
706
712
  "datatype": true,
707
713
  "docs": {
708
714
  "stability": "stable",
709
- "summary": "Query to availability zone context provider."
715
+ "summary": "Query to availability zone context provider.",
716
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst availabilityZonesContextQuery: cloud_assembly_schema.AvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
710
717
  },
711
718
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
712
719
  "kind": "interface",
@@ -735,15 +742,17 @@
735
742
  {
736
743
  "abstract": true,
737
744
  "docs": {
745
+ "default": "- None",
738
746
  "stability": "stable",
739
- "summary": "Query region."
747
+ "summary": "The ARN of the role that should be used to look up the missing values."
740
748
  },
741
749
  "immutable": true,
742
750
  "locationInModule": {
743
751
  "filename": "lib/cloud-assembly/context-queries.ts",
744
- "line": 104
752
+ "line": 111
745
753
  },
746
- "name": "region",
754
+ "name": "lookupRoleArn",
755
+ "optional": true,
747
756
  "type": {
748
757
  "primitive": "string"
749
758
  }
@@ -751,17 +760,15 @@
751
760
  {
752
761
  "abstract": true,
753
762
  "docs": {
754
- "default": "- None",
755
763
  "stability": "stable",
756
- "summary": "The ARN of the role that should be used to look up the missing values."
764
+ "summary": "Query region."
757
765
  },
758
766
  "immutable": true,
759
767
  "locationInModule": {
760
768
  "filename": "lib/cloud-assembly/context-queries.ts",
761
- "line": 111
769
+ "line": 104
762
770
  },
763
- "name": "lookupRoleArn",
764
- "optional": true,
771
+ "name": "region",
765
772
  "type": {
766
773
  "primitive": "string"
767
774
  }
@@ -774,7 +781,8 @@
774
781
  "datatype": true,
775
782
  "docs": {
776
783
  "stability": "stable",
777
- "summary": "Artifact properties for CloudFormation stacks."
784
+ "summary": "Artifact properties for CloudFormation stacks.",
785
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n};"
778
786
  },
779
787
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
780
788
  "kind": "interface",
@@ -784,22 +792,6 @@
784
792
  },
785
793
  "name": "AwsCloudFormationStackProperties",
786
794
  "properties": [
787
- {
788
- "abstract": true,
789
- "docs": {
790
- "stability": "stable",
791
- "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
792
- },
793
- "immutable": true,
794
- "locationInModule": {
795
- "filename": "lib/cloud-assembly/artifact-schema.ts",
796
- "line": 9
797
- },
798
- "name": "templateFile",
799
- "type": {
800
- "primitive": "string"
801
- }
802
- },
803
795
  {
804
796
  "abstract": true,
805
797
  "docs": {
@@ -973,6 +965,22 @@
973
965
  }
974
966
  }
975
967
  },
968
+ {
969
+ "abstract": true,
970
+ "docs": {
971
+ "stability": "stable",
972
+ "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
973
+ },
974
+ "immutable": true,
975
+ "locationInModule": {
976
+ "filename": "lib/cloud-assembly/artifact-schema.ts",
977
+ "line": 9
978
+ },
979
+ "name": "templateFile",
980
+ "type": {
981
+ "primitive": "string"
982
+ }
983
+ },
976
984
  {
977
985
  "abstract": true,
978
986
  "docs": {
@@ -1017,7 +1025,8 @@
1017
1025
  "datatype": true,
1018
1026
  "docs": {
1019
1027
  "stability": "stable",
1020
- "summary": "Destination for assets that need to be uploaded to AWS."
1028
+ "summary": "Destination for assets that need to be uploaded to AWS.",
1029
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst awsDestination: cloud_assembly_schema.AwsDestination = {\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
1021
1030
  },
1022
1031
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
1023
1032
  "kind": "interface",
@@ -1089,7 +1098,8 @@
1089
1098
  "datatype": true,
1090
1099
  "docs": {
1091
1100
  "stability": "stable",
1092
- "summary": "Metadata Entry spec for container images."
1101
+ "summary": "Metadata Entry spec for container images.",
1102
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst containerImageAssetMetadataEntry: cloud_assembly_schema.ContainerImageAssetMetadataEntry = {\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n sourceHash: 'sourceHash',\n\n // the properties below are optional\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n file: 'file',\n imageNameParameter: 'imageNameParameter',\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n target: 'target',\n};"
1093
1103
  },
1094
1104
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1095
1105
  "kind": "interface",
@@ -1102,31 +1112,40 @@
1102
1112
  {
1103
1113
  "abstract": true,
1104
1114
  "docs": {
1115
+ "default": "no build args are passed",
1105
1116
  "stability": "stable",
1106
- "summary": "Logical identifier for the asset."
1117
+ "summary": "Build args to pass to the `docker build` command."
1107
1118
  },
1108
1119
  "immutable": true,
1109
1120
  "locationInModule": {
1110
1121
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1111
- "line": 13
1122
+ "line": 119
1112
1123
  },
1113
- "name": "id",
1124
+ "name": "buildArgs",
1125
+ "optional": true,
1114
1126
  "type": {
1115
- "primitive": "string"
1127
+ "collection": {
1128
+ "elementtype": {
1129
+ "primitive": "string"
1130
+ },
1131
+ "kind": "map"
1132
+ }
1116
1133
  }
1117
1134
  },
1118
1135
  {
1119
1136
  "abstract": true,
1120
1137
  "docs": {
1138
+ "default": "- no file is passed",
1121
1139
  "stability": "stable",
1122
- "summary": "Type of asset."
1140
+ "summary": "Path to the Dockerfile (relative to the directory)."
1123
1141
  },
1124
1142
  "immutable": true,
1125
1143
  "locationInModule": {
1126
1144
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1127
- "line": 81
1145
+ "line": 133
1128
1146
  },
1129
- "name": "packaging",
1147
+ "name": "file",
1148
+ "optional": true,
1130
1149
  "type": {
1131
1150
  "primitive": "string"
1132
1151
  }
@@ -1135,14 +1154,14 @@
1135
1154
  "abstract": true,
1136
1155
  "docs": {
1137
1156
  "stability": "stable",
1138
- "summary": "Path on disk to the asset."
1157
+ "summary": "Logical identifier for the asset."
1139
1158
  },
1140
1159
  "immutable": true,
1141
1160
  "locationInModule": {
1142
1161
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1143
- "line": 23
1162
+ "line": 13
1144
1163
  },
1145
- "name": "path",
1164
+ "name": "id",
1146
1165
  "type": {
1147
1166
  "primitive": "string"
1148
1167
  }
@@ -1150,15 +1169,18 @@
1150
1169
  {
1151
1170
  "abstract": true,
1152
1171
  "docs": {
1153
- "stability": "stable",
1154
- "summary": "The hash of the asset source."
1172
+ "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1173
+ "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1174
+ "stability": "deprecated",
1175
+ "summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
1155
1176
  },
1156
1177
  "immutable": true,
1157
1178
  "locationInModule": {
1158
1179
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1159
- "line": 18
1180
+ "line": 93
1160
1181
  },
1161
- "name": "sourceHash",
1182
+ "name": "imageNameParameter",
1183
+ "optional": true,
1162
1184
  "type": {
1163
1185
  "primitive": "string"
1164
1186
  }
@@ -1166,40 +1188,34 @@
1166
1188
  {
1167
1189
  "abstract": true,
1168
1190
  "docs": {
1169
- "default": "no build args are passed",
1191
+ "default": "- this parameter is REQUIRED after 1.21.0",
1192
+ "remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
1170
1193
  "stability": "stable",
1171
- "summary": "Build args to pass to the `docker build` command."
1194
+ "summary": "The docker image tag to use for tagging pushed images."
1172
1195
  },
1173
1196
  "immutable": true,
1174
1197
  "locationInModule": {
1175
1198
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1176
- "line": 119
1199
+ "line": 112
1177
1200
  },
1178
- "name": "buildArgs",
1201
+ "name": "imageTag",
1179
1202
  "optional": true,
1180
1203
  "type": {
1181
- "collection": {
1182
- "elementtype": {
1183
- "primitive": "string"
1184
- },
1185
- "kind": "map"
1186
- }
1204
+ "primitive": "string"
1187
1205
  }
1188
1206
  },
1189
1207
  {
1190
1208
  "abstract": true,
1191
1209
  "docs": {
1192
- "default": "- no file is passed",
1193
1210
  "stability": "stable",
1194
- "summary": "Path to the Dockerfile (relative to the directory)."
1211
+ "summary": "Type of asset."
1195
1212
  },
1196
1213
  "immutable": true,
1197
1214
  "locationInModule": {
1198
1215
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1199
- "line": 133
1216
+ "line": 81
1200
1217
  },
1201
- "name": "file",
1202
- "optional": true,
1218
+ "name": "packaging",
1203
1219
  "type": {
1204
1220
  "primitive": "string"
1205
1221
  }
@@ -1207,18 +1223,15 @@
1207
1223
  {
1208
1224
  "abstract": true,
1209
1225
  "docs": {
1210
- "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1211
- "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1212
- "stability": "deprecated",
1213
- "summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
1226
+ "stability": "stable",
1227
+ "summary": "Path on disk to the asset."
1214
1228
  },
1215
1229
  "immutable": true,
1216
1230
  "locationInModule": {
1217
1231
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1218
- "line": 93
1232
+ "line": 23
1219
1233
  },
1220
- "name": "imageNameParameter",
1221
- "optional": true,
1234
+ "name": "path",
1222
1235
  "type": {
1223
1236
  "primitive": "string"
1224
1237
  }
@@ -1227,16 +1240,16 @@
1227
1240
  "abstract": true,
1228
1241
  "docs": {
1229
1242
  "default": "- this parameter is REQUIRED after 1.21.0",
1230
- "remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
1243
+ "remarks": "Specify this property if you need to statically address the\nimage, e.g. from a Kubernetes Pod. Note, this is only the repository name,\nwithout the registry and the tag parts.",
1231
1244
  "stability": "stable",
1232
- "summary": "The docker image tag to use for tagging pushed images."
1245
+ "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1233
1246
  },
1234
1247
  "immutable": true,
1235
1248
  "locationInModule": {
1236
1249
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1237
- "line": 112
1250
+ "line": 103
1238
1251
  },
1239
- "name": "imageTag",
1252
+ "name": "repositoryName",
1240
1253
  "optional": true,
1241
1254
  "type": {
1242
1255
  "primitive": "string"
@@ -1245,18 +1258,15 @@
1245
1258
  {
1246
1259
  "abstract": true,
1247
1260
  "docs": {
1248
- "default": "- this parameter is REQUIRED after 1.21.0",
1249
- "remarks": "Specify this property if you need to statically address the\nimage, e.g. from a Kubernetes Pod. Note, this is only the repository name,\nwithout the registry and the tag parts.",
1250
1261
  "stability": "stable",
1251
- "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1262
+ "summary": "The hash of the asset source."
1252
1263
  },
1253
1264
  "immutable": true,
1254
1265
  "locationInModule": {
1255
1266
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1256
- "line": 103
1267
+ "line": 18
1257
1268
  },
1258
- "name": "repositoryName",
1259
- "optional": true,
1269
+ "name": "sourceHash",
1260
1270
  "type": {
1261
1271
  "primitive": "string"
1262
1272
  }
@@ -1312,30 +1322,30 @@
1312
1322
  {
1313
1323
  "docs": {
1314
1324
  "stability": "stable",
1315
- "summary": "Route53 Hosted Zone provider."
1325
+ "summary": "VPC Endpoint Service AZ Provider."
1316
1326
  },
1317
- "name": "HOSTED_ZONE_PROVIDER"
1327
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1318
1328
  },
1319
1329
  {
1320
1330
  "docs": {
1321
1331
  "stability": "stable",
1322
- "summary": "SSM Parameter Provider."
1332
+ "summary": "Route53 Hosted Zone provider."
1323
1333
  },
1324
- "name": "SSM_PARAMETER_PROVIDER"
1334
+ "name": "HOSTED_ZONE_PROVIDER"
1325
1335
  },
1326
1336
  {
1327
1337
  "docs": {
1328
1338
  "stability": "stable",
1329
- "summary": "VPC Provider."
1339
+ "summary": "KMS Key Provider."
1330
1340
  },
1331
- "name": "VPC_PROVIDER"
1341
+ "name": "KEY_PROVIDER"
1332
1342
  },
1333
1343
  {
1334
1344
  "docs": {
1335
1345
  "stability": "stable",
1336
- "summary": "VPC Endpoint Service AZ Provider."
1346
+ "summary": "Load balancer listener provider."
1337
1347
  },
1338
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1348
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1339
1349
  },
1340
1350
  {
1341
1351
  "docs": {
@@ -1347,23 +1357,23 @@
1347
1357
  {
1348
1358
  "docs": {
1349
1359
  "stability": "stable",
1350
- "summary": "Load balancer listener provider."
1360
+ "summary": "Security group provider."
1351
1361
  },
1352
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1362
+ "name": "SECURITY_GROUP_PROVIDER"
1353
1363
  },
1354
1364
  {
1355
1365
  "docs": {
1356
1366
  "stability": "stable",
1357
- "summary": "Security group provider."
1367
+ "summary": "SSM Parameter Provider."
1358
1368
  },
1359
- "name": "SECURITY_GROUP_PROVIDER"
1369
+ "name": "SSM_PARAMETER_PROVIDER"
1360
1370
  },
1361
1371
  {
1362
1372
  "docs": {
1363
1373
  "stability": "stable",
1364
- "summary": "KMS Key Provider."
1374
+ "summary": "VPC Provider."
1365
1375
  },
1366
- "name": "KEY_PROVIDER"
1376
+ "name": "VPC_PROVIDER"
1367
1377
  }
1368
1378
  ],
1369
1379
  "name": "ContextProvider",
@@ -1374,7 +1384,8 @@
1374
1384
  "datatype": true,
1375
1385
  "docs": {
1376
1386
  "stability": "stable",
1377
- "summary": "A file asset."
1387
+ "summary": "A file asset.",
1388
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n};"
1378
1389
  },
1379
1390
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1380
1391
  "kind": "interface",
@@ -1429,7 +1440,8 @@
1429
1440
  "datatype": true,
1430
1441
  "docs": {
1431
1442
  "stability": "stable",
1432
- "summary": "Where to publish docker images."
1443
+ "summary": "Where to publish docker images.",
1444
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
1433
1445
  },
1434
1446
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1435
1447
  "interfaces": [
@@ -1482,7 +1494,8 @@
1482
1494
  "datatype": true,
1483
1495
  "docs": {
1484
1496
  "stability": "stable",
1485
- "summary": "Properties for how to produce a Docker image from a source."
1497
+ "summary": "Properties for how to produce a Docker image from a source.",
1498
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageSource: cloud_assembly_schema.DockerImageSource = {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n};"
1486
1499
  },
1487
1500
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1488
1501
  "kind": "interface",
@@ -1604,7 +1617,8 @@
1604
1617
  "datatype": true,
1605
1618
  "docs": {
1606
1619
  "stability": "stable",
1607
- "summary": "Query to endpoint service context provider."
1620
+ "summary": "Query to endpoint service context provider.",
1621
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst endpointServiceAvailabilityZonesContextQuery: cloud_assembly_schema.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
1608
1622
  },
1609
1623
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1610
1624
  "kind": "interface",
@@ -1633,15 +1647,17 @@
1633
1647
  {
1634
1648
  "abstract": true,
1635
1649
  "docs": {
1650
+ "default": "- None",
1636
1651
  "stability": "stable",
1637
- "summary": "Query region."
1652
+ "summary": "The ARN of the role that should be used to look up the missing values."
1638
1653
  },
1639
1654
  "immutable": true,
1640
1655
  "locationInModule": {
1641
1656
  "filename": "lib/cloud-assembly/context-queries.ts",
1642
- "line": 247
1657
+ "line": 254
1643
1658
  },
1644
- "name": "region",
1659
+ "name": "lookupRoleArn",
1660
+ "optional": true,
1645
1661
  "type": {
1646
1662
  "primitive": "string"
1647
1663
  }
@@ -1650,14 +1666,14 @@
1650
1666
  "abstract": true,
1651
1667
  "docs": {
1652
1668
  "stability": "stable",
1653
- "summary": "Query service name."
1669
+ "summary": "Query region."
1654
1670
  },
1655
1671
  "immutable": true,
1656
1672
  "locationInModule": {
1657
1673
  "filename": "lib/cloud-assembly/context-queries.ts",
1658
- "line": 259
1674
+ "line": 247
1659
1675
  },
1660
- "name": "serviceName",
1676
+ "name": "region",
1661
1677
  "type": {
1662
1678
  "primitive": "string"
1663
1679
  }
@@ -1665,17 +1681,15 @@
1665
1681
  {
1666
1682
  "abstract": true,
1667
1683
  "docs": {
1668
- "default": "- None",
1669
1684
  "stability": "stable",
1670
- "summary": "The ARN of the role that should be used to look up the missing values."
1685
+ "summary": "Query service name."
1671
1686
  },
1672
1687
  "immutable": true,
1673
1688
  "locationInModule": {
1674
1689
  "filename": "lib/cloud-assembly/context-queries.ts",
1675
- "line": 254
1690
+ "line": 259
1676
1691
  },
1677
- "name": "lookupRoleArn",
1678
- "optional": true,
1692
+ "name": "serviceName",
1679
1693
  "type": {
1680
1694
  "primitive": "string"
1681
1695
  }
@@ -1688,7 +1702,8 @@
1688
1702
  "datatype": true,
1689
1703
  "docs": {
1690
1704
  "stability": "stable",
1691
- "summary": "A file asset."
1705
+ "summary": "A file asset.",
1706
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileAsset: cloud_assembly_schema.FileAsset = {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n};"
1692
1707
  },
1693
1708
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1694
1709
  "kind": "interface",
@@ -1743,7 +1758,8 @@
1743
1758
  "datatype": true,
1744
1759
  "docs": {
1745
1760
  "stability": "stable",
1746
- "summary": "Metadata Entry spec for files."
1761
+ "summary": "Metadata Entry spec for files.",
1762
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileAssetMetadataEntry: cloud_assembly_schema.FileAssetMetadataEntry = {\n artifactHashParameter: 'artifactHashParameter',\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n s3BucketParameter: 's3BucketParameter',\n s3KeyParameter: 's3KeyParameter',\n sourceHash: 'sourceHash',\n};"
1747
1763
  },
1748
1764
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1749
1765
  "kind": "interface",
@@ -1904,7 +1920,8 @@
1904
1920
  "datatype": true,
1905
1921
  "docs": {
1906
1922
  "stability": "stable",
1907
- "summary": "Where in S3 a file asset needs to be published."
1923
+ "summary": "Where in S3 a file asset needs to be published.",
1924
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileDestination: cloud_assembly_schema.FileDestination = {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
1908
1925
  },
1909
1926
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1910
1927
  "interfaces": [
@@ -1957,7 +1974,8 @@
1957
1974
  "datatype": true,
1958
1975
  "docs": {
1959
1976
  "stability": "stable",
1960
- "summary": "Describe the source of a file asset."
1977
+ "summary": "Describe the source of a file asset.",
1978
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileSource: cloud_assembly_schema.FileSource = {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n};"
1961
1979
  },
1962
1980
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1963
1981
  "kind": "interface",
@@ -2036,7 +2054,8 @@
2036
2054
  "datatype": true,
2037
2055
  "docs": {
2038
2056
  "stability": "stable",
2039
- "summary": "Query to hosted zone context provider."
2057
+ "summary": "Query to hosted zone context provider.",
2058
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {\n account: 'account',\n domainName: 'domainName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n privateZone: false,\n vpcId: 'vpcId',\n};"
2040
2059
  },
2041
2060
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
2042
2061
  "kind": "interface",
@@ -2081,15 +2100,17 @@
2081
2100
  {
2082
2101
  "abstract": true,
2083
2102
  "docs": {
2103
+ "default": "- None",
2084
2104
  "stability": "stable",
2085
- "summary": "Query region."
2105
+ "summary": "The ARN of the role that should be used to look up the missing values."
2086
2106
  },
2087
2107
  "immutable": true,
2088
2108
  "locationInModule": {
2089
2109
  "filename": "lib/cloud-assembly/context-queries.ts",
2090
- "line": 127
2110
+ "line": 134
2091
2111
  },
2092
- "name": "region",
2112
+ "name": "lookupRoleArn",
2113
+ "optional": true,
2093
2114
  "type": {
2094
2115
  "primitive": "string"
2095
2116
  }
@@ -2097,37 +2118,35 @@
2097
2118
  {
2098
2119
  "abstract": true,
2099
2120
  "docs": {
2100
- "default": "- None",
2121
+ "default": "false",
2101
2122
  "stability": "stable",
2102
- "summary": "The ARN of the role that should be used to look up the missing values."
2123
+ "summary": "True if the zone you want to find is a private hosted zone."
2103
2124
  },
2104
2125
  "immutable": true,
2105
2126
  "locationInModule": {
2106
2127
  "filename": "lib/cloud-assembly/context-queries.ts",
2107
- "line": 134
2128
+ "line": 146
2108
2129
  },
2109
- "name": "lookupRoleArn",
2130
+ "name": "privateZone",
2110
2131
  "optional": true,
2111
2132
  "type": {
2112
- "primitive": "string"
2133
+ "primitive": "boolean"
2113
2134
  }
2114
2135
  },
2115
2136
  {
2116
2137
  "abstract": true,
2117
2138
  "docs": {
2118
- "default": "false",
2119
2139
  "stability": "stable",
2120
- "summary": "True if the zone you want to find is a private hosted zone."
2140
+ "summary": "Query region."
2121
2141
  },
2122
2142
  "immutable": true,
2123
2143
  "locationInModule": {
2124
2144
  "filename": "lib/cloud-assembly/context-queries.ts",
2125
- "line": 146
2145
+ "line": 127
2126
2146
  },
2127
- "name": "privateZone",
2128
- "optional": true,
2147
+ "name": "region",
2129
2148
  "type": {
2130
- "primitive": "boolean"
2149
+ "primitive": "string"
2131
2150
  }
2132
2151
  },
2133
2152
  {
@@ -2157,13 +2176,14 @@
2157
2176
  "datatype": true,
2158
2177
  "docs": {
2159
2178
  "stability": "stable",
2160
- "summary": "Query input for looking up a KMS Key."
2179
+ "summary": "Query input for looking up a KMS Key.",
2180
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst keyContextQuery: cloud_assembly_schema.KeyContextQuery = {\n account: 'account',\n aliasName: 'aliasName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
2161
2181
  },
2162
2182
  "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
2163
2183
  "kind": "interface",
2164
2184
  "locationInModule": {
2165
2185
  "filename": "lib/cloud-assembly/context-queries.ts",
2166
- "line": 426
2186
+ "line": 442
2167
2187
  },
2168
2188
  "name": "KeyContextQuery",
2169
2189
  "properties": [
@@ -2176,7 +2196,7 @@
2176
2196
  "immutable": true,
2177
2197
  "locationInModule": {
2178
2198
  "filename": "lib/cloud-assembly/context-queries.ts",
2179
- "line": 430
2199
+ "line": 446
2180
2200
  },
2181
2201
  "name": "account",
2182
2202
  "type": {
@@ -2192,7 +2212,7 @@
2192
2212
  "immutable": true,
2193
2213
  "locationInModule": {
2194
2214
  "filename": "lib/cloud-assembly/context-queries.ts",
2195
- "line": 447
2215
+ "line": 463
2196
2216
  },
2197
2217
  "name": "aliasName",
2198
2218
  "type": {
@@ -2202,15 +2222,17 @@
2202
2222
  {
2203
2223
  "abstract": true,
2204
2224
  "docs": {
2225
+ "default": "- None",
2205
2226
  "stability": "stable",
2206
- "summary": "Query region."
2227
+ "summary": "The ARN of the role that should be used to look up the missing values."
2207
2228
  },
2208
2229
  "immutable": true,
2209
2230
  "locationInModule": {
2210
2231
  "filename": "lib/cloud-assembly/context-queries.ts",
2211
- "line": 435
2232
+ "line": 458
2212
2233
  },
2213
- "name": "region",
2234
+ "name": "lookupRoleArn",
2235
+ "optional": true,
2214
2236
  "type": {
2215
2237
  "primitive": "string"
2216
2238
  }
@@ -2218,17 +2240,15 @@
2218
2240
  {
2219
2241
  "abstract": true,
2220
2242
  "docs": {
2221
- "default": "- None",
2222
2243
  "stability": "stable",
2223
- "summary": "The ARN of the role that should be used to look up the missing values."
2244
+ "summary": "Query region."
2224
2245
  },
2225
2246
  "immutable": true,
2226
2247
  "locationInModule": {
2227
2248
  "filename": "lib/cloud-assembly/context-queries.ts",
2228
- "line": 442
2249
+ "line": 451
2229
2250
  },
2230
- "name": "lookupRoleArn",
2231
- "optional": true,
2251
+ "name": "region",
2232
2252
  "type": {
2233
2253
  "primitive": "string"
2234
2254
  }
@@ -2241,7 +2261,8 @@
2241
2261
  "datatype": true,
2242
2262
  "docs": {
2243
2263
  "stability": "stable",
2244
- "summary": "Query input for looking up a load balancer."
2264
+ "summary": "Query input for looking up a load balancer.",
2265
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerContextQuery: cloud_assembly_schema.LoadBalancerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};"
2245
2266
  },
2246
2267
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2247
2268
  "interfaces": [
@@ -2273,15 +2294,17 @@
2273
2294
  {
2274
2295
  "abstract": true,
2275
2296
  "docs": {
2297
+ "default": "- None",
2276
2298
  "stability": "stable",
2277
- "summary": "Query region."
2299
+ "summary": "The ARN of the role that should be used to look up the missing values."
2278
2300
  },
2279
2301
  "immutable": true,
2280
2302
  "locationInModule": {
2281
2303
  "filename": "lib/cloud-assembly/context-queries.ts",
2282
- "line": 311
2304
+ "line": 318
2283
2305
  },
2284
- "name": "region",
2306
+ "name": "lookupRoleArn",
2307
+ "optional": true,
2285
2308
  "type": {
2286
2309
  "primitive": "string"
2287
2310
  }
@@ -2289,17 +2312,15 @@
2289
2312
  {
2290
2313
  "abstract": true,
2291
2314
  "docs": {
2292
- "default": "- None",
2293
2315
  "stability": "stable",
2294
- "summary": "The ARN of the role that should be used to look up the missing values."
2316
+ "summary": "Query region."
2295
2317
  },
2296
2318
  "immutable": true,
2297
2319
  "locationInModule": {
2298
2320
  "filename": "lib/cloud-assembly/context-queries.ts",
2299
- "line": 318
2321
+ "line": 311
2300
2322
  },
2301
- "name": "lookupRoleArn",
2302
- "optional": true,
2323
+ "name": "region",
2303
2324
  "type": {
2304
2325
  "primitive": "string"
2305
2326
  }
@@ -2312,7 +2333,8 @@
2312
2333
  "datatype": true,
2313
2334
  "docs": {
2314
2335
  "stability": "stable",
2315
- "summary": "Filters for selecting load balancers."
2336
+ "summary": "Filters for selecting load balancers.",
2337
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n};"
2316
2338
  },
2317
2339
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2318
2340
  "kind": "interface",
@@ -2322,22 +2344,6 @@
2322
2344
  },
2323
2345
  "name": "LoadBalancerFilter",
2324
2346
  "properties": [
2325
- {
2326
- "abstract": true,
2327
- "docs": {
2328
- "stability": "stable",
2329
- "summary": "Filter load balancers by their type."
2330
- },
2331
- "immutable": true,
2332
- "locationInModule": {
2333
- "filename": "lib/cloud-assembly/context-queries.ts",
2334
- "line": 284
2335
- },
2336
- "name": "loadBalancerType",
2337
- "type": {
2338
- "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2339
- }
2340
- },
2341
2347
  {
2342
2348
  "abstract": true,
2343
2349
  "docs": {
@@ -2378,6 +2384,22 @@
2378
2384
  "kind": "array"
2379
2385
  }
2380
2386
  }
2387
+ },
2388
+ {
2389
+ "abstract": true,
2390
+ "docs": {
2391
+ "stability": "stable",
2392
+ "summary": "Filter load balancers by their type."
2393
+ },
2394
+ "immutable": true,
2395
+ "locationInModule": {
2396
+ "filename": "lib/cloud-assembly/context-queries.ts",
2397
+ "line": 284
2398
+ },
2399
+ "name": "loadBalancerType",
2400
+ "type": {
2401
+ "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2402
+ }
2381
2403
  }
2382
2404
  ],
2383
2405
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
@@ -2387,7 +2409,8 @@
2387
2409
  "datatype": true,
2388
2410
  "docs": {
2389
2411
  "stability": "stable",
2390
- "summary": "Query input for looking up a load balancer listener."
2412
+ "summary": "Query input for looking up a load balancer listener.",
2413
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerListenerContextQuery: cloud_assembly_schema.LoadBalancerListenerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n listenerArn: 'listenerArn',\n listenerPort: 123,\n listenerProtocol: cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};"
2391
2414
  },
2392
2415
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2393
2416
  "interfaces": [
@@ -2416,22 +2439,6 @@
2416
2439
  "primitive": "string"
2417
2440
  }
2418
2441
  },
2419
- {
2420
- "abstract": true,
2421
- "docs": {
2422
- "stability": "stable",
2423
- "summary": "Query region."
2424
- },
2425
- "immutable": true,
2426
- "locationInModule": {
2427
- "filename": "lib/cloud-assembly/context-queries.ts",
2428
- "line": 368
2429
- },
2430
- "name": "region",
2431
- "type": {
2432
- "primitive": "string"
2433
- }
2434
- },
2435
2442
  {
2436
2443
  "abstract": true,
2437
2444
  "docs": {
@@ -2503,6 +2510,22 @@
2503
2510
  "type": {
2504
2511
  "primitive": "string"
2505
2512
  }
2513
+ },
2514
+ {
2515
+ "abstract": true,
2516
+ "docs": {
2517
+ "stability": "stable",
2518
+ "summary": "Query region."
2519
+ },
2520
+ "immutable": true,
2521
+ "locationInModule": {
2522
+ "filename": "lib/cloud-assembly/context-queries.ts",
2523
+ "line": 368
2524
+ },
2525
+ "name": "region",
2526
+ "type": {
2527
+ "primitive": "string"
2528
+ }
2506
2529
  }
2507
2530
  ],
2508
2531
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
@@ -2544,23 +2567,23 @@
2544
2567
  {
2545
2568
  "docs": {
2546
2569
  "stability": "stable",
2547
- "summary": "TLS protocol."
2570
+ "summary": "TCP and UDP protocol."
2548
2571
  },
2549
- "name": "TLS"
2572
+ "name": "TCP_UDP"
2550
2573
  },
2551
2574
  {
2552
2575
  "docs": {
2553
2576
  "stability": "stable",
2554
- "summary": "UDP protocol."
2577
+ "summary": "TLS protocol."
2555
2578
  },
2556
- "name": "UDP"
2579
+ "name": "TLS"
2557
2580
  },
2558
2581
  {
2559
2582
  "docs": {
2560
2583
  "stability": "stable",
2561
- "summary": "TCP and UDP protocol."
2584
+ "summary": "UDP protocol."
2562
2585
  },
2563
- "name": "TCP_UDP"
2586
+ "name": "UDP"
2564
2587
  }
2565
2588
  ],
2566
2589
  "name": "LoadBalancerListenerProtocol",
@@ -2582,16 +2605,16 @@
2582
2605
  {
2583
2606
  "docs": {
2584
2607
  "stability": "stable",
2585
- "summary": "Network load balancer."
2608
+ "summary": "Application load balancer."
2586
2609
  },
2587
- "name": "NETWORK"
2610
+ "name": "APPLICATION"
2588
2611
  },
2589
2612
  {
2590
2613
  "docs": {
2591
2614
  "stability": "stable",
2592
- "summary": "Application load balancer."
2615
+ "summary": "Network load balancer."
2593
2616
  },
2594
- "name": "APPLICATION"
2617
+ "name": "NETWORK"
2595
2618
  }
2596
2619
  ],
2597
2620
  "name": "LoadBalancerType",
@@ -2809,7 +2832,8 @@
2809
2832
  "datatype": true,
2810
2833
  "docs": {
2811
2834
  "stability": "stable",
2812
- "summary": "A metadata entry in a cloud assembly artifact."
2835
+ "summary": "A metadata entry in a cloud assembly artifact.",
2836
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst metadataEntry: cloud_assembly_schema.MetadataEntry = {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};"
2813
2837
  },
2814
2838
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2815
2839
  "kind": "interface",
@@ -2819,22 +2843,6 @@
2819
2843
  },
2820
2844
  "name": "MetadataEntry",
2821
2845
  "properties": [
2822
- {
2823
- "abstract": true,
2824
- "docs": {
2825
- "stability": "stable",
2826
- "summary": "The type of the metadata entry."
2827
- },
2828
- "immutable": true,
2829
- "locationInModule": {
2830
- "filename": "lib/cloud-assembly/metadata-schema.ts",
2831
- "line": 208
2832
- },
2833
- "name": "type",
2834
- "type": {
2835
- "primitive": "string"
2836
- }
2837
- },
2838
2846
  {
2839
2847
  "abstract": true,
2840
2848
  "docs": {
@@ -2895,6 +2903,22 @@
2895
2903
  "kind": "array"
2896
2904
  }
2897
2905
  }
2906
+ },
2907
+ {
2908
+ "abstract": true,
2909
+ "docs": {
2910
+ "stability": "stable",
2911
+ "summary": "The type of the metadata entry."
2912
+ },
2913
+ "immutable": true,
2914
+ "locationInModule": {
2915
+ "filename": "lib/cloud-assembly/metadata-schema.ts",
2916
+ "line": 208
2917
+ },
2918
+ "name": "type",
2919
+ "type": {
2920
+ "primitive": "string"
2921
+ }
2898
2922
  }
2899
2923
  ],
2900
2924
  "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
@@ -2904,7 +2928,8 @@
2904
2928
  "datatype": true,
2905
2929
  "docs": {
2906
2930
  "stability": "stable",
2907
- "summary": "Represents a missing piece of context."
2931
+ "summary": "Represents a missing piece of context.",
2932
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst missingContext: cloud_assembly_schema.MissingContext = {\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n};"
2908
2933
  },
2909
2934
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2910
2935
  "kind": "interface",
@@ -3003,7 +3028,8 @@
3003
3028
  "datatype": true,
3004
3029
  "docs": {
3005
3030
  "stability": "stable",
3006
- "summary": "Artifact properties for nested cloud assemblies."
3031
+ "summary": "Artifact properties for nested cloud assemblies.",
3032
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst nestedCloudAssemblyProperties: cloud_assembly_schema.NestedCloudAssemblyProperties = {\n directoryName: 'directoryName',\n\n // the properties below are optional\n displayName: 'displayName',\n};"
3007
3033
  },
3008
3034
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
3009
3035
  "kind": "interface",
@@ -3055,7 +3081,8 @@
3055
3081
  "datatype": true,
3056
3082
  "docs": {
3057
3083
  "stability": "stable",
3058
- "summary": "Information about the application's runtime components."
3084
+ "summary": "Information about the application's runtime components.",
3085
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst runtimeInfo: cloud_assembly_schema.RuntimeInfo = {\n libraries: {\n librariesKey: 'libraries',\n },\n};"
3059
3086
  },
3060
3087
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
3061
3088
  "kind": "interface",
@@ -3094,7 +3121,8 @@
3094
3121
  "datatype": true,
3095
3122
  "docs": {
3096
3123
  "stability": "stable",
3097
- "summary": "Query to SSM Parameter Context Provider."
3124
+ "summary": "Query to SSM Parameter Context Provider.",
3125
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst sSMParameterContextQuery: cloud_assembly_schema.SSMParameterContextQuery = {\n account: 'account',\n parameterName: 'parameterName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
3098
3126
  },
3099
3127
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
3100
3128
  "kind": "interface",
@@ -3123,15 +3151,17 @@
3123
3151
  {
3124
3152
  "abstract": true,
3125
3153
  "docs": {
3154
+ "default": "- None",
3126
3155
  "stability": "stable",
3127
- "summary": "Parameter name to query."
3156
+ "summary": "The ARN of the role that should be used to look up the missing values."
3128
3157
  },
3129
3158
  "immutable": true,
3130
3159
  "locationInModule": {
3131
3160
  "filename": "lib/cloud-assembly/context-queries.ts",
3132
- "line": 183
3161
+ "line": 178
3133
3162
  },
3134
- "name": "parameterName",
3163
+ "name": "lookupRoleArn",
3164
+ "optional": true,
3135
3165
  "type": {
3136
3166
  "primitive": "string"
3137
3167
  }
@@ -3140,14 +3170,14 @@
3140
3170
  "abstract": true,
3141
3171
  "docs": {
3142
3172
  "stability": "stable",
3143
- "summary": "Query region."
3173
+ "summary": "Parameter name to query."
3144
3174
  },
3145
3175
  "immutable": true,
3146
3176
  "locationInModule": {
3147
3177
  "filename": "lib/cloud-assembly/context-queries.ts",
3148
- "line": 171
3178
+ "line": 183
3149
3179
  },
3150
- "name": "region",
3180
+ "name": "parameterName",
3151
3181
  "type": {
3152
3182
  "primitive": "string"
3153
3183
  }
@@ -3155,17 +3185,15 @@
3155
3185
  {
3156
3186
  "abstract": true,
3157
3187
  "docs": {
3158
- "default": "- None",
3159
3188
  "stability": "stable",
3160
- "summary": "The ARN of the role that should be used to look up the missing values."
3189
+ "summary": "Query region."
3161
3190
  },
3162
3191
  "immutable": true,
3163
3192
  "locationInModule": {
3164
3193
  "filename": "lib/cloud-assembly/context-queries.ts",
3165
- "line": 178
3194
+ "line": 171
3166
3195
  },
3167
- "name": "lookupRoleArn",
3168
- "optional": true,
3196
+ "name": "region",
3169
3197
  "type": {
3170
3198
  "primitive": "string"
3171
3199
  }
@@ -3178,7 +3206,8 @@
3178
3206
  "datatype": true,
3179
3207
  "docs": {
3180
3208
  "stability": "stable",
3181
- "summary": "Query input for looking up a security group."
3209
+ "summary": "Query input for looking up a security group.",
3210
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n securityGroupId: 'securityGroupId',\n securityGroupName: 'securityGroupName',\n vpcId: 'vpcId',\n};"
3182
3211
  },
3183
3212
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
3184
3213
  "kind": "interface",
@@ -3204,6 +3233,24 @@
3204
3233
  "primitive": "string"
3205
3234
  }
3206
3235
  },
3236
+ {
3237
+ "abstract": true,
3238
+ "docs": {
3239
+ "default": "- None",
3240
+ "stability": "stable",
3241
+ "summary": "The ARN of the role that should be used to look up the missing values."
3242
+ },
3243
+ "immutable": true,
3244
+ "locationInModule": {
3245
+ "filename": "lib/cloud-assembly/context-queries.ts",
3246
+ "line": 415
3247
+ },
3248
+ "name": "lookupRoleArn",
3249
+ "optional": true,
3250
+ "type": {
3251
+ "primitive": "string"
3252
+ }
3253
+ },
3207
3254
  {
3208
3255
  "abstract": true,
3209
3256
  "docs": {
@@ -3223,15 +3270,17 @@
3223
3270
  {
3224
3271
  "abstract": true,
3225
3272
  "docs": {
3273
+ "default": "- None",
3226
3274
  "stability": "stable",
3227
3275
  "summary": "Security group id."
3228
3276
  },
3229
3277
  "immutable": true,
3230
3278
  "locationInModule": {
3231
3279
  "filename": "lib/cloud-assembly/context-queries.ts",
3232
- "line": 420
3280
+ "line": 422
3233
3281
  },
3234
3282
  "name": "securityGroupId",
3283
+ "optional": true,
3235
3284
  "type": {
3236
3285
  "primitive": "string"
3237
3286
  }
@@ -3241,14 +3290,32 @@
3241
3290
  "docs": {
3242
3291
  "default": "- None",
3243
3292
  "stability": "stable",
3244
- "summary": "The ARN of the role that should be used to look up the missing values."
3293
+ "summary": "Security group name."
3245
3294
  },
3246
3295
  "immutable": true,
3247
3296
  "locationInModule": {
3248
3297
  "filename": "lib/cloud-assembly/context-queries.ts",
3249
- "line": 415
3298
+ "line": 429
3250
3299
  },
3251
- "name": "lookupRoleArn",
3300
+ "name": "securityGroupName",
3301
+ "optional": true,
3302
+ "type": {
3303
+ "primitive": "string"
3304
+ }
3305
+ },
3306
+ {
3307
+ "abstract": true,
3308
+ "docs": {
3309
+ "default": "- None",
3310
+ "stability": "stable",
3311
+ "summary": "VPC ID."
3312
+ },
3313
+ "immutable": true,
3314
+ "locationInModule": {
3315
+ "filename": "lib/cloud-assembly/context-queries.ts",
3316
+ "line": 436
3317
+ },
3318
+ "name": "vpcId",
3252
3319
  "optional": true,
3253
3320
  "type": {
3254
3321
  "primitive": "string"
@@ -3262,7 +3329,8 @@
3262
3329
  "datatype": true,
3263
3330
  "docs": {
3264
3331
  "stability": "stable",
3265
- "summary": "Metadata Entry spec for stack tag."
3332
+ "summary": "Metadata Entry spec for stack tag.",
3333
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst tag: cloud_assembly_schema.Tag = {\n key: 'key',\n value: 'value',\n};"
3266
3334
  },
3267
3335
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
3268
3336
  "kind": "interface",
@@ -3314,7 +3382,8 @@
3314
3382
  "datatype": true,
3315
3383
  "docs": {
3316
3384
  "stability": "stable",
3317
- "summary": "Artifact properties for the Construct Tree Artifact."
3385
+ "summary": "Artifact properties for the Construct Tree Artifact.",
3386
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst treeArtifactProperties: cloud_assembly_schema.TreeArtifactProperties = {\n file: 'file',\n};"
3318
3387
  },
3319
3388
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3320
3389
  "kind": "interface",
@@ -3348,7 +3417,8 @@
3348
3417
  "datatype": true,
3349
3418
  "docs": {
3350
3419
  "stability": "stable",
3351
- "summary": "Query input for looking up a VPC."
3420
+ "summary": "Query input for looking up a VPC.",
3421
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {\n account: 'account',\n filter: {\n filterKey: 'filter',\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n returnAsymmetricSubnets: false,\n subnetGroupNameTag: 'subnetGroupNameTag',\n};"
3352
3422
  },
3353
3423
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3354
3424
  "kind": "interface",
@@ -3400,15 +3470,17 @@
3400
3470
  {
3401
3471
  "abstract": true,
3402
3472
  "docs": {
3473
+ "default": "- None",
3403
3474
  "stability": "stable",
3404
- "summary": "Query region."
3475
+ "summary": "The ARN of the role that should be used to look up the missing values."
3405
3476
  },
3406
3477
  "immutable": true,
3407
3478
  "locationInModule": {
3408
3479
  "filename": "lib/cloud-assembly/context-queries.ts",
3409
- "line": 198
3480
+ "line": 205
3410
3481
  },
3411
- "name": "region",
3482
+ "name": "lookupRoleArn",
3483
+ "optional": true,
3412
3484
  "type": {
3413
3485
  "primitive": "string"
3414
3486
  }
@@ -3416,17 +3488,15 @@
3416
3488
  {
3417
3489
  "abstract": true,
3418
3490
  "docs": {
3419
- "default": "- None",
3420
3491
  "stability": "stable",
3421
- "summary": "The ARN of the role that should be used to look up the missing values."
3492
+ "summary": "Query region."
3422
3493
  },
3423
3494
  "immutable": true,
3424
3495
  "locationInModule": {
3425
3496
  "filename": "lib/cloud-assembly/context-queries.ts",
3426
- "line": 205
3497
+ "line": 198
3427
3498
  },
3428
- "name": "lookupRoleArn",
3429
- "optional": true,
3499
+ "name": "region",
3430
3500
  "type": {
3431
3501
  "primitive": "string"
3432
3502
  }
@@ -3472,6 +3542,6 @@
3472
3542
  "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3473
3543
  }
3474
3544
  },
3475
- "version": "1.132.0",
3476
- "fingerprint": "dgyp5zSBTym9Ycxa54QULPIvuwFChb+cBlgJ77mAQGg="
3545
+ "version": "1.133.0",
3546
+ "fingerprint": "**********"
3477
3547
  }