@aws-cdk/cloud-assembly-schema 2.0.0-rc.7 → 2.1.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.30.0 (build adae23f)",
19
+ "jsiiVersion": "1.46.0 (build cd08c55)",
20
20
  "keywords": [
21
21
  "aws",
22
22
  "cdk"
@@ -24,11 +24,12 @@
24
24
  "license": "Apache-2.0",
25
25
  "metadata": {
26
26
  "jsii": {
27
+ "compiledWithDeprecationWarnings": true,
27
28
  "pacmak": {
28
29
  "hasDefaultInterfaces": true
29
30
  },
30
31
  "rosetta": {
31
- "strict": true
32
+ "strict": false
32
33
  }
33
34
  }
34
35
  },
@@ -73,13 +74,17 @@
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",
80
85
  "locationInModule": {
81
86
  "filename": "lib/cloud-assembly/context-queries.ts",
82
- "line": 56
87
+ "line": 61
83
88
  },
84
89
  "name": "AmiContextQuery",
85
90
  "properties": [
@@ -92,7 +97,7 @@
92
97
  "immutable": true,
93
98
  "locationInModule": {
94
99
  "filename": "lib/cloud-assembly/context-queries.ts",
95
- "line": 60
100
+ "line": 65
96
101
  },
97
102
  "name": "account",
98
103
  "type": {
@@ -108,7 +113,7 @@
108
113
  "immutable": true,
109
114
  "locationInModule": {
110
115
  "filename": "lib/cloud-assembly/context-queries.ts",
111
- "line": 84
116
+ "line": 89
112
117
  },
113
118
  "name": "filters",
114
119
  "type": {
@@ -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": 65
138
- },
139
- "name": "region",
140
- "type": {
141
- "primitive": "string"
142
- }
143
- },
144
133
  {
145
134
  "abstract": true,
146
135
  "docs": {
@@ -151,7 +140,7 @@
151
140
  "immutable": true,
152
141
  "locationInModule": {
153
142
  "filename": "lib/cloud-assembly/context-queries.ts",
154
- "line": 72
143
+ "line": 77
155
144
  },
156
145
  "name": "lookupRoleArn",
157
146
  "optional": true,
@@ -169,7 +158,7 @@
169
158
  "immutable": true,
170
159
  "locationInModule": {
171
160
  "filename": "lib/cloud-assembly/context-queries.ts",
172
- "line": 79
161
+ "line": 84
173
162
  },
174
163
  "name": "owners",
175
164
  "optional": true,
@@ -181,15 +170,36 @@
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
+ ],
191
+ "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
186
192
  },
187
193
  "@aws-cdk/cloud-assembly-schema.ArtifactManifest": {
188
194
  "assembly": "@aws-cdk/cloud-assembly-schema",
189
195
  "datatype": true,
190
196
  "docs": {
191
197
  "stability": "stable",
192
- "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
+ }
193
203
  },
194
204
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
195
205
  "kind": "interface",
@@ -199,22 +209,6 @@
199
209
  },
200
210
  "name": "ArtifactManifest",
201
211
  "properties": [
202
- {
203
- "abstract": true,
204
- "docs": {
205
- "stability": "stable",
206
- "summary": "The type of artifact."
207
- },
208
- "immutable": true,
209
- "locationInModule": {
210
- "filename": "lib/cloud-assembly/schema.ts",
211
- "line": 72
212
- },
213
- "name": "type",
214
- "type": {
215
- "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
216
- }
217
- },
218
212
  {
219
213
  "abstract": true,
220
214
  "docs": {
@@ -335,8 +329,25 @@
335
329
  ]
336
330
  }
337
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
+ }
338
348
  }
339
- ]
349
+ ],
350
+ "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
340
351
  },
341
352
  "@aws-cdk/cloud-assembly-schema.ArtifactMetadataEntryType": {
342
353
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -394,7 +405,8 @@
394
405
  "name": "STACK_TAGS"
395
406
  }
396
407
  ],
397
- "name": "ArtifactMetadataEntryType"
408
+ "name": "ArtifactMetadataEntryType",
409
+ "symbolId": "lib/cloud-assembly/metadata-schema:ArtifactMetadataEntryType"
398
410
  },
399
411
  "@aws-cdk/cloud-assembly-schema.ArtifactType": {
400
412
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -412,9 +424,9 @@
412
424
  {
413
425
  "docs": {
414
426
  "stability": "stable",
415
- "summary": "Stub required because of JSII."
427
+ "summary": "Manifest for all assets in the Cloud Assembly."
416
428
  },
417
- "name": "NONE"
429
+ "name": "ASSET_MANIFEST"
418
430
  },
419
431
  {
420
432
  "docs": {
@@ -433,26 +445,31 @@
433
445
  {
434
446
  "docs": {
435
447
  "stability": "stable",
436
- "summary": "Manifest for all assets in the Cloud Assembly."
448
+ "summary": "Nested Cloud Assembly."
437
449
  },
438
- "name": "ASSET_MANIFEST"
450
+ "name": "NESTED_CLOUD_ASSEMBLY"
439
451
  },
440
452
  {
441
453
  "docs": {
442
454
  "stability": "stable",
443
- "summary": "Nested Cloud Assembly."
455
+ "summary": "Stub required because of JSII."
444
456
  },
445
- "name": "NESTED_CLOUD_ASSEMBLY"
457
+ "name": "NONE"
446
458
  }
447
459
  ],
448
- "name": "ArtifactType"
460
+ "name": "ArtifactType",
461
+ "symbolId": "lib/cloud-assembly/schema:ArtifactType"
449
462
  },
450
463
  "@aws-cdk/cloud-assembly-schema.AssemblyManifest": {
451
464
  "assembly": "@aws-cdk/cloud-assembly-schema",
452
465
  "datatype": true,
453
466
  "docs": {
454
467
  "stability": "stable",
455
- "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
+ }
456
473
  },
457
474
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
458
475
  "kind": "interface",
@@ -462,22 +479,6 @@
462
479
  },
463
480
  "name": "AssemblyManifest",
464
481
  "properties": [
465
- {
466
- "abstract": true,
467
- "docs": {
468
- "stability": "stable",
469
- "summary": "Protocol version."
470
- },
471
- "immutable": true,
472
- "locationInModule": {
473
- "filename": "lib/cloud-assembly/schema.ts",
474
- "line": 117
475
- },
476
- "name": "version",
477
- "type": {
478
- "primitive": "string"
479
- }
480
- },
481
482
  {
482
483
  "abstract": true,
483
484
  "docs": {
@@ -542,15 +543,36 @@
542
543
  "type": {
543
544
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
544
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
+ }
545
562
  }
546
- ]
563
+ ],
564
+ "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
547
565
  },
548
566
  "@aws-cdk/cloud-assembly-schema.AssetManifest": {
549
567
  "assembly": "@aws-cdk/cloud-assembly-schema",
550
568
  "datatype": true,
551
569
  "docs": {
552
570
  "stability": "stable",
553
- "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
+ }
554
576
  },
555
577
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
556
578
  "kind": "interface",
@@ -560,22 +582,6 @@
560
582
  },
561
583
  "name": "AssetManifest",
562
584
  "properties": [
563
- {
564
- "abstract": true,
565
- "docs": {
566
- "stability": "stable",
567
- "summary": "Version of the manifest."
568
- },
569
- "immutable": true,
570
- "locationInModule": {
571
- "filename": "lib/assets/schema.ts",
572
- "line": 11
573
- },
574
- "name": "version",
575
- "type": {
576
- "primitive": "string"
577
- }
578
- },
579
585
  {
580
586
  "abstract": true,
581
587
  "docs": {
@@ -621,36 +627,60 @@
621
627
  "kind": "map"
622
628
  }
623
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
+ }
624
646
  }
625
- ]
647
+ ],
648
+ "symbolId": "lib/assets/schema:AssetManifest"
626
649
  },
627
650
  "@aws-cdk/cloud-assembly-schema.AssetManifestProperties": {
628
651
  "assembly": "@aws-cdk/cloud-assembly-schema",
629
652
  "datatype": true,
630
653
  "docs": {
631
654
  "stability": "stable",
632
- "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
+ }
633
660
  },
634
661
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
635
662
  "kind": "interface",
636
663
  "locationInModule": {
637
664
  "filename": "lib/cloud-assembly/artifact-schema.ts",
638
- "line": 92
665
+ "line": 99
639
666
  },
640
667
  "name": "AssetManifestProperties",
