@aws-cdk/cloud-assembly-schema 1.131.0 → 1.135.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.47.0 (build 86d2c33)",
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,11 @@
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};",
79
+ "custom": {
80
+ "exampleMetadata": "fixture=_generated"
81
+ }
77
82
  },
78
83
  "fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
79
84
  "kind": "interface",
@@ -125,22 +130,6 @@
125
130
  }
126
131
  }
127
132
  },
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
133
  {
145
134
  "abstract": true,
146
135
  "docs": {
@@ -181,6 +170,22 @@
181
170
  "kind": "array"
182
171
  }
183
172
  }
173
+ },
174
+ {
175
+ "abstract": true,
176
+ "docs": {
177
+ "stability": "stable",
178
+ "summary": "Region to query."
179
+ },
180
+ "immutable": true,
181
+ "locationInModule": {
182
+ "filename": "lib/cloud-assembly/context-queries.ts",
183
+ "line": 70
184
+ },
185
+ "name": "region",
186
+ "type": {
187
+ "primitive": "string"
188
+ }
184
189
  }
185
190
  ],
186
191
  "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
@@ -190,7 +195,11 @@
190
195
  "datatype": true,
191
196
  "docs": {
192
197
  "stability": "stable",
193
- "summary": "A manifest for a single artifact within the cloud assembly."
198
+ "summary": "A manifest for a single artifact within the cloud assembly.",
199
+ "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};",
200
+ "custom": {
201
+ "exampleMetadata": "fixture=_generated"
202
+ }
194
203
  },
195
204
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
196
205
  "kind": "interface",
@@ -200,22 +209,6 @@
200
209
  },
201
210
  "name": "ArtifactManifest",
202
211
  "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
212
  {
220
213
  "abstract": true,
221
214
  "docs": {
@@ -336,6 +329,22 @@
336
329
  ]
337
330
  }
338
331
  }
332
+ },
333
+ {
334
+ "abstract": true,
335
+ "docs": {
336
+ "stability": "stable",
337
+ "summary": "The type of artifact."
338
+ },
339
+ "immutable": true,
340
+ "locationInModule": {
341
+ "filename": "lib/cloud-assembly/schema.ts",
342
+ "line": 72
343
+ },
344
+ "name": "type",
345
+ "type": {
346
+ "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
347
+ }
339
348
  }
340
349
  ],
341
350
  "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
@@ -415,9 +424,9 @@
415
424
  {
416
425
  "docs": {
417
426
  "stability": "stable",
418
- "summary": "Stub required because of JSII."
427
+ "summary": "Manifest for all assets in the Cloud Assembly."
419
428
  },
420
- "name": "NONE"
429
+ "name": "ASSET_MANIFEST"
421
430
  },
422
431
  {
423
432
  "docs": {
@@ -436,16 +445,16 @@
436
445
  {
437
446
  "docs": {
438
447
  "stability": "stable",
439
- "summary": "Manifest for all assets in the Cloud Assembly."
448
+ "summary": "Nested Cloud Assembly."
440
449
  },
441
- "name": "ASSET_MANIFEST"
450
+ "name": "NESTED_CLOUD_ASSEMBLY"
442
451
  },
443
452
  {
444
453
  "docs": {
445
454
  "stability": "stable",
446
- "summary": "Nested Cloud Assembly."
455
+ "summary": "Stub required because of JSII."
447
456
  },
448
- "name": "NESTED_CLOUD_ASSEMBLY"
457
+ "name": "NONE"
449
458
  }
450
459
  ],
451
460
  "name": "ArtifactType",
@@ -456,7 +465,11 @@
456
465
  "datatype": true,
457
466
  "docs": {
458
467
  "stability": "stable",
459
- "summary": "A manifest which describes the cloud assembly."
468
+ "summary": "A manifest which describes the cloud assembly.",
469
+ "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};",
470
+ "custom": {
471
+ "exampleMetadata": "fixture=_generated"
472
+ }
460
473
  },
461
474
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
462
475
  "kind": "interface",
@@ -466,22 +479,6 @@
466
479
  },
467
480
  "name": "AssemblyManifest",
468
481
  "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
482
  {
486
483
  "abstract": true,
487
484
  "docs": {
@@ -546,6 +543,22 @@
546
543
  "type": {
547
544
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
548
545
  }
546
+ },
547
+ {
548
+ "abstract": true,
549
+ "docs": {
550
+ "stability": "stable",
551
+ "summary": "Protocol version."
552
+ },
553
+ "immutable": true,
554
+ "locationInModule": {
555
+ "filename": "lib/cloud-assembly/schema.ts",
556
+ "line": 117
557
+ },
558
+ "name": "version",
559
+ "type": {
560
+ "primitive": "string"
561
+ }
549
562
  }
550
563
  ],
551
564
  "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
@@ -555,7 +568,11 @@
555
568
  "datatype": true,
556
569
  "docs": {
557
570
  "stability": "stable",
558
- "summary": "Definitions for the asset manifest."
571
+ "summary": "Definitions for the asset manifest.",
572
+ "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};",
573
+ "custom": {
574
+ "exampleMetadata": "fixture=_generated"
575
+ }
559
576
  },
560
577
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
561
578
  "kind": "interface",
@@ -565,22 +582,6 @@
565
582
  },
566
583
  "name": "AssetManifest",
567
584
  "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
585
  {
585
586
  "abstract": true,
586
587
  "docs": {
@@ -626,6 +627,22 @@
626
627
  "kind": "map"
627
628
  }
628
629
  }
630
+ },
631
+ {
632
+ "abstract": true,
633
+ "docs": {
634
+ "stability": "stable",
635
+ "summary": "Version of the manifest."
636
+ },
637
+ "immutable": true,
638
+ "locationInModule": {
639
+ "filename": "lib/assets/schema.ts",
640
+ "line": 11
641
+ },
642
+ "name": "version",
643
+ "type": {
644
+ "primitive": "string"
645
+ }
629
646
  }
630
647
  ],
631
648
  "symbolId": "lib/assets/schema:AssetManifest"
@@ -635,7 +652,11 @@
635
652
  "datatype": true,
636
653
  "docs": {
637
654
  "stability": "stable",
638
- "summary": "Artifact properties for the Asset Manifest."
655
+ "summary": "Artifact properties for the Asset Manifest.",
656
+ "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};",
657
+ "custom": {
658
+ "exampleMetadata": "fixture=_generated"
659
+ }
639
660
  },