641
668
  "properties": [
642
669
  {
643
670
  "abstract": true,
644
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.",
645
674
  "stability": "stable",
646
- "summary": "Filename of the asset manifest."
675
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
647
676
  },
648
677
  "immutable": true,
649
678
  "locationInModule": {
650
679
  "filename": "lib/cloud-assembly/artifact-schema.ts",
651
- "line": 96
680
+ "line": 123
652
681
  },
653
- "name": "file",
682
+ "name": "bootstrapStackVersionSsmParameter",
683
+ "optional": true,
654
684
  "type": {
655
685
  "primitive": "string"
656
686
  }
@@ -658,18 +688,15 @@
658
688
  {
659
689
  "abstract": true,
660
690
  "docs": {
661
- "default": "- Bootstrap stack version number looked up",
662
- "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.",
663
691
  "stability": "stable",
664
- "summary": "SSM parameter where the bootstrap stack version number can be found."
692
+ "summary": "Filename of the asset manifest."
665
693
  },
666
694
  "immutable": true,
667
695
  "locationInModule": {
668
696
  "filename": "lib/cloud-assembly/artifact-schema.ts",
669
- "line": 116
697
+ "line": 103
670
698
  },
671
- "name": "bootstrapStackVersionSsmParameter",
672
- "optional": true,
699
+ "name": "file",
673
700
  "type": {
674
701
  "primitive": "string"
675
702
  }
@@ -684,7 +711,7 @@
684
711
  "immutable": true,
685
712
  "locationInModule": {
686
713
  "filename": "lib/cloud-assembly/artifact-schema.ts",
687
- "line": 103
714
+ "line": 110
688
715
  },
689
716
  "name": "requiresBootstrapStackVersion",
690
717
  "optional": true,
@@ -692,20 +719,25 @@
692
719
  "primitive": "number"
693
720
  }
694
721
  }
695
- ]
722
+ ],
723
+ "symbolId": "lib/cloud-assembly/artifact-schema:AssetManifestProperties"
696
724
  },
697
725
  "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery": {
698
726
  "assembly": "@aws-cdk/cloud-assembly-schema",
699
727
  "datatype": true,
700
728
  "docs": {
701
729
  "stability": "stable",
702
- "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
+ }
703
735
  },
704
736
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
705
737
  "kind": "interface",
706
738
  "locationInModule": {
707
739
  "filename": "lib/cloud-assembly/context-queries.ts",
708
- "line": 90
740
+ "line": 95
709
741
  },
710
742
  "name": "AvailabilityZonesContextQuery",
711
743
  "properties": [
@@ -718,7 +750,7 @@
718
750
  "immutable": true,
719
751
  "locationInModule": {
720
752
  "filename": "lib/cloud-assembly/context-queries.ts",
721
- "line": 94
753
+ "line": 99
722
754
  },
723
755
  "name": "account",
724
756
  "type": {
@@ -728,15 +760,17 @@
728
760
  {
729
761
  "abstract": true,
730
762
  "docs": {
763
+ "default": "- None",
731
764
  "stability": "stable",
732
- "summary": "Query region."
765
+ "summary": "The ARN of the role that should be used to look up the missing values."
733
766
  },
734
767
  "immutable": true,
735
768
  "locationInModule": {
736
769
  "filename": "lib/cloud-assembly/context-queries.ts",
737
- "line": 99
770
+ "line": 111
738
771
  },
739
- "name": "region",
772
+ "name": "lookupRoleArn",
773
+ "optional": true,
740
774
  "type": {
741
775
  "primitive": "string"
742
776
  }
@@ -744,29 +778,32 @@
744
778
  {
745
779
  "abstract": true,
746
780
  "docs": {
747
- "default": "- None",
748
781
  "stability": "stable",
749
- "summary": "The ARN of the role that should be used to look up the missing values."
782
+ "summary": "Query region."
750
783
  },
751
784
  "immutable": true,
752
785
  "locationInModule": {
753
786
  "filename": "lib/cloud-assembly/context-queries.ts",
754
- "line": 106
787
+ "line": 104
755
788
  },
756
- "name": "lookupRoleArn",
757
- "optional": true,
789
+ "name": "region",
758
790
  "type": {
759
791
  "primitive": "string"
760
792
  }
761
793
  }
762
- ]
794
+ ],
795
+ "symbolId": "lib/cloud-assembly/context-queries:AvailabilityZonesContextQuery"
763
796
  },
764
797
  "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties": {
765
798
  "assembly": "@aws-cdk/cloud-assembly-schema",
766
799
  "datatype": true,
767
800
  "docs": {
768
801
  "stability": "stable",
769
- "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
+ }
770
807
  },
771
808
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
772
809
  "kind": "interface",
@@ -779,15 +816,17 @@
779
816
  {
780
817
  "abstract": true,
781
818
  "docs": {
819
+ "default": "- No role is assumed (current credentials are used)",
782
820
  "stability": "stable",
783
- "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
821
+ "summary": "The role that needs to be assumed to deploy the stack."
784
822
  },
785
823
  "immutable": true,
786
824
  "locationInModule": {
787
825
  "filename": "lib/cloud-assembly/artifact-schema.ts",
788
- "line": 9
826
+ "line": 43
789
827
  },
790
- "name": "templateFile",
828
+ "name": "assumeRoleArn",
829
+ "optional": true,
791
830
  "type": {
792
831
  "primitive": "string"
793
832
  }
@@ -795,16 +834,16 @@
795
834
  {
796
835
  "abstract": true,
797
836
  "docs": {
798
- "default": "- No role is assumed (current credentials are used)",
837
+ "default": "- No external ID",
799
838
  "stability": "stable",
800
- "summary": "The role that needs to be assumed to deploy the stack."
839
+ "summary": "External ID to use when assuming role for cloudformation deployments."
801
840
  },
802
841
  "immutable": true,
803
842
  "locationInModule": {
804
843
  "filename": "lib/cloud-assembly/artifact-schema.ts",
805
- "line": 43
844
+ "line": 50
806
845
  },
807
- "name": "assumeRoleArn",
846
+ "name": "assumeRoleExternalId",
808
847
  "optional": true,
809
848
  "type": {
810
849
  "primitive": "string"
@@ -821,7 +860,7 @@
821
860
  "immutable": true,
822
861
  "locationInModule": {
823
862
  "filename": "lib/cloud-assembly/artifact-schema.ts",
824
- "line": 79
863
+ "line": 86
825
864
  },
826
865
  "name": "bootstrapStackVersionSsmParameter",
827
866
  "optional": true,
@@ -839,7 +878,7 @@
839
878
  "immutable": true,
840
879
  "locationInModule": {
841
880
  "filename": "lib/cloud-assembly/artifact-schema.ts",
842
- "line": 50
881
+ "line": 57
843
882
  },
844
883
  "name": "cloudFormationExecutionRoleArn",
845
884
  "optional": true,
@@ -880,7 +919,7 @@
880
919
  "immutable": true,
881
920
  "locationInModule": {
882
921
  "filename": "lib/cloud-assembly/artifact-schema.ts",
883
- "line": 64
922
+ "line": 71
884
923
  },
885
924
  "name": "requiresBootstrapStackVersion",
886
925
  "optional": true,
@@ -916,7 +955,7 @@
916
955
  "immutable": true,
917
956
  "locationInModule": {
918
957
  "filename": "lib/cloud-assembly/artifact-schema.ts",
919
- "line": 57
958
+ "line": 64
920
959
  },
921
960
  "name": "stackTemplateAssetObjectUrl",
922
961
  "optional": true,
@@ -947,6 +986,22 @@
947
986
  }
948
987
  }
949
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
+ },
950
1005
  {
951
1006
  "abstract": true,
952
1007
  "docs": {
@@ -975,7 +1030,7 @@
975
1030
  "immutable": true,
976
1031
  "locationInModule": {
977
1032
  "filename": "lib/cloud-assembly/artifact-schema.ts",
978
- "line": 86
1033
+ "line": 93
979
1034
  },
980
1035
  "name": "validateOnSynth",
981
1036
  "optional": true,
@@ -983,14 +1038,19 @@
983
1038
  "primitive": "boolean"
984
1039
  }
985
1040
  }
986
- ]
1041
+ ],
1042
+ "symbolId": "lib/cloud-assembly/artifact-schema:AwsCloudFormationStackProperties"
987
1043
  },
988
1044
  "@aws-cdk/cloud-assembly-schema.AwsDestination": {
989
1045
  "assembly": "@aws-cdk/cloud-assembly-schema",
990
1046
  "datatype": true,
991
1047
  "docs": {
992
1048
  "stability": "stable",
993
- "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
+ }
994
1054
  },
995
1055
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
996
1056
  "kind": "interface",
@@ -1054,14 +1114,19 @@
1054
1114
  "primitive": "string"
1055
1115
  }
1056
1116
  }
1057
- ]
1117
+ ],
1118
+ "symbolId": "lib/assets/aws-destination:AwsDestination"
1058
1119
  },
1059
1120
  "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry": {
1060
1121
  "assembly": "@aws-cdk/cloud-assembly-schema",
1061
1122
  "datatype": true,
1062
1123
  "docs": {
1063
1124
  "stability": "stable",
1064
- "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
+ }
1065
1130
  },
1066
1131
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1067
1132
  "kind": "interface",
@@ -1074,31 +1139,40 @@
1074
1139
  {
1075
1140
  "abstract": true,
1076
1141
  "docs": {
1142
+ "default": "no build args are passed",
1077
1143
  "stability": "stable",
1078
- "summary": "Logical identifier for the asset."
1144
+ "summary": "Build args to pass to the `docker build` command."
1079
1145
  },
1080
1146
  "immutable": true,
1081
1147
  "locationInModule": {
1082
1148
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1083
- "line": 13
1149
+ "line": 119
1084
1150
  },
1085
- "name": "id",
1151
+ "name": "buildArgs",
1152
+ "optional": true,
1086
1153
  "type": {
1087
- "primitive": "string"
1154
+ "collection": {
1155
+ "elementtype": {
1156
+ "primitive": "string"
1157
+ },
1158
+ "kind": "map"
1159
+ }
1088
1160
  }
1089
1161
  },
1090
1162
  {
1091
1163
  "abstract": true,
1092
1164
  "docs": {
1165
+ "default": "- no file is passed",
1093
1166
  "stability": "stable",
1094
- "summary": "Type of asset."
1167
+ "summary": "Path to the Dockerfile (relative to the directory)."
1095
1168
  },
1096
1169
  "immutable": true,
1097
1170
  "locationInModule": {
1098
1171
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1099
- "line": 81
1172
+ "line": 133
1100
1173
  },
1101
- "name": "packaging",
1174
+ "name": "file",
1175
+ "optional": true,
1102
1176
  "type": {
1103
1177
  "primitive": "string"
1104
1178
  }
@@ -1107,14 +1181,14 @@
1107
1181
  "abstract": true,
1108
1182
  "docs": {
1109
1183
  "stability": "stable",
1110
- "summary": "Path on disk to the asset."
1184
+ "summary": "Logical identifier for the asset."
1111
1185
  },
1112
1186
  "immutable": true,
1113
1187
  "locationInModule": {
1114
1188
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1115
- "line": 23
1189
+ "line": 13
1116
1190
  },
1117
- "name": "path",
1191
+ "name": "id",
1118
1192
  "type": {
1119
1193
  "primitive": "string"
1120
1194
  }
@@ -1122,15 +1196,18 @@
1122
1196
  {
1123
1197
  "abstract": true,
1124
1198
  "docs": {
1125
- "stability": "stable",
1126
- "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."
1127
1203
  },
1128
1204
  "immutable": true,
1129
1205
  "locationInModule": {
1130
1206
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1131
- "line": 18
1207
+ "line": 93
1132
1208
  },
1133
- "name": "sourceHash",
1209
+ "name": "imageNameParameter",
1210
+ "optional": true,
1134
1211
  "type": {
1135
1212
  "primitive": "string"
1136
1213
  }
@@ -1138,40 +1215,34 @@
1138
1215
  {
1139
1216
  "abstract": true,
1140
1217
  "docs": {
1141
- "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).",
1142
1220
  "stability": "stable",
1143
- "summary": "Build args to pass to the `docker build` command."
1221
+ "summary": "The docker image tag to use for tagging pushed images."
1144
1222
  },
1145
1223
  "immutable": true,
1146
1224
  "locationInModule": {
1147
1225
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1148
- "line": 119
1226
+ "line": 112
1149
1227
  },
1150
- "name": "buildArgs",
1228
+ "name": "imageTag",
1151
1229
  "optional": true,
1152
1230
  "type": {
1153
- "collection": {
1154
- "elementtype": {
1155
- "primitive": "string"
1156
- },
1157
- "kind": "map"
1158
- }
1231
+ "primitive": "string"
1159
1232
  }
1160
1233
  },
1161
1234
  {
1162
1235
  "abstract": true,
1163
1236
  "docs": {
1164
- "default": "- no file is passed",
1165
1237
  "stability": "stable",
1166
- "summary": "Path to the Dockerfile (relative to the directory)."
1238
+ "summary": "Type of asset."
1167
1239
  },
1168
1240
  "immutable": true,
1169
1241
  "locationInModule": {
1170
1242
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1171
- "line": 133
1243
+ "line": 81
1172
1244
  },
1173
- "name": "file",
1174
- "optional": true,
1245
+ "name": "packaging",
1175
1246
  "type": {
1176
1247
  "primitive": "string"
1177
1248
  }
@@ -1179,18 +1250,15 @@
1179
1250
  {
1180
1251
  "abstract": true,
1181
1252
  "docs": {
1182
- "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1183
- "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1184
- "stability": "deprecated",
1185
- "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."
1186
1255
  },
1187
1256
  "immutable": true,
1188
1257
  "locationInModule": {
1189
1258
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1190
- "line": 93
1259
+ "line": 23
1191
1260
  },
1192
- "name": "imageNameParameter",
1193
- "optional": true,
1261
+ "name": "path",
1194
1262
  "type": {
1195
1263
  "primitive": "string"
1196
1264
  }
@@ -1199,16 +1267,16 @@
1199
1267
  "abstract": true,
1200
1268
  "docs": {
1201
1269
  "default": "- this parameter is REQUIRED after 1.21.0",
1202
- "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.",
1203
1271
  "stability": "stable",
1204
- "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."
1205
1273
  },
1206
1274
  "immutable": true,
1207
1275
  "locationInModule": {
1208
1276
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1209
- "line": 112
1277
+ "line": 103
1210
1278
  },
1211
- "name": "imageTag",
1279
+ "name": "repositoryName",
1212
1280
  "optional": true,
1213
1281
  "type": {
1214
1282
  "primitive": "string"
@@ -1217,18 +1285,15 @@
1217
1285
  {
1218
1286
  "abstract": true,
1219
1287
  "docs": {
1220
- "default": "- this parameter is REQUIRED after 1.21.0",
1221
- "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.",
1222
1288
  "stability": "stable",
1223
- "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."
1224
1290
  },
1225
1291
  "immutable": true,
1226
1292
  "locationInModule": {
1227
1293
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1228
- "line": 103
1294
+ "line": 18
1229
1295
  },
1230
- "name": "repositoryName",
1231
- "optional": true,
1296
+ "name": "sourceHash",
1232
1297
  "type": {
1233
1298
  "primitive": "string"
1234
1299
  }
@@ -1251,7 +1316,8 @@
1251
1316
  "primitive": "string"
1252
1317
  }
1253
1318
  }
1254
- ]
1319
+ ],
1320
+ "symbolId": "lib/cloud-assembly/metadata-schema:ContainerImageAssetMetadataEntry"
1255
1321
  },
1256
1322
  "@aws-cdk/cloud-assembly-schema.ContextProvider": {
1257
1323
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1283,30 +1349,30 @@
1283
1349
  {
1284
1350
  "docs": {
1285
1351
  "stability": "stable",
1286
- "summary": "Route53 Hosted Zone provider."
1352
+ "summary": "VPC Endpoint Service AZ Provider."
1287
1353
  },
1288
- "name": "HOSTED_ZONE_PROVIDER"
1354
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1289
1355
  },
1290
1356
  {
1291
1357
  "docs": {
1292
1358
  "stability": "stable",
1293
- "summary": "SSM Parameter Provider."
1359
+ "summary": "Route53 Hosted Zone provider."
1294
1360
  },
1295
- "name": "SSM_PARAMETER_PROVIDER"
1361
+ "name": "HOSTED_ZONE_PROVIDER"
1296
1362
  },
1297
1363
  {
1298
1364
  "docs": {
1299
1365
  "stability": "stable",
1300
- "summary": "VPC Provider."
1366
+ "summary": "KMS Key Provider."
1301
1367
  },
1302
- "name": "VPC_PROVIDER"
1368
+ "name": "KEY_PROVIDER"
1303
1369
  },
1304
1370
  {
1305
1371
  "docs": {
1306
1372
  "stability": "stable",
1307
- "summary": "VPC Endpoint Service AZ Provider."
1373
+ "summary": "Load balancer listener provider."
1308
1374
  },
1309
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1375
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1310
1376
  },
1311
1377
  {
1312
1378
  "docs": {
@@ -1318,26 +1384,38 @@
1318
1384
  {
1319
1385
  "docs": {
1320
1386
  "stability": "stable",
1321
- "summary": "Load balancer listener provider."
1387
+ "summary": "Security group provider."
1322
1388
  },
1323
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1389
+ "name": "SECURITY_GROUP_PROVIDER"
1324
1390
  },
1325
1391
  {
1326
1392
  "docs": {
1327
1393
  "stability": "stable",
1328
- "summary": "Security group provider."
1394
+ "summary": "SSM Parameter Provider."
1329
1395
  },
1330
- "name": "SECURITY_GROUP_PROVIDER"
1396
+ "name": "SSM_PARAMETER_PROVIDER"
1397
+ },
1398
+ {
1399
+ "docs": {
1400
+ "stability": "stable",
1401
+ "summary": "VPC Provider."
1402
+ },
1403
+ "name": "VPC_PROVIDER"
1331
1404
  }
1332
1405
  ],
1333
- "name": "ContextProvider"
1406
+ "name": "ContextProvider",
1407
+ "symbolId": "lib/cloud-assembly/context-queries:ContextProvider"
1334
1408
  },
1335
1409
  "@aws-cdk/cloud-assembly-schema.DockerImageAsset": {
1336
1410
  "assembly": "@aws-cdk/cloud-assembly-schema",
1337
1411
  "datatype": true,
1338
1412
  "docs": {
1339
1413
  "stability": "stable",
1340
- "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
+ }
1341
1419
  },
1342
1420
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1343
1421
  "kind": "interface",
@@ -1384,14 +1462,19 @@
1384
1462
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource"
1385
1463
  }
1386
1464
  }