640
661
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
641
662
  "kind": "interface",
@@ -648,15 +669,18 @@
648
669
  {
649
670
  "abstract": true,
650
671
  "docs": {
672
+ "default": "- Bootstrap stack version number looked up",
673
+ "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
674
  "stability": "stable",
652
- "summary": "Filename of the asset manifest."
675
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
653
676
  },
654
677
  "immutable": true,
655
678
  "locationInModule": {
656
679
  "filename": "lib/cloud-assembly/artifact-schema.ts",
657
- "line": 103
680
+ "line": 123
658
681
  },
659
- "name": "file",
682
+ "name": "bootstrapStackVersionSsmParameter",
683
+ "optional": true,
660
684
  "type": {
661
685
  "primitive": "string"
662
686
  }
@@ -664,18 +688,15 @@
664
688
  {
665
689
  "abstract": true,
666
690
  "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
691
  "stability": "stable",
670
- "summary": "SSM parameter where the bootstrap stack version number can be found."
692
+ "summary": "Filename of the asset manifest."
671
693
  },
672
694
  "immutable": true,
673
695
  "locationInModule": {
674
696
  "filename": "lib/cloud-assembly/artifact-schema.ts",
675
- "line": 123
697
+ "line": 103
676
698
  },
677
- "name": "bootstrapStackVersionSsmParameter",
678
- "optional": true,
699
+ "name": "file",
679
700
  "type": {
680
701
  "primitive": "string"
681
702
  }
@@ -706,7 +727,11 @@
706
727
  "datatype": true,
707
728
  "docs": {
708
729
  "stability": "stable",
709
- "summary": "Query to availability zone context provider."
730
+ "summary": "Query to availability zone context provider.",
731
+ "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};",
732
+ "custom": {
733
+ "exampleMetadata": "fixture=_generated"
734
+ }
710
735
  },
711
736
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
712
737
  "kind": "interface",
@@ -735,15 +760,17 @@
735
760
  {
736
761
  "abstract": true,
737
762
  "docs": {
763
+ "default": "- None",
738
764
  "stability": "stable",
739
- "summary": "Query region."
765
+ "summary": "The ARN of the role that should be used to look up the missing values."
740
766
  },
741
767
  "immutable": true,
742
768
  "locationInModule": {
743
769
  "filename": "lib/cloud-assembly/context-queries.ts",
744
- "line": 104
770
+ "line": 111
745
771
  },
746
- "name": "region",
772
+ "name": "lookupRoleArn",
773
+ "optional": true,
747
774
  "type": {
748
775
  "primitive": "string"
749
776
  }
@@ -751,17 +778,15 @@
751
778
  {
752
779
  "abstract": true,
753
780
  "docs": {
754
- "default": "- None",
755
781
  "stability": "stable",
756
- "summary": "The ARN of the role that should be used to look up the missing values."
782
+ "summary": "Query region."
757
783
  },
758
784
  "immutable": true,
759
785
  "locationInModule": {
760
786
  "filename": "lib/cloud-assembly/context-queries.ts",
761
- "line": 111
787
+ "line": 104
762
788
  },
763
- "name": "lookupRoleArn",
764
- "optional": true,
789
+ "name": "region",
765
790
  "type": {
766
791
  "primitive": "string"
767
792
  }
@@ -774,7 +799,11 @@
774
799
  "datatype": true,
775
800
  "docs": {
776
801
  "stability": "stable",
777
- "summary": "Artifact properties for CloudFormation stacks."
802
+ "summary": "Artifact properties for CloudFormation stacks.",
803
+ "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};",
804
+ "custom": {
805
+ "exampleMetadata": "fixture=_generated"
806
+ }
778
807
  },
779
808
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
780
809
  "kind": "interface",
@@ -784,22 +813,6 @@
784
813
  },
785
814
  "name": "AwsCloudFormationStackProperties",
786
815
  "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
816
  {
804
817
  "abstract": true,
805
818
  "docs": {
@@ -973,6 +986,22 @@
973
986
  }
974
987
  }
975
988
  },
989
+ {
990
+ "abstract": true,
991
+ "docs": {
992
+ "stability": "stable",
993
+ "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
994
+ },
995
+ "immutable": true,
996
+ "locationInModule": {
997
+ "filename": "lib/cloud-assembly/artifact-schema.ts",
998
+ "line": 9
999
+ },
1000
+ "name": "templateFile",
1001
+ "type": {
1002
+ "primitive": "string"
1003
+ }
1004
+ },
976
1005
  {
977
1006
  "abstract": true,
978
1007
  "docs": {
@@ -1017,7 +1046,11 @@
1017
1046
  "datatype": true,
1018
1047
  "docs": {
1019
1048
  "stability": "stable",
1020
- "summary": "Destination for assets that need to be uploaded to AWS."
1049
+ "summary": "Destination for assets that need to be uploaded to AWS.",
1050
+ "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};",
1051
+ "custom": {
1052
+ "exampleMetadata": "fixture=_generated"
1053
+ }
1021
1054
  },
1022
1055
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
1023
1056
  "kind": "interface",
@@ -1089,7 +1122,11 @@
1089
1122
  "datatype": true,
1090
1123
  "docs": {
1091
1124
  "stability": "stable",
1092
- "summary": "Metadata Entry spec for container images."
1125
+ "summary": "Metadata Entry spec for container images.",
1126
+ "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};",
1127
+ "custom": {
1128
+ "exampleMetadata": "fixture=_generated"
1129
+ }
1093
1130
  },
1094
1131
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1095
1132
  "kind": "interface",
@@ -1102,31 +1139,40 @@
1102
1139
  {
1103
1140
  "abstract": true,
1104
1141
  "docs": {
1142
+ "default": "no build args are passed",
1105
1143
  "stability": "stable",
1106
- "summary": "Logical identifier for the asset."
1144
+ "summary": "Build args to pass to the `docker build` command."
1107
1145
  },
1108
1146
  "immutable": true,
1109
1147
  "locationInModule": {
1110
1148
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1111
- "line": 13
1149
+ "line": 119
1112
1150
  },
1113
- "name": "id",
1151
+ "name": "buildArgs",
1152
+ "optional": true,
1114
1153
  "type": {
1115
- "primitive": "string"
1154
+ "collection": {
1155
+ "elementtype": {
1156
+ "primitive": "string"
1157
+ },
1158
+ "kind": "map"
1159
+ }
1116
1160
  }
1117
1161
  },
1118
1162
  {
1119
1163
  "abstract": true,
1120
1164
  "docs": {
1165
+ "default": "- no file is passed",
1121
1166
  "stability": "stable",
1122
- "summary": "Type of asset."
1167
+ "summary": "Path to the Dockerfile (relative to the directory)."
1123
1168
  },
1124
1169
  "immutable": true,
1125
1170
  "locationInModule": {
1126
1171
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1127
- "line": 81
1172
+ "line": 133
1128
1173
  },
1129
- "name": "packaging",
1174
+ "name": "file",
1175
+ "optional": true,
1130
1176
  "type": {
1131
1177
  "primitive": "string"
1132
1178
  }
@@ -1135,14 +1181,14 @@
1135
1181
  "abstract": true,
1136
1182
  "docs": {
1137
1183
  "stability": "stable",
1138
- "summary": "Path on disk to the asset."
1184
+ "summary": "Logical identifier for the asset."
1139
1185
  },
1140
1186
  "immutable": true,
1141
1187
  "locationInModule": {
1142
1188
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1143
- "line": 23
1189
+ "line": 13
1144
1190
  },
1145
- "name": "path",
1191
+ "name": "id",
1146
1192
  "type": {
1147
1193
  "primitive": "string"
1148
1194
  }
@@ -1150,15 +1196,18 @@
1150
1196
  {
1151
1197
  "abstract": true,
1152
1198
  "docs": {
1153
- "stability": "stable",
1154
- "summary": "The hash of the asset source."
1199
+ "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1200
+ "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1201
+ "stability": "deprecated",
1202
+ "summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
1155
1203
  },
1156
1204
  "immutable": true,
1157
1205
  "locationInModule": {
1158
1206
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1159
- "line": 18
1207
+ "line": 93
1160
1208
  },
1161
- "name": "sourceHash",
1209
+ "name": "imageNameParameter",
1210
+ "optional": true,
1162
1211
  "type": {
1163
1212
  "primitive": "string"
1164
1213
  }
@@ -1166,40 +1215,34 @@
1166
1215
  {
1167
1216
  "abstract": true,
1168
1217
  "docs": {
1169
- "default": "no build args are passed",
1218
+ "default": "- this parameter is REQUIRED after 1.21.0",
1219
+ "remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
1170
1220
  "stability": "stable",
1171
- "summary": "Build args to pass to the `docker build` command."
1221
+ "summary": "The docker image tag to use for tagging pushed images."
1172
1222
  },
1173
1223
  "immutable": true,
1174
1224
  "locationInModule": {
1175
1225
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1176
- "line": 119
1226
+ "line": 112
1177
1227
  },
1178
- "name": "buildArgs",
1228
+ "name": "imageTag",
1179
1229
  "optional": true,
1180
1230
  "type": {
1181
- "collection": {
1182
- "elementtype": {
1183
- "primitive": "string"
1184
- },
1185
- "kind": "map"
1186
- }
1231
+ "primitive": "string"
1187
1232
  }
1188
1233
  },
1189
1234
  {
1190
1235
  "abstract": true,
1191
1236
  "docs": {
1192
- "default": "- no file is passed",
1193
1237
  "stability": "stable",
1194
- "summary": "Path to the Dockerfile (relative to the directory)."
1238
+ "summary": "Type of asset."
1195
1239
  },
1196
1240
  "immutable": true,
1197
1241
  "locationInModule": {
1198
1242
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1199
- "line": 133
1243
+ "line": 81
1200
1244
  },
1201
- "name": "file",
1202
- "optional": true,
1245
+ "name": "packaging",
1203
1246
  "type": {
1204
1247
  "primitive": "string"
1205
1248
  }
@@ -1207,18 +1250,15 @@
1207
1250
  {
1208
1251
  "abstract": true,
1209
1252
  "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."
1253
+ "stability": "stable",
1254
+ "summary": "Path on disk to the asset."
1214
1255
  },
1215
1256
  "immutable": true,
1216
1257
  "locationInModule": {
1217
1258
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1218
- "line": 93
1259
+ "line": 23
1219
1260
  },
1220
- "name": "imageNameParameter",
1221
- "optional": true,
1261
+ "name": "path",
1222
1262
  "type": {
1223
1263
  "primitive": "string"
1224
1264
  }
@@ -1227,16 +1267,16 @@
1227
1267
  "abstract": true,
1228
1268
  "docs": {
1229
1269
  "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).",
1270
+ "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
1271
  "stability": "stable",
1232
- "summary": "The docker image tag to use for tagging pushed images."
1272
+ "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1233
1273
  },
1234
1274
  "immutable": true,
1235
1275
  "locationInModule": {
1236
1276
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1237
- "line": 112
1277
+ "line": 103
1238
1278
  },
1239
- "name": "imageTag",
1279
+ "name": "repositoryName",
1240
1280
  "optional": true,
1241
1281
  "type": {
1242
1282
  "primitive": "string"
@@ -1245,18 +1285,15 @@
1245
1285
  {
1246
1286
  "abstract": true,
1247
1287
  "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
1288
  "stability": "stable",
1251
- "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1289
+ "summary": "The hash of the asset source."
1252
1290
  },
1253
1291
  "immutable": true,
1254
1292
  "locationInModule": {
1255
1293
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1256
- "line": 103
1294
+ "line": 18
1257
1295
  },
1258
- "name": "repositoryName",
1259
- "optional": true,
1296
+ "name": "sourceHash",
1260
1297
  "type": {
1261
1298
  "primitive": "string"
1262
1299
  }
@@ -1312,30 +1349,30 @@
1312
1349
  {
1313
1350
  "docs": {
1314
1351
  "stability": "stable",
1315
- "summary": "Route53 Hosted Zone provider."
1352
+ "summary": "VPC Endpoint Service AZ Provider."
1316
1353
  },
1317
- "name": "HOSTED_ZONE_PROVIDER"
1354
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1318
1355
  },
1319
1356
  {
1320
1357
  "docs": {
1321
1358
  "stability": "stable",
1322
- "summary": "SSM Parameter Provider."
1359
+ "summary": "Route53 Hosted Zone provider."
1323
1360
  },
1324
- "name": "SSM_PARAMETER_PROVIDER"
1361
+ "name": "HOSTED_ZONE_PROVIDER"
1325
1362
  },
1326
1363
  {
1327
1364
  "docs": {
1328
1365
  "stability": "stable",
1329
- "summary": "VPC Provider."
1366
+ "summary": "KMS Key Provider."
1330
1367
  },
1331
- "name": "VPC_PROVIDER"
1368
+ "name": "KEY_PROVIDER"
1332
1369
  },
1333
1370
  {
1334
1371
  "docs": {
1335
1372
  "stability": "stable",
1336
- "summary": "VPC Endpoint Service AZ Provider."
1373
+ "summary": "Load balancer listener provider."
1337
1374
  },
1338
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1375
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1339
1376
  },
1340
1377
  {
1341
1378
  "docs": {
@@ -1347,23 +1384,23 @@
1347
1384
  {
1348
1385
  "docs": {
1349
1386
  "stability": "stable",
1350
- "summary": "Load balancer listener provider."
1387
+ "summary": "Security group provider."
1351
1388
  },
1352
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1389
+ "name": "SECURITY_GROUP_PROVIDER"
1353
1390
  },
1354
1391
  {
1355
1392
  "docs": {
1356
1393
  "stability": "stable",
1357
- "summary": "Security group provider."
1394
+ "summary": "SSM Parameter Provider."
1358
1395
  },
1359
- "name": "SECURITY_GROUP_PROVIDER"
1396
+ "name": "SSM_PARAMETER_PROVIDER"
1360
1397
  },
1361
1398
  {
1362
1399
  "docs": {
1363
1400
  "stability": "stable",
1364
- "summary": "KMS Key Provider."
1401
+ "summary": "VPC Provider."
1365
1402
  },
1366
- "name": "KEY_PROVIDER"
1403
+ "name": "VPC_PROVIDER"
1367
1404
  }
1368
1405
  ],
1369
1406
  "name": "ContextProvider",
@@ -1374,7 +1411,11 @@
1374
1411
  "datatype": true,
1375
1412
  "docs": {
1376
1413
  "stability": "stable",
1377
- "summary": "A file asset."
1414
+ "summary": "A file asset.",
1415
+ "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};",
1416
+ "custom": {
1417
+ "exampleMetadata": "fixture=_generated"
1418
+ }
1378
1419
  },
1379
1420
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1380
1421
  "kind": "interface",
@@ -1429,7 +1470,11 @@
1429
1470
  "datatype": true,
1430
1471
  "docs": {
1431
1472
  "stability": "stable",
1432
- "summary": "Where to publish docker images."
1473
+ "summary": "Where to publish docker images.",
1474
+ "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};",
1475
+ "custom": {
1476
+ "exampleMetadata": "fixture=_generated"
1477
+ }
1433
1478
  },
1434
1479
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1435
1480
  "interfaces": [
@@ -1482,7 +1527,11 @@
1482
1527
  "datatype": true,
1483
1528
  "docs": {
1484
1529
  "stability": "stable",
1485
- "summary": "Properties for how to produce a Docker image from a source."
1530
+ "summary": "Properties for how to produce a Docker image from a source.",
1531
+ "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};",
1532
+ "custom": {
1533
+ "exampleMetadata": "fixture=_generated"
1534
+ }
1486
1535
  },
1487
1536
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1488
1537
  "kind": "interface",
@@ -1604,7 +1653,11 @@
1604
1653
  "datatype": true,
1605
1654
  "docs": {
1606
1655
  "stability": "stable",
1607
- "summary": "Query to endpoint service context provider."
1656
+ "summary": "Query to endpoint service context provider.",
1657
+ "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};",
1658
+ "custom": {
1659
+ "exampleMetadata": "fixture=_generated"
1660
+ }
1608
1661
  },
1609
1662
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1610
1663
  "kind": "interface",
@@ -1633,15 +1686,17 @@
1633
1686
  {
1634
1687
  "abstract": true,
1635
1688
  "docs": {
1689
+ "default": "- None",
1636
1690
  "stability": "stable",
1637
- "summary": "Query region."
1691
+ "summary": "The ARN of the role that should be used to look up the missing values."
1638
1692
  },
1639
1693
  "immutable": true,
1640
1694
  "locationInModule": {
1641
1695
  "filename": "lib/cloud-assembly/context-queries.ts",
1642
- "line": 247
1696
+ "line": 254
1643
1697
  },
1644
- "name": "region",
1698
+ "name": "lookupRoleArn",
1699
+ "optional": true,
1645
1700
  "type": {
1646
1701
  "primitive": "string"
1647
1702
  }
@@ -1650,14 +1705,14 @@
1650
1705
  "abstract": true,
1651
1706
  "docs": {
1652
1707
  "stability": "stable",
1653
- "summary": "Query service name."
1708
+ "summary": "Query region."
1654
1709
  },
1655
1710
  "immutable": true,
1656
1711
  "locationInModule": {
1657
1712
  "filename": "lib/cloud-assembly/context-queries.ts",
1658
- "line": 259
1713
+ "line": 247
1659
1714
  },
1660
- "name": "serviceName",
1715
+ "name": "region",
1661
1716
  "type": {
1662
1717
  "primitive": "string"
1663
1718
  }
@@ -1665,17 +1720,15 @@
1665
1720
  {
1666
1721
  "abstract": true,
1667
1722
  "docs": {
1668
- "default": "- None",
1669
1723
  "stability": "stable",
1670
- "summary": "The ARN of the role that should be used to look up the missing values."
1724
+ "summary": "Query service name."
1671
1725
  },
1672
1726
  "immutable": true,
1673
1727
  "locationInModule": {
1674
1728
  "filename": "lib/cloud-assembly/context-queries.ts",
1675
- "line": 254
1729
+ "line": 259
1676
1730
  },
1677
- "name": "lookupRoleArn",
1678
- "optional": true,
1731
+ "name": "serviceName",
1679
1732
  "type": {
1680
1733
  "primitive": "string"
1681
1734
  }
@@ -1688,7 +1741,11 @@
1688
1741
  "datatype": true,
1689
1742
  "docs": {
1690
1743
  "stability": "stable",
1691
- "summary": "A file asset."
1744
+ "summary": "A file asset.",
1745
+ "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};",
1746
+ "custom": {
1747
+ "exampleMetadata": "fixture=_generated"
1748
+ }
1692
1749
  },
1693
1750
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1694
1751
  "kind": "interface",
@@ -1743,7 +1800,11 @@
1743
1800
  "datatype": true,
1744
1801
  "docs": {
1745
1802
  "stability": "stable",
1746
- "summary": "Metadata Entry spec for files."
1803
+ "summary": "Metadata Entry spec for files.",
1804
+ "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};",
1805
+ "custom": {
1806
+ "exampleMetadata": "fixture=_generated"
1807
+ }
1747
1808
  },
1748
1809
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1749
1810
  "kind": "interface",
@@ -1904,7 +1965,11 @@
1904
1965
  "datatype": true,
1905
1966
  "docs": {
1906
1967
  "stability": "stable",
1907
- "summary": "Where in S3 a file asset needs to be published."
1968
+ "summary": "Where in S3 a file asset needs to be published.",
1969
+ "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};",
1970
+ "custom": {
1971
+ "exampleMetadata": "fixture=_generated"
1972
+ }
1908
1973
  },
1909
1974
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1910
1975
  "interfaces": [
@@ -1957,7 +2022,11 @@
1957
2022
  "datatype": true,
1958
2023
  "docs": {
1959
2024
  "stability": "stable",
1960
- "summary": "Describe the source of a file asset."
2025
+ "summary": "Describe the source of a file asset.",
2026
+ "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};",
2027
+ "custom": {
2028
+ "exampleMetadata": "fixture=_generated"
2029
+ }
1961
2030
  },
1962
2031
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1963
2032
  "kind": "interface",
@@ -2036,7 +2105,11 @@
2036
2105
  "datatype": true,
2037
2106
  "docs": {
2038
2107
  "stability": "stable",
2039
- "summary": "Query to hosted zone context provider."
2108
+ "summary": "Query to hosted zone context provider.",
2109
+ "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};",
2110
+ "custom": {
2111
+ "exampleMetadata": "fixture=_generated"
2112
+ }
2040
2113
  },
2041
2114
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
2042
2115
  "kind": "interface",
@@ -2066,30 +2139,14 @@
2066
2139
  "abstract": true,
2067
2140
  "docs": {
2068
2141
  "stability": "stable",
2069
- "summary": "The domain name e.g. example.com to lookup."
2070
- },
2071
- "immutable": true,
2072
- "locationInModule": {
2073
- "filename": "lib/cloud-assembly/context-queries.ts",
2074
- "line": 139
2075
- },
2076
- "name": "domainName",
2077
- "type": {
2078
- "primitive": "string"
2079
- }
2080
- },
2081
- {
2082
- "abstract": true,
2083
- "docs": {
2084
- "stability": "stable",
2085
- "summary": "Query region."
2142
+ "summary": "The domain name e.g. example.com to lookup."
2086
2143
  },
2087
2144
  "immutable": true,
2088
2145
  "locationInModule": {
2089
2146
  "filename": "lib/cloud-assembly/context-queries.ts",
2090
- "line": 127
2147
+ "line": 139
2091
2148
  },
2092
- "name": "region",
2149
+ "name": "domainName",
2093
2150
  "type": {
2094
2151
  "primitive": "string"
2095
2152
  }
@@ -2130,6 +2187,22 @@
2130
2187
  "primitive": "boolean"
2131
2188
  }
2132
2189
  },
2190
+ {
2191
+ "abstract": true,
2192
+ "docs": {
2193
+ "stability": "stable",
2194
+ "summary": "Query region."
2195
+ },
2196
+ "immutable": true,
2197
+ "locationInModule": {
2198
+ "filename": "lib/cloud-assembly/context-queries.ts",
2199
+ "line": 127
2200
+ },
2201
+ "name": "region",
2202
+ "type": {
2203
+ "primitive": "string"
2204
+ }
2205
+ },
2133
2206
  {
2134
2207
  "abstract": true,
2135
2208
  "docs": {
@@ -2157,13 +2230,17 @@
2157
2230
  "datatype": true,
2158
2231
  "docs": {
2159
2232
  "stability": "stable",
2160
- "summary": "Query input for looking up a KMS Key."
2233
+ "summary": "Query input for looking up a KMS Key.",
2234
+ "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};",
2235
+ "custom": {
2236
+ "exampleMetadata": "fixture=_generated"
2237
+ }
2161
2238
  },
2162
2239
  "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
2163
2240
  "kind": "interface",
2164
2241
  "locationInModule": {
2165
2242
  "filename": "lib/cloud-assembly/context-queries.ts",
2166
- "line": 426
2243
+ "line": 442
2167
2244
  },
2168
2245
  "name": "KeyContextQuery",
2169
2246
  "properties": [
@@ -2176,7 +2253,7 @@
2176
2253
  "immutable": true,
2177
2254
  "locationInModule": {
2178
2255
  "filename": "lib/cloud-assembly/context-queries.ts",
2179
- "line": 430
2256
+ "line": 446
2180
2257
  },
2181
2258
  "name": "account",
2182
2259
  "type": {
@@ -2192,7 +2269,7 @@
2192
2269
  "immutable": true,
2193
2270
  "locationInModule": {
2194
2271
  "filename": "lib/cloud-assembly/context-queries.ts",
2195
- "line": 447
2272
+ "line": 463
2196
2273
  },
2197
2274
  "name": "aliasName",
2198
2275
  "type": {
@@ -2202,15 +2279,17 @@
2202
2279
  {
2203
2280
  "abstract": true,
2204
2281
  "docs": {
2282
+ "default": "- None",
2205
2283
  "stability": "stable",
2206
- "summary": "Query region."
2284
+ "summary": "The ARN of the role that should be used to look up the missing values."
2207
2285
  },
2208
2286
  "immutable": true,
2209
2287
  "locationInModule": {
2210
2288
  "filename": "lib/cloud-assembly/context-queries.ts",
2211
- "line": 435
2289
+ "line": 458
2212
2290
  },
2213
- "name": "region",
2291
+ "name": "lookupRoleArn",
2292
+ "optional": true,
2214
2293
  "type": {
2215
2294
  "primitive": "string"
2216
2295
  }
@@ -2218,17 +2297,15 @@
2218
2297
  {
2219
2298
  "abstract": true,
2220
2299
  "docs": {
2221
- "default": "- None",
2222
2300
  "stability": "stable",
2223
- "summary": "The ARN of the role that should be used to look up the missing values."
2301
+ "summary": "Query region."
2224
2302
  },
2225
2303
  "immutable": true,
2226
2304
  "locationInModule": {
2227
2305
  "filename": "lib/cloud-assembly/context-queries.ts",
2228
- "line": 442
2306
+ "line": 451
2229
2307
  },
2230
- "name": "lookupRoleArn",
2231
- "optional": true,
2308
+ "name": "region",
2232
2309
  "type": {
2233
2310
  "primitive": "string"
2234
2311
  }
@@ -2241,7 +2318,11 @@
2241
2318
  "datatype": true,
2242
2319
  "docs": {
2243
2320
  "stability": "stable",
2244
- "summary": "Query input for looking up a load balancer."
2321
+ "summary": "Query input for looking up a load balancer.",
2322
+ "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};",
2323
+ "custom": {
2324
+ "exampleMetadata": "fixture=_generated"
2325
+ }
2245
2326
  },
2246
2327
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2247
2328
  "interfaces": [
@@ -2273,15 +2354,17 @@
2273
2354
  {
2274
2355
  "abstract": true,
2275
2356
  "docs": {
2357
+ "default": "- None",
2276
2358
  "stability": "stable",
2277
- "summary": "Query region."
2359
+ "summary": "The ARN of the role that should be used to look up the missing values."
2278
2360
  },
2279
2361
  "immutable": true,
2280
2362
  "locationInModule": {
2281
2363
  "filename": "lib/cloud-assembly/context-queries.ts",
2282
- "line": 311
2364
+ "line": 318
2283
2365
  },
2284
- "name": "region",
2366
+ "name": "lookupRoleArn",
2367
+ "optional": true,
2285
2368
  "type": {
2286
2369
  "primitive": "string"
2287
2370
  }
@@ -2289,17 +2372,15 @@
2289
2372
  {
2290
2373
  "abstract": true,
2291
2374
  "docs": {
2292
- "default": "- None",
2293
2375
  "stability": "stable",
2294
- "summary": "The ARN of the role that should be used to look up the missing values."
2376
+ "summary": "Query region."
2295
2377
  },
2296
2378
  "immutable": true,
2297
2379
  "locationInModule": {
2298
2380
  "filename": "lib/cloud-assembly/context-queries.ts",
2299
- "line": 318
2381
+ "line": 311
2300
2382
  },
2301
- "name": "lookupRoleArn",
2302
- "optional": true,
2383
+ "name": "region",
2303
2384
  "type": {
2304
2385
  "primitive": "string"
2305
2386
  }
@@ -2312,7 +2393,11 @@
2312
2393
  "datatype": true,
2313
2394
  "docs": {
2314
2395
  "stability": "stable",
2315
- "summary": "Filters for selecting load balancers."
2396
+ "summary": "Filters for selecting load balancers.",
2397
+ "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};",
2398
+ "custom": {
2399
+ "exampleMetadata": "fixture=_generated"
2400
+ }
2316
2401
  },
2317
2402
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2318
2403
  "kind": "interface",
@@ -2322,22 +2407,6 @@
2322
2407
  },
2323
2408
  "name": "LoadBalancerFilter",
2324
2409
  "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
2410
  {
2342
2411
  "abstract": true,
2343
2412
  "docs": {
@@ -2378,6 +2447,22 @@
2378
2447
  "kind": "array"
2379
2448
  }
2380
2449
  }
2450
+ },
2451
+ {
2452
+ "abstract": true,
2453
+ "docs": {
2454
+ "stability": "stable",
2455
+ "summary": "Filter load balancers by their type."
2456
+ },
2457
+ "immutable": true,
2458
+ "locationInModule": {
2459
+ "filename": "lib/cloud-assembly/context-queries.ts",
2460
+ "line": 284
2461
+ },
2462
+ "name": "loadBalancerType",
2463
+ "type": {
2464
+ "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2465
+ }
2381
2466
  }
2382
2467
  ],
2383
2468
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
@@ -2387,7 +2472,11 @@
2387
2472
  "datatype": true,
2388
2473
  "docs": {
2389
2474
  "stability": "stable",
2390
- "summary": "Query input for looking up a load balancer listener."
2475
+ "summary": "Query input for looking up a load balancer listener.",
2476
+ "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};",
2477
+ "custom": {
2478
+ "exampleMetadata": "fixture=_generated"
2479
+ }
2391
2480
  },
2392
2481
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2393
2482
  "interfaces": [
@@ -2416,22 +2505,6 @@
2416
2505
  "primitive": "string"
2417
2506
  }
2418
2507
  },
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
2508
  {
2436
2509
  "abstract": true,
2437
2510
  "docs": {
@@ -2503,6 +2576,22 @@
2503
2576
  "type": {
2504
2577
  "primitive": "string"
2505
2578
  }
2579
+ },
2580
+ {
2581
+ "abstract": true,
2582
+ "docs": {
2583
+ "stability": "stable",
2584
+ "summary": "Query region."
2585
+ },
2586
+ "immutable": true,
2587
+ "locationInModule": {
2588
+ "filename": "lib/cloud-assembly/context-queries.ts",
2589
+ "line": 368
2590
+ },
2591
+ "name": "region",
2592
+ "type": {
2593
+ "primitive": "string"
2594
+ }
2506
2595
  }
2507
2596
  ],
2508
2597
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
@@ -2544,23 +2633,23 @@
2544
2633
  {
2545
2634
  "docs": {
2546
2635
  "stability": "stable",
2547
- "summary": "TLS protocol."
2636
+ "summary": "TCP and UDP protocol."
2548
2637
  },
2549
- "name": "TLS"
2638
+ "name": "TCP_UDP"
2550
2639
  },
2551
2640
  {
2552
2641
  "docs": {
2553
2642
  "stability": "stable",
2554
- "summary": "UDP protocol."
2643
+ "summary": "TLS protocol."
2555
2644
  },
2556
- "name": "UDP"
2645
+ "name": "TLS"
2557
2646
  },
2558
2647
  {
2559
2648
  "docs": {
2560
2649
  "stability": "stable",
2561
- "summary": "TCP and UDP protocol."
2650
+ "summary": "UDP protocol."
2562
2651
  },
2563
- "name": "TCP_UDP"
2652
+ "name": "UDP"
2564
2653
  }
2565
2654
  ],
2566
2655
  "name": "LoadBalancerListenerProtocol",
@@ -2582,16 +2671,16 @@
2582
2671
  {
2583
2672
  "docs": {
2584
2673
  "stability": "stable",
2585
- "summary": "Network load balancer."
2674
+ "summary": "Application load balancer."
2586
2675
  },
2587
- "name": "NETWORK"
2676
+ "name": "APPLICATION"
2588
2677
  },
2589
2678
  {
2590
2679
  "docs": {
2591
2680
  "stability": "stable",
2592
- "summary": "Application load balancer."
2681
+ "summary": "Network load balancer."
2593
2682
  },
2594
- "name": "APPLICATION"
2683
+ "name": "NETWORK"
2595
2684
  }
2596
2685
  ],
2597
2686
  "name": "LoadBalancerType",
@@ -2809,7 +2898,11 @@
2809
2898
  "datatype": true,
2810
2899
  "docs": {
2811
2900
  "stability": "stable",
2812
- "summary": "A metadata entry in a cloud assembly artifact."
2901
+ "summary": "A metadata entry in a cloud assembly artifact.",
2902
+ "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};",
2903
+ "custom": {
2904
+ "exampleMetadata": "fixture=_generated"
2905
+ }
2813
2906
  },
2814
2907
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2815
2908
  "kind": "interface",
@@ -2819,22 +2912,6 @@
2819
2912
  },
2820
2913
  "name": "MetadataEntry",
2821
2914
  "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
2915
  {
2839
2916
  "abstract": true,
2840
2917
  "docs": {
@@ -2895,6 +2972,22 @@
2895
2972
  "kind": "array"
2896
2973
  }
2897
2974
  }
2975
+ },
2976
+ {
2977
+ "abstract": true,
2978
+ "docs": {
2979
+ "stability": "stable",
2980
+ "summary": "The type of the metadata entry."
2981
+ },
2982
+ "immutable": true,
2983
+ "locationInModule": {
2984
+ "filename": "lib/cloud-assembly/metadata-schema.ts",
2985
+ "line": 208
2986
+ },
2987
+ "name": "type",
2988
+ "type": {
2989
+ "primitive": "string"
2990
+ }
2898
2991
  }
2899
2992
  ],
2900
2993
  "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
@@ -2904,7 +2997,11 @@
2904
2997
  "datatype": true,
2905
2998
  "docs": {
2906
2999
  "stability": "stable",
2907
- "summary": "Represents a missing piece of context."
3000
+ "summary": "Represents a missing piece of context.",
3001
+ "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};",
3002
+ "custom": {
3003
+ "exampleMetadata": "fixture=_generated"
3004
+ }
2908
3005
  },
2909
3006
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2910
3007
  "kind": "interface",
@@ -3003,7 +3100,11 @@
3003
3100
  "datatype": true,
3004
3101
  "docs": {
3005
3102
  "stability": "stable",
3006
- "summary": "Artifact properties for nested cloud assemblies."
3103
+ "summary": "Artifact properties for nested cloud assemblies.",
3104
+ "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};",
3105
+ "custom": {
3106
+ "exampleMetadata": "fixture=_generated"
3107
+ }
3007
3108
  },
3008
3109
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
3009
3110
  "kind": "interface",
@@ -3055,7 +3156,11 @@
3055
3156
  "datatype": true,
3056
3157
  "docs": {
3057
3158
  "stability": "stable",
3058
- "summary": "Information about the application's runtime components."
3159
+ "summary": "Information about the application's runtime components.",
3160
+ "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};",
3161
+ "custom": {
3162
+ "exampleMetadata": "fixture=_generated"
3163
+ }
3059
3164
  },
3060
3165
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
3061
3166
  "kind": "interface",
@@ -3094,7 +3199,11 @@
3094
3199
  "datatype": true,
3095
3200
  "docs": {
3096
3201
  "stability": "stable",
3097
- "summary": "Query to SSM Parameter Context Provider."
3202
+ "summary": "Query to SSM Parameter Context Provider.",
3203
+ "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};",
3204
+ "custom": {
3205
+ "exampleMetadata": "fixture=_generated"
3206
+ }
3098
3207
  },
3099
3208
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
3100
3209
  "kind": "interface",
@@ -3123,15 +3232,17 @@
3123
3232
  {
3124
3233
  "abstract": true,
3125
3234
  "docs": {
3235
+ "default": "- None",
3126
3236
  "stability": "stable",
3127
- "summary": "Parameter name to query."
3237
+ "summary": "The ARN of the role that should be used to look up the missing values."
3128
3238
  },
3129
3239
  "immutable": true,
3130
3240
  "locationInModule": {
3131
3241
  "filename": "lib/cloud-assembly/context-queries.ts",
3132
- "line": 183
3242
+ "line": 178
3133
3243
  },
3134
- "name": "parameterName",
3244
+ "name": "lookupRoleArn",
3245
+ "optional": true,
3135
3246
  "type": {
3136
3247
  "primitive": "string"
3137
3248
  }
@@ -3140,14 +3251,14 @@
3140
3251
  "abstract": true,
3141
3252
  "docs": {
3142
3253
  "stability": "stable",
3143
- "summary": "Query region."
3254
+ "summary": "Parameter name to query."
3144
3255
  },
3145
3256
  "immutable": true,
3146
3257
  "locationInModule": {
3147
3258
  "filename": "lib/cloud-assembly/context-queries.ts",
3148
- "line": 171
3259
+ "line": 183
3149
3260
  },
3150
- "name": "region",
3261
+ "name": "parameterName",
3151
3262
  "type": {
3152
3263
  "primitive": "string"
3153
3264
  }
@@ -3155,17 +3266,15 @@
3155
3266
  {
3156
3267
  "abstract": true,
3157
3268
  "docs": {
3158
- "default": "- None",
3159
3269
  "stability": "stable",
3160
- "summary": "The ARN of the role that should be used to look up the missing values."
3270
+ "summary": "Query region."
3161
3271
  },
3162
3272
  "immutable": true,
3163
3273
  "locationInModule": {
3164
3274
  "filename": "lib/cloud-assembly/context-queries.ts",
3165
- "line": 178
3275
+ "line": 171
3166
3276
  },
3167
- "name": "lookupRoleArn",
3168
- "optional": true,
3277
+ "name": "region",
3169
3278
  "type": {
3170
3279
  "primitive": "string"
3171
3280
  }
@@ -3178,7 +3287,11 @@
3178
3287
  "datatype": true,
3179
3288
  "docs": {
3180
3289
  "stability": "stable",
3181
- "summary": "Query input for looking up a security group."
3290
+ "summary": "Query input for looking up a security group.",
3291
+ "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};",
3292
+ "custom": {
3293
+ "exampleMetadata": "fixture=_generated"
3294
+ }
3182
3295
  },
3183
3296
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
3184
3297
  "kind": "interface",
@@ -3204,6 +3317,24 @@
3204
3317
  "primitive": "string"
3205
3318
  }
3206
3319
  },
3320
+ {
3321
+ "abstract": true,
3322
+ "docs": {
3323
+ "default": "- None",
3324
+ "stability": "stable",
3325
+ "summary": "The ARN of the role that should be used to look up the missing values."
3326
+ },
3327
+ "immutable": true,
3328
+ "locationInModule": {
3329
+ "filename": "lib/cloud-assembly/context-queries.ts",
3330
+ "line": 415
3331
+ },
3332
+ "name": "lookupRoleArn",
3333
+ "optional": true,
3334
+ "type": {
3335
+ "primitive": "string"
3336
+ }
3337
+ },
3207
3338
  {
3208
3339
  "abstract": true,
3209
3340
  "docs": {
@@ -3223,15 +3354,17 @@
3223
3354
  {
3224
3355
  "abstract": true,
3225
3356
  "docs": {
3357
+ "default": "- None",
3226
3358
  "stability": "stable",
3227
3359
  "summary": "Security group id."
3228
3360
  },
3229
3361
  "immutable": true,
3230
3362
  "locationInModule": {
3231
3363
  "filename": "lib/cloud-assembly/context-queries.ts",
3232
- "line": 420
3364
+ "line": 422
3233
3365
  },
3234
3366
  "name": "securityGroupId",
3367
+ "optional": true,
3235
3368
  "type": {
3236
3369
  "primitive": "string"
3237
3370
  }
@@ -3241,14 +3374,32 @@
3241
3374
  "docs": {
3242
3375
  "default": "- None",
3243
3376
  "stability": "stable",
3244
- "summary": "The ARN of the role that should be used to look up the missing values."
3377
+ "summary": "Security group name."
3245
3378
  },
3246
3379
  "immutable": true,
3247
3380
  "locationInModule": {
3248
3381
  "filename": "lib/cloud-assembly/context-queries.ts",
3249
- "line": 415
3382
+ "line": 429
3250
3383
  },
3251
- "name": "lookupRoleArn",
3384
+ "name": "securityGroupName",
3385
+ "optional": true,
3386
+ "type": {
3387
+ "primitive": "string"
3388
+ }
3389
+ },
3390
+ {
3391
+ "abstract": true,
3392
+ "docs": {
3393
+ "default": "- None",
3394
+ "stability": "stable",
3395
+ "summary": "VPC ID."
3396
+ },
3397
+ "immutable": true,
3398
+ "locationInModule": {
3399
+ "filename": "lib/cloud-assembly/context-queries.ts",
3400
+ "line": 436
3401
+ },
3402
+ "name": "vpcId",
3252
3403
  "optional": true,
3253
3404
  "type": {
3254
3405
  "primitive": "string"
@@ -3262,7 +3413,11 @@
3262
3413
  "datatype": true,
3263
3414
  "docs": {
3264
3415
  "stability": "stable",
3265
- "summary": "Metadata Entry spec for stack tag."
3416
+ "summary": "Metadata Entry spec for stack tag.",
3417
+ "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};",
3418
+ "custom": {
3419
+ "exampleMetadata": "fixture=_generated"
3420
+ }
3266
3421
  },
3267
3422
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
3268
3423
  "kind": "interface",
@@ -3314,7 +3469,11 @@
3314
3469
  "datatype": true,
3315
3470
  "docs": {
3316
3471
  "stability": "stable",
3317
- "summary": "Artifact properties for the Construct Tree Artifact."
3472
+ "summary": "Artifact properties for the Construct Tree Artifact.",
3473
+ "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};",
3474
+ "custom": {
3475
+ "exampleMetadata": "fixture=_generated"
3476
+ }
3318
3477
  },
3319
3478
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3320
3479
  "kind": "interface",
@@ -3348,7 +3507,11 @@
3348
3507
  "datatype": true,
3349
3508
  "docs": {
3350
3509
  "stability": "stable",
3351
- "summary": "Query input for looking up a VPC."
3510
+ "summary": "Query input for looking up a VPC.",
3511
+ "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};",
3512
+ "custom": {
3513
+ "exampleMetadata": "fixture=_generated"
3514
+ }
3352
3515
  },
3353
3516
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3354
3517
  "kind": "interface",
@@ -3400,15 +3563,17 @@
3400
3563
  {
3401
3564
  "abstract": true,
3402
3565
  "docs": {
3566
+ "default": "- None",
3403
3567
  "stability": "stable",
3404
- "summary": "Query region."
3568
+ "summary": "The ARN of the role that should be used to look up the missing values."
3405
3569
  },
3406
3570
  "immutable": true,
3407
3571
  "locationInModule": {
3408
3572
  "filename": "lib/cloud-assembly/context-queries.ts",
3409
- "line": 198
3573
+ "line": 205
3410
3574
  },
3411
- "name": "region",
3575
+ "name": "lookupRoleArn",
3576
+ "optional": true,
3412
3577
  "type": {
3413
3578
  "primitive": "string"
3414
3579
  }
@@ -3416,17 +3581,15 @@
3416
3581
  {
3417
3582
  "abstract": true,
3418
3583
  "docs": {
3419
- "default": "- None",
3420
3584
  "stability": "stable",
3421
- "summary": "The ARN of the role that should be used to look up the missing values."
3585
+ "summary": "Query region."
3422
3586
  },
3423
3587
  "immutable": true,
3424
3588
  "locationInModule": {
3425
3589
  "filename": "lib/cloud-assembly/context-queries.ts",
3426
- "line": 205
3590
+ "line": 198
3427
3591
  },
3428
- "name": "lookupRoleArn",
3429
- "optional": true,
3592
+ "name": "region",
3430
3593
  "type": {
3431
3594
  "primitive": "string"
3432
3595
  }
@@ -3472,6 +3635,6 @@
3472
3635
  "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3473
3636
  }
3474
3637
  },
3475
- "version": "1.131.0",
3476
- "fingerprint": "AKO0CcwwHsOMhjVRpBqQ++Jz5NTEcfGwrz3Jtkcllyo="
3638
+ "version": "1.135.0",
3639
+ "fingerprint": "**********"
3477
3640
  }