1387
- ]
1465
+ ],
1466
+ "symbolId": "lib/assets/docker-image-asset:DockerImageAsset"
1388
1467
  },
1389
1468
  "@aws-cdk/cloud-assembly-schema.DockerImageDestination": {
1390
1469
  "assembly": "@aws-cdk/cloud-assembly-schema",
1391
1470
  "datatype": true,
1392
1471
  "docs": {
1393
1472
  "stability": "stable",
1394
- "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
+ }
1395
1478
  },
1396
1479
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1397
1480
  "interfaces": [
@@ -1436,14 +1519,19 @@
1436
1519
  "primitive": "string"
1437
1520
  }
1438
1521
  }
1439
- ]
1522
+ ],
1523
+ "symbolId": "lib/assets/docker-image-asset:DockerImageDestination"
1440
1524
  },
1441
1525
  "@aws-cdk/cloud-assembly-schema.DockerImageSource": {
1442
1526
  "assembly": "@aws-cdk/cloud-assembly-schema",
1443
1527
  "datatype": true,
1444
1528
  "docs": {
1445
1529
  "stability": "stable",
1446
- "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
+ }
1447
1535
  },
1448
1536
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1449
1537
  "kind": "interface",
@@ -1557,20 +1645,25 @@
1557
1645
  }
1558
1646
  }
1559
1647
  }
1560
- ]
1648
+ ],
1649
+ "symbolId": "lib/assets/docker-image-asset:DockerImageSource"
1561
1650
  },
1562
1651
  "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery": {
1563
1652
  "assembly": "@aws-cdk/cloud-assembly-schema",
1564
1653
  "datatype": true,
1565
1654
  "docs": {
1566
1655
  "stability": "stable",
1567
- "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
+ }
1568
1661
  },
1569
1662
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1570
1663
  "kind": "interface",
1571
1664
  "locationInModule": {
1572
1665
  "filename": "lib/cloud-assembly/context-queries.ts",
1573
- "line": 233
1666
+ "line": 238
1574
1667
  },
1575
1668
  "name": "EndpointServiceAvailabilityZonesContextQuery",
1576
1669
  "properties": [
@@ -1583,7 +1676,7 @@
1583
1676
  "immutable": true,
1584
1677
  "locationInModule": {
1585
1678
  "filename": "lib/cloud-assembly/context-queries.ts",
1586
- "line": 237
1679
+ "line": 242
1587
1680
  },
1588
1681
  "name": "account",
1589
1682
  "type": {
@@ -1593,15 +1686,17 @@
1593
1686
  {
1594
1687
  "abstract": true,
1595
1688
  "docs": {
1689
+ "default": "- None",
1596
1690
  "stability": "stable",
1597
- "summary": "Query region."
1691
+ "summary": "The ARN of the role that should be used to look up the missing values."
1598
1692
  },
1599
1693
  "immutable": true,
1600
1694
  "locationInModule": {
1601
1695
  "filename": "lib/cloud-assembly/context-queries.ts",
1602
- "line": 242
1696
+ "line": 254
1603
1697
  },
1604
- "name": "region",
1698
+ "name": "lookupRoleArn",
1699
+ "optional": true,
1605
1700
  "type": {
1606
1701
  "primitive": "string"
1607
1702
  }
@@ -1610,14 +1705,14 @@
1610
1705
  "abstract": true,
1611
1706
  "docs": {
1612
1707
  "stability": "stable",
1613
- "summary": "Query service name."
1708
+ "summary": "Query region."
1614
1709
  },
1615
1710
  "immutable": true,
1616
1711
  "locationInModule": {
1617
1712
  "filename": "lib/cloud-assembly/context-queries.ts",
1618
- "line": 254
1713
+ "line": 247
1619
1714
  },
1620
- "name": "serviceName",
1715
+ "name": "region",
1621
1716
  "type": {
1622
1717
  "primitive": "string"
1623
1718
  }
@@ -1625,29 +1720,32 @@
1625
1720
  {
1626
1721
  "abstract": true,
1627
1722
  "docs": {
1628
- "default": "- None",
1629
1723
  "stability": "stable",
1630
- "summary": "The ARN of the role that should be used to look up the missing values."
1724
+ "summary": "Query service name."
1631
1725
  },
1632
1726
  "immutable": true,
1633
1727
  "locationInModule": {
1634
1728
  "filename": "lib/cloud-assembly/context-queries.ts",
1635
- "line": 249
1729
+ "line": 259
1636
1730
  },
1637
- "name": "lookupRoleArn",
1638
- "optional": true,
1731
+ "name": "serviceName",
1639
1732
  "type": {
1640
1733
  "primitive": "string"
1641
1734
  }
1642
1735
  }
1643
- ]
1736
+ ],
1737
+ "symbolId": "lib/cloud-assembly/context-queries:EndpointServiceAvailabilityZonesContextQuery"
1644
1738
  },
1645
1739
  "@aws-cdk/cloud-assembly-schema.FileAsset": {
1646
1740
  "assembly": "@aws-cdk/cloud-assembly-schema",
1647
1741
  "datatype": true,
1648
1742
  "docs": {
1649
1743
  "stability": "stable",
1650
- "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
+ }
1651
1749
  },
1652
1750
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1653
1751
  "kind": "interface",
@@ -1694,14 +1792,19 @@
1694
1792
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource"
1695
1793
  }
1696
1794
  }
1697
- ]
1795
+ ],
1796
+ "symbolId": "lib/assets/file-asset:FileAsset"
1698
1797
  },
1699
1798
  "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry": {
1700
1799
  "assembly": "@aws-cdk/cloud-assembly-schema",
1701
1800
  "datatype": true,
1702
1801
  "docs": {
1703
1802
  "stability": "stable",
1704
- "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
+ }
1705
1808
  },
1706
1809
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1707
1810
  "kind": "interface",
@@ -1823,7 +1926,8 @@
1823
1926
  "primitive": "string"
1824
1927
  }
1825
1928
  }
1826
- ]
1929
+ ],
1930
+ "symbolId": "lib/cloud-assembly/metadata-schema:FileAssetMetadataEntry"
1827
1931
  },
1828
1932
  "@aws-cdk/cloud-assembly-schema.FileAssetPackaging": {
1829
1933
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1853,14 +1957,19 @@
1853
1957
  "name": "ZIP_DIRECTORY"
1854
1958
  }
1855
1959
  ],
1856
- "name": "FileAssetPackaging"
1960
+ "name": "FileAssetPackaging",
1961
+ "symbolId": "lib/assets/file-asset:FileAssetPackaging"
1857
1962
  },
1858
1963
  "@aws-cdk/cloud-assembly-schema.FileDestination": {
1859
1964
  "assembly": "@aws-cdk/cloud-assembly-schema",
1860
1965
  "datatype": true,
1861
1966
  "docs": {
1862
1967
  "stability": "stable",
1863
- "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
+ }
1864
1973
  },
1865
1974
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1866
1975
  "interfaces": [
@@ -1905,14 +2014,19 @@
1905
2014
  "primitive": "string"
1906
2015
  }
1907
2016
  }
1908
- ]
2017
+ ],
2018
+ "symbolId": "lib/assets/file-asset:FileDestination"
1909
2019
  },
1910
2020
  "@aws-cdk/cloud-assembly-schema.FileSource": {
1911
2021
  "assembly": "@aws-cdk/cloud-assembly-schema",
1912
2022
  "datatype": true,
1913
2023
  "docs": {
1914
2024
  "stability": "stable",
1915
- "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
+ }
1916
2030
  },
1917
2031
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1918
2032
  "kind": "interface",
@@ -1983,20 +2097,25 @@
1983
2097
  "primitive": "string"
1984
2098
  }
1985
2099
  }
1986
- ]
2100
+ ],
2101
+ "symbolId": "lib/assets/file-asset:FileSource"
1987
2102
  },
1988
2103
  "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery": {
1989
2104
  "assembly": "@aws-cdk/cloud-assembly-schema",
1990
2105
  "datatype": true,
1991
2106
  "docs": {
1992
2107
  "stability": "stable",
1993
- "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
+ }
1994
2113
  },
1995
2114
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
1996
2115
  "kind": "interface",
1997
2116
  "locationInModule": {
1998
2117
  "filename": "lib/cloud-assembly/context-queries.ts",
1999
- "line": 113
2118
+ "line": 118
2000
2119
  },
2001
2120
  "name": "HostedZoneContextQuery",
2002
2121
  "properties": [
@@ -2009,7 +2128,7 @@
2009
2128
  "immutable": true,
2010
2129
  "locationInModule": {
2011
2130
  "filename": "lib/cloud-assembly/context-queries.ts",
2012
- "line": 117
2131
+ "line": 122
2013
2132
  },
2014
2133
  "name": "account",
2015
2134
  "type": {
@@ -2025,13 +2144,49 @@
2025
2144
  "immutable": true,
2026
2145
  "locationInModule": {
2027
2146
  "filename": "lib/cloud-assembly/context-queries.ts",
2028
- "line": 134
2147
+ "line": 139
2029
2148
  },
2030
2149
  "name": "domainName",
2031
2150
  "type": {
2032
2151
  "primitive": "string"
2033
2152
  }
2034
2153
  },
2154
+ {
2155
+ "abstract": true,
2156
+ "docs": {
2157
+ "default": "- None",
2158
+ "stability": "stable",
2159
+ "summary": "The ARN of the role that should be used to look up the missing values."
2160
+ },
2161
+ "immutable": true,
2162
+ "locationInModule": {
2163
+ "filename": "lib/cloud-assembly/context-queries.ts",
2164
+ "line": 134
2165
+ },
2166
+ "name": "lookupRoleArn",
2167
+ "optional": true,
2168
+ "type": {
2169
+ "primitive": "string"
2170
+ }
2171
+ },
2172
+ {
2173
+ "abstract": true,
2174
+ "docs": {
2175
+ "default": "false",
2176
+ "stability": "stable",
2177
+ "summary": "True if the zone you want to find is a private hosted zone."
2178
+ },
2179
+ "immutable": true,
2180
+ "locationInModule": {
2181
+ "filename": "lib/cloud-assembly/context-queries.ts",
2182
+ "line": 146
2183
+ },
2184
+ "name": "privateZone",
2185
+ "optional": true,
2186
+ "type": {
2187
+ "primitive": "boolean"
2188
+ }
2189
+ },
2035
2190
  {
2036
2191
  "abstract": true,
2037
2192
  "docs": {
@@ -2041,9 +2196,66 @@
2041
2196
  "immutable": true,
2042
2197
  "locationInModule": {
2043
2198
  "filename": "lib/cloud-assembly/context-queries.ts",
2044
- "line": 122
2199
+ "line": 127
2200
+ },
2201
+ "name": "region",
2202
+ "type": {
2203
+ "primitive": "string"
2204
+ }
2205
+ },
2206
+ {
2207
+ "abstract": true,
2208
+ "docs": {
2209
+ "default": "- Required if privateZone=true",
2210
+ "remarks": "If you provide VPC ID and privateZone is false, this will return no results\nand raise an error.",
2211
+ "stability": "stable",
2212
+ "summary": "The VPC ID to that the private zone must be associated with."
2213
+ },
2214
+ "immutable": true,
2215
+ "locationInModule": {
2216
+ "filename": "lib/cloud-assembly/context-queries.ts",
2217
+ "line": 156
2218
+ },
2219
+ "name": "vpcId",
2220
+ "optional": true,
2221
+ "type": {
2222
+ "primitive": "string"
2223
+ }
2224
+ }
2225
+ ],
2226
+ "symbolId": "lib/cloud-assembly/context-queries:HostedZoneContextQuery"
2227
+ },
2228
+ "@aws-cdk/cloud-assembly-schema.KeyContextQuery": {
2229
+ "assembly": "@aws-cdk/cloud-assembly-schema",
2230
+ "datatype": true,
2231
+ "docs": {
2232
+ "stability": "stable",
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
+ }
2238
+ },
2239
+ "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
2240
+ "kind": "interface",
2241
+ "locationInModule": {
2242
+ "filename": "lib/cloud-assembly/context-queries.ts",
2243
+ "line": 442
2244
+ },
2245
+ "name": "KeyContextQuery",
2246
+ "properties": [
2247
+ {
2248
+ "abstract": true,
2249
+ "docs": {
2250
+ "stability": "stable",
2251
+ "summary": "Query account."
2252
+ },
2253
+ "immutable": true,
2254
+ "locationInModule": {
2255
+ "filename": "lib/cloud-assembly/context-queries.ts",
2256
+ "line": 446
2045
2257
  },
2046
- "name": "region",
2258
+ "name": "account",
2047
2259
  "type": {
2048
2260
  "primitive": "string"
2049
2261
  }
@@ -2051,17 +2263,15 @@
2051
2263
  {
2052
2264
  "abstract": true,
2053
2265
  "docs": {
2054
- "default": "- None",
2055
2266
  "stability": "stable",
2056
- "summary": "The ARN of the role that should be used to look up the missing values."
2267
+ "summary": "Alias name used to search the Key."
2057
2268
  },
2058
2269
  "immutable": true,
2059
2270
  "locationInModule": {
2060
2271
  "filename": "lib/cloud-assembly/context-queries.ts",
2061
- "line": 129
2272
+ "line": 463
2062
2273
  },
2063
- "name": "lookupRoleArn",
2064
- "optional": true,
2274
+ "name": "aliasName",
2065
2275
  "type": {
2066
2276
  "primitive": "string"
2067
2277
  }
@@ -2069,48 +2279,50 @@
2069
2279
  {
2070
2280
  "abstract": true,
2071
2281
  "docs": {
2072
- "default": "false",
2282
+ "default": "- None",
2073
2283
  "stability": "stable",
2074
- "summary": "True if the zone you want to find is a private hosted zone."
2284
+ "summary": "The ARN of the role that should be used to look up the missing values."
2075
2285
  },
2076
2286
  "immutable": true,
2077
2287
  "locationInModule": {
2078
2288
  "filename": "lib/cloud-assembly/context-queries.ts",
2079
- "line": 141
2289
+ "line": 458
2080
2290
  },
2081
- "name": "privateZone",
2291
+ "name": "lookupRoleArn",
2082
2292
  "optional": true,
2083
2293
  "type": {
2084
- "primitive": "boolean"
2294
+ "primitive": "string"
2085
2295
  }
2086
2296
  },
2087
2297
  {
2088
2298
  "abstract": true,
2089
2299
  "docs": {
2090
- "default": "- Required if privateZone=true",
2091
- "remarks": "If you provide VPC ID and privateZone is false, this will return no results\nand raise an error.",
2092
2300
  "stability": "stable",
2093
- "summary": "The VPC ID to that the private zone must be associated with."
2301
+ "summary": "Query region."
2094
2302
  },
2095
2303
  "immutable": true,
2096
2304
  "locationInModule": {
2097
2305
  "filename": "lib/cloud-assembly/context-queries.ts",
2098
- "line": 151
2306
+ "line": 451
2099
2307
  },
2100
- "name": "vpcId",
2101
- "optional": true,
2308
+ "name": "region",
2102
2309
  "type": {
2103
2310
  "primitive": "string"
2104
2311
  }
2105
2312
  }
2106
- ]
2313
+ ],
2314
+ "symbolId": "lib/cloud-assembly/context-queries:KeyContextQuery"
2107
2315
  },
2108
2316
  "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery": {
2109
2317
  "assembly": "@aws-cdk/cloud-assembly-schema",
2110
2318
  "datatype": true,
2111
2319
  "docs": {
2112
2320
  "stability": "stable",
2113
- "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
+ }
2114
2326
  },
2115
2327
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2116
2328
  "interfaces": [
@@ -2119,7 +2331,7 @@
2119
2331
  "kind": "interface",
2120
2332
  "locationInModule": {
2121
2333
  "filename": "lib/cloud-assembly/context-queries.ts",
2122
- "line": 297
2334
+ "line": 302
2123
2335
  },
2124
2336
  "name": "LoadBalancerContextQuery",
2125
2337
  "properties": [
@@ -2132,7 +2344,7 @@
2132
2344
  "immutable": true,
2133
2345
  "locationInModule": {
2134
2346
  "filename": "lib/cloud-assembly/context-queries.ts",
2135
- "line": 301
2347
+ "line": 306
2136
2348
  },
2137
2349
  "name": "account",
2138
2350
  "type": {
@@ -2142,15 +2354,17 @@
2142
2354
  {
2143
2355
  "abstract": true,
2144
2356
  "docs": {
2357
+ "default": "- None",
2145
2358
  "stability": "stable",
2146
- "summary": "Query region."
2359
+ "summary": "The ARN of the role that should be used to look up the missing values."
2147
2360
  },
2148
2361
  "immutable": true,
2149
2362
  "locationInModule": {
2150
2363
  "filename": "lib/cloud-assembly/context-queries.ts",
2151
- "line": 306
2364
+ "line": 318
2152
2365
  },
2153
- "name": "region",
2366
+ "name": "lookupRoleArn",
2367
+ "optional": true,
2154
2368
  "type": {
2155
2369
  "primitive": "string"
2156
2370
  }
@@ -2158,54 +2372,41 @@
2158
2372
  {
2159
2373
  "abstract": true,
2160
2374
  "docs": {
2161
- "default": "- None",
2162
2375
  "stability": "stable",
2163
- "summary": "The ARN of the role that should be used to look up the missing values."
2376
+ "summary": "Query region."
2164
2377
  },
2165
2378
  "immutable": true,
2166
2379
  "locationInModule": {
2167
2380
  "filename": "lib/cloud-assembly/context-queries.ts",
2168
- "line": 313
2381
+ "line": 311
2169
2382
  },
2170
- "name": "lookupRoleArn",
2171
- "optional": true,
2383
+ "name": "region",
2172
2384
  "type": {
2173
2385
  "primitive": "string"
2174
2386
  }
2175
2387
  }
2176
- ]
2388
+ ],
2389
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerContextQuery"
2177
2390
  },
2178
2391
  "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter": {
2179
2392
  "assembly": "@aws-cdk/cloud-assembly-schema",
2180
2393
  "datatype": true,
2181
2394
  "docs": {
2182
2395
  "stability": "stable",
2183
- "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
+ }
2184
2401
  },
2185
2402
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2186
2403
  "kind": "interface",
2187
2404
  "locationInModule": {
2188
2405
  "filename": "lib/cloud-assembly/context-queries.ts",
2189
- "line": 275
2406
+ "line": 280
2190
2407
  },
2191
2408
  "name": "LoadBalancerFilter",
2192
2409
  "properties": [
2193
- {
2194
- "abstract": true,
2195
- "docs": {
2196
- "stability": "stable",
2197
- "summary": "Filter load balancers by their type."
2198
- },
2199
- "immutable": true,
2200
- "locationInModule": {
2201
- "filename": "lib/cloud-assembly/context-queries.ts",
2202
- "line": 279
2203
- },
2204
- "name": "loadBalancerType",
2205
- "type": {
2206
- "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2207
- }
2208
- },
2209
2410
  {
2210
2411
  "abstract": true,
2211
2412
  "docs": {
@@ -2216,7 +2417,7 @@
2216
2417
  "immutable": true,
2217
2418
  "locationInModule": {
2218
2419
  "filename": "lib/cloud-assembly/context-queries.ts",
2219
- "line": 285
2420
+ "line": 290
2220
2421
  },
2221
2422
  "name": "loadBalancerArn",
2222
2423
  "optional": true,
@@ -2234,7 +2435,7 @@
2234
2435
  "immutable": true,
2235
2436
  "locationInModule": {
2236
2437
  "filename": "lib/cloud-assembly/context-queries.ts",
2237
- "line": 291
2438
+ "line": 296
2238
2439
  },
2239
2440
  "name": "loadBalancerTags",
2240
2441
  "optional": true,
@@ -2246,15 +2447,36 @@
2246
2447
  "kind": "array"
2247
2448
  }
2248
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
+ }
2249
2466
  }
2250
- ]
2467
+ ],
2468
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
2251
2469
  },
2252
2470
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery": {
2253
2471
  "assembly": "@aws-cdk/cloud-assembly-schema",
2254
2472
  "datatype": true,
2255
2473
  "docs": {
2256
2474
  "stability": "stable",
2257
- "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
+ }
2258
2480
  },
2259
2481
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2260
2482
  "interfaces": [
@@ -2263,7 +2485,7 @@
2263
2485
  "kind": "interface",
2264
2486
  "locationInModule": {
2265
2487
  "filename": "lib/cloud-assembly/context-queries.ts",
2266
- "line": 354
2488
+ "line": 359
2267
2489
  },
2268
2490
  "name": "LoadBalancerListenerContextQuery",
2269
2491
  "properties": [
@@ -2274,27 +2496,11 @@
2274
2496
  "summary": "Query account."
2275
2497
  },
2276
2498
  "immutable": true,
2277
- "locationInModule": {
2278
- "filename": "lib/cloud-assembly/context-queries.ts",
2279
- "line": 358
2280
- },
2281
- "name": "account",
2282
- "type": {
2283
- "primitive": "string"
2284
- }
2285
- },
2286
- {
2287
- "abstract": true,
2288
- "docs": {
2289
- "stability": "stable",
2290
- "summary": "Query region."
2291
- },
2292
- "immutable": true,
2293
2499
  "locationInModule": {
2294
2500
  "filename": "lib/cloud-assembly/context-queries.ts",
2295
2501
  "line": 363
2296
2502
  },
2297
- "name": "region",
2503
+ "name": "account",
2298
2504
  "type": {
2299
2505
  "primitive": "string"
2300
2506
  }
@@ -2309,7 +2515,7 @@
2309
2515
  "immutable": true,
2310
2516
  "locationInModule": {
2311
2517
  "filename": "lib/cloud-assembly/context-queries.ts",
2312
- "line": 376
2518
+ "line": 381
2313
2519
  },
2314
2520
  "name": "listenerArn",
2315
2521
  "optional": true,
@@ -2327,7 +2533,7 @@
2327
2533
  "immutable": true,
2328
2534
  "locationInModule": {
2329
2535
  "filename": "lib/cloud-assembly/context-queries.ts",
2330
- "line": 388
2536
+ "line": 393
2331
2537
  },
2332
2538
  "name": "listenerPort",
2333
2539
  "optional": true,
@@ -2345,7 +2551,7 @@
2345
2551
  "immutable": true,
2346
2552
  "locationInModule": {
2347
2553
  "filename": "lib/cloud-assembly/context-queries.ts",
2348
- "line": 382
2554
+ "line": 387
2349
2555
  },
2350
2556
  "name": "listenerProtocol",
2351
2557
  "optional": true,
@@ -2363,15 +2569,32 @@
2363
2569
  "immutable": true,
2364
2570
  "locationInModule": {
2365
2571
  "filename": "lib/cloud-assembly/context-queries.ts",
2366
- "line": 370
2572
+ "line": 375
2367
2573
  },
2368
2574
  "name": "lookupRoleArn",
2369
2575
  "optional": true,
2370
2576
  "type": {
2371
2577
  "primitive": "string"
2372
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
+ }
2373
2595
  }
2374
- ]
2596
+ ],
2597
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
2375
2598
  },
2376
2599
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerProtocol": {
2377
2600
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2383,7 +2606,7 @@
2383
2606
  "kind": "enum",
2384
2607
  "locationInModule": {
2385
2608
  "filename": "lib/cloud-assembly/context-queries.ts",
2386
- "line": 319
2609
+ "line": 324
2387
2610
  },
2388
2611
  "members": [
2389
2612
  {
@@ -2410,26 +2633,27 @@
2410
2633
  {
2411
2634
  "docs": {
2412
2635
  "stability": "stable",
2413
- "summary": "TLS protocol."
2636
+ "summary": "TCP and UDP protocol."
2414
2637
  },
2415
- "name": "TLS"
2638
+ "name": "TCP_UDP"
2416
2639
  },
2417
2640
  {
2418
2641
  "docs": {
2419
2642
  "stability": "stable",
2420
- "summary": "UDP protocol."
2643
+ "summary": "TLS protocol."
2421
2644
  },
2422
- "name": "UDP"
2645
+ "name": "TLS"
2423
2646
  },
2424
2647
  {
2425
2648
  "docs": {
2426
2649
  "stability": "stable",
2427
- "summary": "TCP and UDP protocol."
2650
+ "summary": "UDP protocol."
2428
2651
  },
2429
- "name": "TCP_UDP"
2652
+ "name": "UDP"
2430
2653
  }
2431
2654
  ],
2432
- "name": "LoadBalancerListenerProtocol"
2655
+ "name": "LoadBalancerListenerProtocol",
2656
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerProtocol"
2433
2657
  },
2434
2658
  "@aws-cdk/cloud-assembly-schema.LoadBalancerType": {
2435
2659
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2441,25 +2665,26 @@
2441
2665
  "kind": "enum",
2442
2666
  "locationInModule": {
2443
2667
  "filename": "lib/cloud-assembly/context-queries.ts",
2444
- "line": 260
2668
+ "line": 265
2445
2669
  },
2446
2670
  "members": [
2447
2671
  {
2448
2672
  "docs": {
2449
2673
  "stability": "stable",
2450
- "summary": "Network load balancer."
2674
+ "summary": "Application load balancer."
2451
2675
  },
2452
- "name": "NETWORK"
2676
+ "name": "APPLICATION"
2453
2677
  },
2454
2678
  {
2455
2679
  "docs": {
2456
2680
  "stability": "stable",
2457
- "summary": "Application load balancer."
2681
+ "summary": "Network load balancer."
2458
2682
  },
2459
- "name": "APPLICATION"
2683
+ "name": "NETWORK"
2460
2684
  }
2461
2685
  ],
2462
- "name": "LoadBalancerType"
2686
+ "name": "LoadBalancerType",
2687
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerType"
2463
2688
  },
2464
2689
  "@aws-cdk/cloud-assembly-schema.Manifest": {
2465
2690
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2665,14 +2890,19 @@
2665
2890
  "static": true
2666
2891
  }
2667
2892
  ],
2668
- "name": "Manifest"
2893
+ "name": "Manifest",
2894
+ "symbolId": "lib/manifest:Manifest"
2669
2895
  },
2670
2896
  "@aws-cdk/cloud-assembly-schema.MetadataEntry": {
2671
2897
  "assembly": "@aws-cdk/cloud-assembly-schema",
2672
2898
  "datatype": true,
2673
2899
  "docs": {
2674
2900
  "stability": "stable",
2675
- "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
+ }
2676
2906
  },
2677
2907
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2678
2908
  "kind": "interface",
@@ -2682,22 +2912,6 @@
2682
2912
  },
2683
2913
  "name": "MetadataEntry",
2684
2914
  "properties": [
2685
- {
2686
- "abstract": true,
2687
- "docs": {
2688
- "stability": "stable",
2689
- "summary": "The type of the metadata entry."
2690
- },
2691
- "immutable": true,
2692
- "locationInModule": {
2693
- "filename": "lib/cloud-assembly/metadata-schema.ts",
2694
- "line": 208
2695
- },
2696
- "name": "type",
2697
- "type": {
2698
- "primitive": "string"
2699
- }
2700
- },
2701
2915
  {
2702
2916
  "abstract": true,
2703
2917
  "docs": {
@@ -2758,15 +2972,36 @@
2758
2972
  "kind": "array"
2759
2973
  }
2760
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
+ }
2761
2991
  }
2762
- ]
2992
+ ],
2993
+ "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
2763
2994
  },
2764
2995
  "@aws-cdk/cloud-assembly-schema.MissingContext": {
2765
2996
  "assembly": "@aws-cdk/cloud-assembly-schema",
2766
2997
  "datatype": true,
2767
2998
  "docs": {
2768
2999
  "stability": "stable",
2769
- "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
+ }
2770
3005
  },
2771
3006
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2772
3007
  "kind": "interface",
@@ -2833,6 +3068,9 @@
2833
3068
  },
2834
3069
  {
2835
3070
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery"
3071
+ },
3072
+ {
3073
+ "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery"
2836
3074
  }
2837
3075
  ]
2838
3076
  }
@@ -2854,20 +3092,25 @@
2854
3092
  "fqn": "@aws-cdk/cloud-assembly-schema.ContextProvider"
2855
3093
  }
2856
3094
  }
2857
- ]
3095
+ ],
3096
+ "symbolId": "lib/cloud-assembly/schema:MissingContext"
2858
3097
  },
2859
3098
  "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties": {
2860
3099
  "assembly": "@aws-cdk/cloud-assembly-schema",
2861
3100
  "datatype": true,
2862
3101
  "docs": {
2863
3102
  "stability": "stable",
2864
- "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
+ }
2865
3108
  },
2866
3109
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
2867
3110
  "kind": "interface",
2868
3111
  "locationInModule": {
2869
3112
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2870
- "line": 132
3113
+ "line": 139
2871
3114
  },
2872
3115
  "name": "NestedCloudAssemblyProperties",
2873
3116
  "properties": [
@@ -2880,7 +3123,7 @@
2880
3123
  "immutable": true,
2881
3124
  "locationInModule": {
2882
3125
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2883
- "line": 136
3126
+ "line": 143
2884
3127
  },
2885
3128
  "name": "directoryName",
2886
3129
  "type": {
@@ -2897,7 +3140,7 @@
2897
3140
  "immutable": true,
2898
3141
  "locationInModule": {
2899
3142
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2900
- "line": 143
3143
+ "line": 150
2901
3144
  },
2902
3145
  "name": "displayName",
2903
3146
  "optional": true,
@@ -2905,14 +3148,19 @@
2905
3148
  "primitive": "string"
2906
3149
  }
2907
3150
  }
2908
- ]
3151
+ ],
3152
+ "symbolId": "lib/cloud-assembly/artifact-schema:NestedCloudAssemblyProperties"
2909
3153
  },
2910
3154
  "@aws-cdk/cloud-assembly-schema.RuntimeInfo": {
2911
3155
  "assembly": "@aws-cdk/cloud-assembly-schema",
2912
3156
  "datatype": true,
2913
3157
  "docs": {
2914
3158
  "stability": "stable",
2915
- "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
+ }
2916
3164
  },
2917
3165
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
2918
3166
  "kind": "interface",
@@ -2943,20 +3191,25 @@
2943
3191
  }
2944
3192
  }
2945
3193
  }
2946
- ]
3194
+ ],
3195
+ "symbolId": "lib/cloud-assembly/schema:RuntimeInfo"
2947
3196
  },
2948
3197
  "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery": {
2949
3198
  "assembly": "@aws-cdk/cloud-assembly-schema",
2950
3199
  "datatype": true,
2951
3200
  "docs": {
2952
3201
  "stability": "stable",
2953
- "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
+ }
2954
3207
  },
2955
3208
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
2956
3209
  "kind": "interface",
2957
3210
  "locationInModule": {
2958
3211
  "filename": "lib/cloud-assembly/context-queries.ts",
2959
- "line": 157
3212
+ "line": 162
2960
3213
  },
2961
3214
  "name": "SSMParameterContextQuery",
2962
3215
  "properties": [
@@ -2969,7 +3222,7 @@
2969
3222
  "immutable": true,
2970
3223
  "locationInModule": {
2971
3224
  "filename": "lib/cloud-assembly/context-queries.ts",
2972
- "line": 161
3225
+ "line": 166
2973
3226
  },
2974
3227
  "name": "account",
2975
3228
  "type": {
@@ -2979,15 +3232,17 @@
2979
3232
  {
2980
3233
  "abstract": true,
2981
3234
  "docs": {
3235
+ "default": "- None",
2982
3236
  "stability": "stable",
2983
- "summary": "Parameter name to query."
3237
+ "summary": "The ARN of the role that should be used to look up the missing values."
2984
3238
  },
2985
3239
  "immutable": true,
2986
3240
  "locationInModule": {
2987
3241
  "filename": "lib/cloud-assembly/context-queries.ts",
2988
3242
  "line": 178
2989
3243
  },
2990
- "name": "parameterName",
3244
+ "name": "lookupRoleArn",
3245
+ "optional": true,
2991
3246
  "type": {
2992
3247
  "primitive": "string"
2993
3248
  }
@@ -2996,14 +3251,14 @@
2996
3251
  "abstract": true,
2997
3252
  "docs": {
2998
3253
  "stability": "stable",
2999
- "summary": "Query region."
3254
+ "summary": "Parameter name to query."
3000
3255
  },
3001
3256
  "immutable": true,
3002
3257
  "locationInModule": {
3003
3258
  "filename": "lib/cloud-assembly/context-queries.ts",
3004
- "line": 166
3259
+ "line": 183
3005
3260
  },
3006
- "name": "region",
3261
+ "name": "parameterName",
3007
3262
  "type": {
3008
3263
  "primitive": "string"
3009
3264
  }
@@ -3011,35 +3266,38 @@
3011
3266
  {
3012
3267
  "abstract": true,
3013
3268
  "docs": {
3014
- "default": "- None",
3015
3269
  "stability": "stable",
3016
- "summary": "The ARN of the role that should be used to look up the missing values."
3270
+ "summary": "Query region."
3017
3271
  },
3018
3272
  "immutable": true,
3019
3273
  "locationInModule": {
3020
3274
  "filename": "lib/cloud-assembly/context-queries.ts",
3021
- "line": 173
3275
+ "line": 171
3022
3276
  },
3023
- "name": "lookupRoleArn",
3024
- "optional": true,
3277
+ "name": "region",
3025
3278
  "type": {
3026
3279
  "primitive": "string"
3027
3280
  }
3028
3281
  }
3029
- ]
3282
+ ],
3283
+ "symbolId": "lib/cloud-assembly/context-queries:SSMParameterContextQuery"
3030
3284
  },
3031
3285
  "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery": {
3032
3286
  "assembly": "@aws-cdk/cloud-assembly-schema",
3033
3287
  "datatype": true,
3034
3288
  "docs": {
3035
3289
  "stability": "stable",
3036
- "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
+ }
3037
3295
  },
3038
3296
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
3039
3297
  "kind": "interface",
3040
3298
  "locationInModule": {
3041
3299
  "filename": "lib/cloud-assembly/context-queries.ts",
3042
- "line": 394
3300
+ "line": 399
3043
3301
  },
3044
3302
  "name": "SecurityGroupContextQuery",
3045
3303
  "properties": [
@@ -3052,13 +3310,31 @@
3052
3310
  "immutable": true,
3053
3311
  "locationInModule": {
3054
3312
  "filename": "lib/cloud-assembly/context-queries.ts",
3055
- "line": 398
3313
+ "line": 403
3056
3314
  },
3057
3315
  "name": "account",
3058
3316
  "type": {
3059
3317
  "primitive": "string"
3060
3318
  }
3061
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
+ },
3062
3338
  {
3063
3339
  "abstract": true,
3064
3340
  "docs": {
@@ -3068,7 +3344,7 @@
3068
3344
  "immutable": true,
3069
3345
  "locationInModule": {
3070
3346
  "filename": "lib/cloud-assembly/context-queries.ts",
3071
- "line": 403
3347
+ "line": 408
3072
3348
  },
3073
3349
  "name": "region",
3074
3350
  "type": {
@@ -3078,15 +3354,17 @@
3078
3354
  {
3079
3355
  "abstract": true,
3080
3356
  "docs": {
3357
+ "default": "- None",
3081
3358
  "stability": "stable",
3082
3359
  "summary": "Security group id."
3083
3360
  },
3084
3361
  "immutable": true,
3085
3362
  "locationInModule": {
3086
3363
  "filename": "lib/cloud-assembly/context-queries.ts",
3087
- "line": 415
3364
+ "line": 422
3088
3365
  },
3089
3366
  "name": "securityGroupId",
3367
+ "optional": true,
3090
3368
  "type": {
3091
3369
  "primitive": "string"
3092
3370
  }
@@ -3096,27 +3374,50 @@
3096
3374
  "docs": {
3097
3375
  "default": "- None",
3098
3376
  "stability": "stable",
3099
- "summary": "The ARN of the role that should be used to look up the missing values."
3377
+ "summary": "Security group name."
3100
3378
  },
3101
3379
  "immutable": true,
3102
3380
  "locationInModule": {
3103
3381
  "filename": "lib/cloud-assembly/context-queries.ts",
3104
- "line": 410
3382
+ "line": 429
3105
3383
  },
3106
- "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",
3107
3403
  "optional": true,
3108
3404
  "type": {
3109
3405
  "primitive": "string"
3110
3406
  }
3111
3407
  }
3112
- ]
3408
+ ],
3409
+ "symbolId": "lib/cloud-assembly/context-queries:SecurityGroupContextQuery"
3113
3410
  },
3114
3411
  "@aws-cdk/cloud-assembly-schema.Tag": {
3115
3412
  "assembly": "@aws-cdk/cloud-assembly-schema",
3116
3413
  "datatype": true,
3117
3414
  "docs": {
3118
3415
  "stability": "stable",
3119
- "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
+ }
3120
3421
  },
3121
3422
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
3122
3423
  "kind": "interface",
@@ -3160,20 +3461,25 @@
3160
3461
  "primitive": "string"
3161
3462
  }
3162
3463
  }
3163
- ]
3464
+ ],
3465
+ "symbolId": "lib/cloud-assembly/metadata-schema:Tag"
3164
3466
  },
3165
3467
  "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties": {
3166
3468
  "assembly": "@aws-cdk/cloud-assembly-schema",
3167
3469
  "datatype": true,
3168
3470
  "docs": {
3169
3471
  "stability": "stable",
3170
- "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
+ }
3171
3477
  },
3172
3478
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3173
3479
  "kind": "interface",
3174
3480
  "locationInModule": {
3175
3481
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3176
- "line": 122
3482
+ "line": 129
3177
3483
  },
3178
3484
  "name": "TreeArtifactProperties",
3179
3485
  "properties": [
@@ -3186,27 +3492,32 @@
3186
3492
  "immutable": true,
3187
3493
  "locationInModule": {
3188
3494
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3189
- "line": 126
3495
+ "line": 133
3190
3496
  },
3191
3497
  "name": "file",
3192
3498
  "type": {
3193
3499
  "primitive": "string"
3194
3500
  }
3195
3501
  }
3196
- ]
3502
+ ],
3503
+ "symbolId": "lib/cloud-assembly/artifact-schema:TreeArtifactProperties"
3197
3504
  },
3198
3505
  "@aws-cdk/cloud-assembly-schema.VpcContextQuery": {
3199
3506
  "assembly": "@aws-cdk/cloud-assembly-schema",
3200
3507
  "datatype": true,
3201
3508
  "docs": {
3202
3509
  "stability": "stable",
3203
- "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
+ }
3204
3515
  },
3205
3516
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3206
3517
  "kind": "interface",
3207
3518
  "locationInModule": {
3208
3519
  "filename": "lib/cloud-assembly/context-queries.ts",
3209
- "line": 184
3520
+ "line": 189
3210
3521
  },
3211
3522
  "name": "VpcContextQuery",
3212
3523
  "properties": [
@@ -3219,7 +3530,7 @@
3219
3530
  "immutable": true,
3220
3531
  "locationInModule": {
3221
3532
  "filename": "lib/cloud-assembly/context-queries.ts",
3222
- "line": 188
3533
+ "line": 193
3223
3534
  },
3224
3535
  "name": "account",
3225
3536
  "type": {
@@ -3237,7 +3548,7 @@
3237
3548
  "immutable": true,
3238
3549
  "locationInModule": {
3239
3550
  "filename": "lib/cloud-assembly/context-queries.ts",
3240
- "line": 209
3551
+ "line": 214
3241
3552
  },
3242
3553
  "name": "filter",
3243
3554
  "type": {
@@ -3252,15 +3563,17 @@
3252
3563
  {
3253
3564
  "abstract": true,
3254
3565
  "docs": {
3566
+ "default": "- None",
3255
3567
  "stability": "stable",
3256
- "summary": "Query region."
3568
+ "summary": "The ARN of the role that should be used to look up the missing values."
3257
3569
  },
3258
3570
  "immutable": true,
3259
3571
  "locationInModule": {
3260
3572
  "filename": "lib/cloud-assembly/context-queries.ts",
3261
- "line": 193
3573
+ "line": 205
3262
3574
  },
3263
- "name": "region",
3575
+ "name": "lookupRoleArn",
3576
+ "optional": true,
3264
3577
  "type": {
3265
3578
  "primitive": "string"
3266
3579
  }
@@ -3268,17 +3581,15 @@
3268
3581
  {
3269
3582
  "abstract": true,
3270
3583
  "docs": {
3271
- "default": "- None",
3272
3584
  "stability": "stable",
3273
- "summary": "The ARN of the role that should be used to look up the missing values."
3585
+ "summary": "Query region."
3274
3586
  },
3275
3587
  "immutable": true,
3276
3588
  "locationInModule": {
3277
3589
  "filename": "lib/cloud-assembly/context-queries.ts",
3278
- "line": 200
3590
+ "line": 198
3279
3591
  },
3280
- "name": "lookupRoleArn",
3281
- "optional": true,
3592
+ "name": "region",
3282
3593
  "type": {
3283
3594
  "primitive": "string"
3284
3595
  }
@@ -3293,7 +3604,7 @@
3293
3604
  "immutable": true,
3294
3605
  "locationInModule": {
3295
3606
  "filename": "lib/cloud-assembly/context-queries.ts",
3296
- "line": 217
3607
+ "line": 222
3297
3608
  },
3298
3609
  "name": "returnAsymmetricSubnets",
3299
3610
  "optional": true,
@@ -3312,7 +3623,7 @@
3312
3623
  "immutable": true,
3313
3624
  "locationInModule": {
3314
3625
  "filename": "lib/cloud-assembly/context-queries.ts",
3315
- "line": 227
3626
+ "line": 232
3316
3627
  },
3317
3628
  "name": "subnetGroupNameTag",
3318
3629
  "optional": true,
@@ -3320,9 +3631,10 @@
3320
3631
  "primitive": "string"
3321
3632
  }
3322
3633
  }
3323
- ]
3634
+ ],
3635
+ "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3324
3636
  }
3325
3637
  },
3326
- "version": "2.0.0-rc.7",
3327
- "fingerprint": "SL380e/oiAu+5hWgEcKkGzwpMK4WgLltmo7WqN4yA8A="
3638
+ "version": "2.1.0",
3639
+ "fingerprint": "**********"
3328
3640
  }