@aws-cdk/cloud-assembly-schema 2.0.0-rc.9 → 2.0.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,14 @@
73
74
  "datatype": true,
74
75
  "docs": {
75
76
  "stability": "stable",
76
- "summary": "Query to AMI context provider."
77
+ "summary": "Query to AMI context provider.",
78
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst amiContextQuery: cloud_assembly_schema.AmiContextQuery = {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n};"
77
79
  },
78
80
  "fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
79
81
  "kind": "interface",
80
82
  "locationInModule": {
81
83
  "filename": "lib/cloud-assembly/context-queries.ts",
82
- "line": 56
84
+ "line": 61
83
85
  },
84
86
  "name": "AmiContextQuery",
85
87
  "properties": [
@@ -92,7 +94,7 @@
92
94
  "immutable": true,
93
95
  "locationInModule": {
94
96
  "filename": "lib/cloud-assembly/context-queries.ts",
95
- "line": 60
97
+ "line": 65
96
98
  },
97
99
  "name": "account",
98
100
  "type": {
@@ -108,7 +110,7 @@
108
110
  "immutable": true,
109
111
  "locationInModule": {
110
112
  "filename": "lib/cloud-assembly/context-queries.ts",
111
- "line": 84
113
+ "line": 89
112
114
  },
113
115
  "name": "filters",
114
116
  "type": {
@@ -125,22 +127,6 @@
125
127
  }
126
128
  }
127
129
  },
128
- {
129
- "abstract": true,
130
- "docs": {
131
- "stability": "stable",
132
- "summary": "Region to query."
133
- },
134
- "immutable": true,
135
- "locationInModule": {
136
- "filename": "lib/cloud-assembly/context-queries.ts",
137
- "line": 65
138
- },
139
- "name": "region",
140
- "type": {
141
- "primitive": "string"
142
- }
143
- },
144
130
  {
145
131
  "abstract": true,
146
132
  "docs": {
@@ -151,7 +137,7 @@
151
137
  "immutable": true,
152
138
  "locationInModule": {
153
139
  "filename": "lib/cloud-assembly/context-queries.ts",
154
- "line": 72
140
+ "line": 77
155
141
  },
156
142
  "name": "lookupRoleArn",
157
143
  "optional": true,
@@ -169,7 +155,7 @@
169
155
  "immutable": true,
170
156
  "locationInModule": {
171
157
  "filename": "lib/cloud-assembly/context-queries.ts",
172
- "line": 79
158
+ "line": 84
173
159
  },
174
160
  "name": "owners",
175
161
  "optional": true,
@@ -181,15 +167,33 @@
181
167
  "kind": "array"
182
168
  }
183
169
  }
170
+ },
171
+ {
172
+ "abstract": true,
173
+ "docs": {
174
+ "stability": "stable",
175
+ "summary": "Region to query."
176
+ },
177
+ "immutable": true,
178
+ "locationInModule": {
179
+ "filename": "lib/cloud-assembly/context-queries.ts",
180
+ "line": 70
181
+ },
182
+ "name": "region",
183
+ "type": {
184
+ "primitive": "string"
185
+ }
184
186
  }
185
- ]
187
+ ],
188
+ "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
186
189
  },
187
190
  "@aws-cdk/cloud-assembly-schema.ArtifactManifest": {
188
191
  "assembly": "@aws-cdk/cloud-assembly-schema",
189
192
  "datatype": true,
190
193
  "docs": {
191
194
  "stability": "stable",
192
- "summary": "A manifest for a single artifact within the cloud assembly."
195
+ "summary": "A manifest for a single artifact within the cloud assembly.",
196
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n};"
193
197
  },
194
198
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
195
199
  "kind": "interface",
@@ -199,22 +203,6 @@
199
203
  },
200
204
  "name": "ArtifactManifest",
201
205
  "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
206
  {
219
207
  "abstract": true,
220
208
  "docs": {
@@ -335,8 +323,25 @@
335
323
  ]
336
324
  }
337
325
  }
326
+ },
327
+ {
328
+ "abstract": true,
329
+ "docs": {
330
+ "stability": "stable",
331
+ "summary": "The type of artifact."
332
+ },
333
+ "immutable": true,
334
+ "locationInModule": {
335
+ "filename": "lib/cloud-assembly/schema.ts",
336
+ "line": 72
337
+ },
338
+ "name": "type",
339
+ "type": {
340
+ "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
341
+ }
338
342
  }
339
- ]
343
+ ],
344
+ "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
340
345
  },
341
346
  "@aws-cdk/cloud-assembly-schema.ArtifactMetadataEntryType": {
342
347
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -394,7 +399,8 @@
394
399
  "name": "STACK_TAGS"
395
400
  }
396
401
  ],
397
- "name": "ArtifactMetadataEntryType"
402
+ "name": "ArtifactMetadataEntryType",
403
+ "symbolId": "lib/cloud-assembly/metadata-schema:ArtifactMetadataEntryType"
398
404
  },
399
405
  "@aws-cdk/cloud-assembly-schema.ArtifactType": {
400
406
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -412,9 +418,9 @@
412
418
  {
413
419
  "docs": {
414
420
  "stability": "stable",
415
- "summary": "Stub required because of JSII."
421
+ "summary": "Manifest for all assets in the Cloud Assembly."
416
422
  },
417
- "name": "NONE"
423
+ "name": "ASSET_MANIFEST"
418
424
  },
419
425
  {
420
426
  "docs": {
@@ -433,26 +439,28 @@
433
439
  {
434
440
  "docs": {
435
441
  "stability": "stable",
436
- "summary": "Manifest for all assets in the Cloud Assembly."
442
+ "summary": "Nested Cloud Assembly."
437
443
  },
438
- "name": "ASSET_MANIFEST"
444
+ "name": "NESTED_CLOUD_ASSEMBLY"
439
445
  },
440
446
  {
441
447
  "docs": {
442
448
  "stability": "stable",
443
- "summary": "Nested Cloud Assembly."
449
+ "summary": "Stub required because of JSII."
444
450
  },
445
- "name": "NESTED_CLOUD_ASSEMBLY"
451
+ "name": "NONE"
446
452
  }
447
453
  ],
448
- "name": "ArtifactType"
454
+ "name": "ArtifactType",
455
+ "symbolId": "lib/cloud-assembly/schema:ArtifactType"
449
456
  },
450
457
  "@aws-cdk/cloud-assembly-schema.AssemblyManifest": {
451
458
  "assembly": "@aws-cdk/cloud-assembly-schema",
452
459
  "datatype": true,
453
460
  "docs": {
454
461
  "stability": "stable",
455
- "summary": "A manifest which describes the cloud assembly."
462
+ "summary": "A manifest which describes the cloud assembly.",
463
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n version: 'version',\n\n // the properties below are optional\n artifacts: {\n artifactsKey: {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n },\n },\n missing: [{\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n }],\n runtime: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};"
456
464
  },
457
465
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
458
466
  "kind": "interface",
@@ -462,22 +470,6 @@
462
470
  },
463
471
  "name": "AssemblyManifest",
464
472
  "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
473
  {
482
474
  "abstract": true,
483
475
  "docs": {
@@ -542,15 +534,33 @@
542
534
  "type": {
543
535
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
544
536
  }
537
+ },
538
+ {
539
+ "abstract": true,
540
+ "docs": {
541
+ "stability": "stable",
542
+ "summary": "Protocol version."
543
+ },
544
+ "immutable": true,
545
+ "locationInModule": {
546
+ "filename": "lib/cloud-assembly/schema.ts",
547
+ "line": 117
548
+ },
549
+ "name": "version",
550
+ "type": {
551
+ "primitive": "string"
552
+ }
545
553
  }
546
- ]
554
+ ],
555
+ "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
547
556
  },
548
557
  "@aws-cdk/cloud-assembly-schema.AssetManifest": {
549
558
  "assembly": "@aws-cdk/cloud-assembly-schema",
550
559
  "datatype": true,
551
560
  "docs": {
552
561
  "stability": "stable",
553
- "summary": "Definitions for the asset manifest."
562
+ "summary": "Definitions for the asset manifest.",
563
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assetManifest: cloud_assembly_schema.AssetManifest = {\n version: 'version',\n\n // the properties below are optional\n dockerImages: {\n dockerImagesKey: {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n },\n },\n files: {\n filesKey: {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n },\n },\n};"
554
564
  },
555
565
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
556
566
  "kind": "interface",
@@ -560,22 +570,6 @@
560
570
  },
561
571
  "name": "AssetManifest",
562
572
  "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
573
  {
580
574
  "abstract": true,
581
575
  "docs": {
@@ -621,36 +615,57 @@
621
615
  "kind": "map"
622
616
  }
623
617
  }
618
+ },
619
+ {
620
+ "abstract": true,
621
+ "docs": {
622
+ "stability": "stable",
623
+ "summary": "Version of the manifest."
624
+ },
625
+ "immutable": true,
626
+ "locationInModule": {
627
+ "filename": "lib/assets/schema.ts",
628
+ "line": 11
629
+ },
630
+ "name": "version",
631
+ "type": {
632
+ "primitive": "string"
633
+ }
624
634
  }
625
- ]
635
+ ],
636
+ "symbolId": "lib/assets/schema:AssetManifest"
626
637
  },
627
638
  "@aws-cdk/cloud-assembly-schema.AssetManifestProperties": {
628
639
  "assembly": "@aws-cdk/cloud-assembly-schema",
629
640
  "datatype": true,
630
641
  "docs": {
631
642
  "stability": "stable",
632
- "summary": "Artifact properties for the Asset Manifest."
643
+ "summary": "Artifact properties for the Asset Manifest.",
644
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst assetManifestProperties: cloud_assembly_schema.AssetManifestProperties = {\n file: 'file',\n\n // the properties below are optional\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};"
633
645
  },
634
646
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
635
647
  "kind": "interface",
636
648
  "locationInModule": {
637
649
  "filename": "lib/cloud-assembly/artifact-schema.ts",
638
- "line": 92
650
+ "line": 99
639
651
  },
640
652
  "name": "AssetManifestProperties",
641
653
  "properties": [
642
654
  {
643
655
  "abstract": true,
644
656
  "docs": {
657
+ "default": "- Bootstrap stack version number looked up",
658
+ "remarks": "- If this value is not set, the bootstrap stack name must be known at\n deployment time so the stack version can be looked up from the stack\n outputs.\n- If this value is set, the bootstrap stack can have any name because\n we won't need to look it up.",
645
659
  "stability": "stable",
646
- "summary": "Filename of the asset manifest."
660
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
647
661
  },
648
662
  "immutable": true,
649
663
  "locationInModule": {
650
664
  "filename": "lib/cloud-assembly/artifact-schema.ts",
651
- "line": 96
665
+ "line": 123
652
666
  },
653
- "name": "file",
667
+ "name": "bootstrapStackVersionSsmParameter",
668
+ "optional": true,
654
669
  "type": {
655
670
  "primitive": "string"
656
671
  }
@@ -658,18 +673,15 @@
658
673
  {
659
674
  "abstract": true,
660
675
  "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
676
  "stability": "stable",
664
- "summary": "SSM parameter where the bootstrap stack version number can be found."
677
+ "summary": "Filename of the asset manifest."
665
678
  },
666
679
  "immutable": true,
667
680
  "locationInModule": {
668
681
  "filename": "lib/cloud-assembly/artifact-schema.ts",
669
- "line": 116
682
+ "line": 103
670
683
  },
671
- "name": "bootstrapStackVersionSsmParameter",
672
- "optional": true,
684
+ "name": "file",
673
685
  "type": {
674
686
  "primitive": "string"
675
687
  }
@@ -684,7 +696,7 @@
684
696
  "immutable": true,
685
697
  "locationInModule": {
686
698
  "filename": "lib/cloud-assembly/artifact-schema.ts",
687
- "line": 103
699
+ "line": 110
688
700
  },
689
701
  "name": "requiresBootstrapStackVersion",
690
702
  "optional": true,
@@ -692,20 +704,22 @@
692
704
  "primitive": "number"
693
705
  }
694
706
  }
695
- ]
707
+ ],
708
+ "symbolId": "lib/cloud-assembly/artifact-schema:AssetManifestProperties"
696
709
  },
697
710
  "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery": {
698
711
  "assembly": "@aws-cdk/cloud-assembly-schema",
699
712
  "datatype": true,
700
713
  "docs": {
701
714
  "stability": "stable",
702
- "summary": "Query to availability zone context provider."
715
+ "summary": "Query to availability zone context provider.",
716
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst availabilityZonesContextQuery: cloud_assembly_schema.AvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
703
717
  },
704
718
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
705
719
  "kind": "interface",
706
720
  "locationInModule": {
707
721
  "filename": "lib/cloud-assembly/context-queries.ts",
708
- "line": 90
722
+ "line": 95
709
723
  },
710
724
  "name": "AvailabilityZonesContextQuery",
711
725
  "properties": [
@@ -718,7 +732,7 @@
718
732
  "immutable": true,
719
733
  "locationInModule": {
720
734
  "filename": "lib/cloud-assembly/context-queries.ts",
721
- "line": 94
735
+ "line": 99
722
736
  },
723
737
  "name": "account",
724
738
  "type": {
@@ -728,15 +742,17 @@
728
742
  {
729
743
  "abstract": true,
730
744
  "docs": {
745
+ "default": "- None",
731
746
  "stability": "stable",
732
- "summary": "Query region."
747
+ "summary": "The ARN of the role that should be used to look up the missing values."
733
748
  },
734
749
  "immutable": true,
735
750
  "locationInModule": {
736
751
  "filename": "lib/cloud-assembly/context-queries.ts",
737
- "line": 99
752
+ "line": 111
738
753
  },
739
- "name": "region",
754
+ "name": "lookupRoleArn",
755
+ "optional": true,
740
756
  "type": {
741
757
  "primitive": "string"
742
758
  }
@@ -744,29 +760,29 @@
744
760
  {
745
761
  "abstract": true,
746
762
  "docs": {
747
- "default": "- None",
748
763
  "stability": "stable",
749
- "summary": "The ARN of the role that should be used to look up the missing values."
764
+ "summary": "Query region."
750
765
  },
751
766
  "immutable": true,
752
767
  "locationInModule": {
753
768
  "filename": "lib/cloud-assembly/context-queries.ts",
754
- "line": 106
769
+ "line": 104
755
770
  },
756
- "name": "lookupRoleArn",
757
- "optional": true,
771
+ "name": "region",
758
772
  "type": {
759
773
  "primitive": "string"
760
774
  }
761
775
  }
762
- ]
776
+ ],
777
+ "symbolId": "lib/cloud-assembly/context-queries:AvailabilityZonesContextQuery"
763
778
  },
764
779
  "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties": {
765
780
  "assembly": "@aws-cdk/cloud-assembly-schema",
766
781
  "datatype": true,
767
782
  "docs": {
768
783
  "stability": "stable",
769
- "summary": "Artifact properties for CloudFormation stacks."
784
+ "summary": "Artifact properties for CloudFormation stacks.",
785
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n};"
770
786
  },
771
787
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
772
788
  "kind": "interface",
@@ -779,15 +795,17 @@
779
795
  {
780
796
  "abstract": true,
781
797
  "docs": {
798
+ "default": "- No role is assumed (current credentials are used)",
782
799
  "stability": "stable",
783
- "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
800
+ "summary": "The role that needs to be assumed to deploy the stack."
784
801
  },
785
802
  "immutable": true,
786
803
  "locationInModule": {
787
804
  "filename": "lib/cloud-assembly/artifact-schema.ts",
788
- "line": 9
805
+ "line": 43
789
806
  },
790
- "name": "templateFile",
807
+ "name": "assumeRoleArn",
808
+ "optional": true,
791
809
  "type": {
792
810
  "primitive": "string"
793
811
  }
@@ -795,16 +813,16 @@
795
813
  {
796
814
  "abstract": true,
797
815
  "docs": {
798
- "default": "- No role is assumed (current credentials are used)",
816
+ "default": "- No external ID",
799
817
  "stability": "stable",
800
- "summary": "The role that needs to be assumed to deploy the stack."
818
+ "summary": "External ID to use when assuming role for cloudformation deployments."
801
819
  },
802
820
  "immutable": true,
803
821
  "locationInModule": {
804
822
  "filename": "lib/cloud-assembly/artifact-schema.ts",
805
- "line": 43
823
+ "line": 50
806
824
  },
807
- "name": "assumeRoleArn",
825
+ "name": "assumeRoleExternalId",
808
826
  "optional": true,
809
827
  "type": {
810
828
  "primitive": "string"
@@ -821,7 +839,7 @@
821
839
  "immutable": true,
822
840
  "locationInModule": {
823
841
  "filename": "lib/cloud-assembly/artifact-schema.ts",
824
- "line": 79
842
+ "line": 86
825
843
  },
826
844
  "name": "bootstrapStackVersionSsmParameter",
827
845
  "optional": true,
@@ -839,7 +857,7 @@
839
857
  "immutable": true,
840
858
  "locationInModule": {
841
859
  "filename": "lib/cloud-assembly/artifact-schema.ts",
842
- "line": 50
860
+ "line": 57
843
861
  },
844
862
  "name": "cloudFormationExecutionRoleArn",
845
863
  "optional": true,
@@ -880,7 +898,7 @@
880
898
  "immutable": true,
881
899
  "locationInModule": {
882
900
  "filename": "lib/cloud-assembly/artifact-schema.ts",
883
- "line": 64
901
+ "line": 71
884
902
  },
885
903
  "name": "requiresBootstrapStackVersion",
886
904
  "optional": true,
@@ -916,7 +934,7 @@
916
934
  "immutable": true,
917
935
  "locationInModule": {
918
936
  "filename": "lib/cloud-assembly/artifact-schema.ts",
919
- "line": 57
937
+ "line": 64
920
938
  },
921
939
  "name": "stackTemplateAssetObjectUrl",
922
940
  "optional": true,
@@ -947,6 +965,22 @@
947
965
  }
948
966
  }
949
967
  },
968
+ {
969
+ "abstract": true,
970
+ "docs": {
971
+ "stability": "stable",
972
+ "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
973
+ },
974
+ "immutable": true,
975
+ "locationInModule": {
976
+ "filename": "lib/cloud-assembly/artifact-schema.ts",
977
+ "line": 9
978
+ },
979
+ "name": "templateFile",
980
+ "type": {
981
+ "primitive": "string"
982
+ }
983
+ },
950
984
  {
951
985
  "abstract": true,
952
986
  "docs": {
@@ -975,7 +1009,7 @@
975
1009
  "immutable": true,
976
1010
  "locationInModule": {
977
1011
  "filename": "lib/cloud-assembly/artifact-schema.ts",
978
- "line": 86
1012
+ "line": 93
979
1013
  },
980
1014
  "name": "validateOnSynth",
981
1015
  "optional": true,
@@ -983,14 +1017,16 @@
983
1017
  "primitive": "boolean"
984
1018
  }
985
1019
  }
986
- ]
1020
+ ],
1021
+ "symbolId": "lib/cloud-assembly/artifact-schema:AwsCloudFormationStackProperties"
987
1022
  },
988
1023
  "@aws-cdk/cloud-assembly-schema.AwsDestination": {
989
1024
  "assembly": "@aws-cdk/cloud-assembly-schema",
990
1025
  "datatype": true,
991
1026
  "docs": {
992
1027
  "stability": "stable",
993
- "summary": "Destination for assets that need to be uploaded to AWS."
1028
+ "summary": "Destination for assets that need to be uploaded to AWS.",
1029
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst awsDestination: cloud_assembly_schema.AwsDestination = {\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
994
1030
  },
995
1031
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
996
1032
  "kind": "interface",
@@ -1054,14 +1090,16 @@
1054
1090
  "primitive": "string"
1055
1091
  }
1056
1092
  }
1057
- ]
1093
+ ],
1094
+ "symbolId": "lib/assets/aws-destination:AwsDestination"
1058
1095
  },
1059
1096
  "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry": {
1060
1097
  "assembly": "@aws-cdk/cloud-assembly-schema",
1061
1098
  "datatype": true,
1062
1099
  "docs": {
1063
1100
  "stability": "stable",
1064
- "summary": "Metadata Entry spec for container images."
1101
+ "summary": "Metadata Entry spec for container images.",
1102
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst containerImageAssetMetadataEntry: cloud_assembly_schema.ContainerImageAssetMetadataEntry = {\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n sourceHash: 'sourceHash',\n\n // the properties below are optional\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n file: 'file',\n imageNameParameter: 'imageNameParameter',\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n target: 'target',\n};"
1065
1103
  },
1066
1104
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1067
1105
  "kind": "interface",
@@ -1074,31 +1112,40 @@
1074
1112
  {
1075
1113
  "abstract": true,
1076
1114
  "docs": {
1115
+ "default": "no build args are passed",
1077
1116
  "stability": "stable",
1078
- "summary": "Logical identifier for the asset."
1117
+ "summary": "Build args to pass to the `docker build` command."
1079
1118
  },
1080
1119
  "immutable": true,
1081
1120
  "locationInModule": {
1082
1121
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1083
- "line": 13
1122
+ "line": 119
1084
1123
  },
1085
- "name": "id",
1124
+ "name": "buildArgs",
1125
+ "optional": true,
1086
1126
  "type": {
1087
- "primitive": "string"
1127
+ "collection": {
1128
+ "elementtype": {
1129
+ "primitive": "string"
1130
+ },
1131
+ "kind": "map"
1132
+ }
1088
1133
  }
1089
1134
  },
1090
1135
  {
1091
1136
  "abstract": true,
1092
1137
  "docs": {
1138
+ "default": "- no file is passed",
1093
1139
  "stability": "stable",
1094
- "summary": "Type of asset."
1140
+ "summary": "Path to the Dockerfile (relative to the directory)."
1095
1141
  },
1096
1142
  "immutable": true,
1097
1143
  "locationInModule": {
1098
1144
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1099
- "line": 81
1145
+ "line": 133
1100
1146
  },
1101
- "name": "packaging",
1147
+ "name": "file",
1148
+ "optional": true,
1102
1149
  "type": {
1103
1150
  "primitive": "string"
1104
1151
  }
@@ -1107,14 +1154,14 @@
1107
1154
  "abstract": true,
1108
1155
  "docs": {
1109
1156
  "stability": "stable",
1110
- "summary": "Path on disk to the asset."
1157
+ "summary": "Logical identifier for the asset."
1111
1158
  },
1112
1159
  "immutable": true,
1113
1160
  "locationInModule": {
1114
1161
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1115
- "line": 23
1162
+ "line": 13
1116
1163
  },
1117
- "name": "path",
1164
+ "name": "id",
1118
1165
  "type": {
1119
1166
  "primitive": "string"
1120
1167
  }
@@ -1122,15 +1169,18 @@
1122
1169
  {
1123
1170
  "abstract": true,
1124
1171
  "docs": {
1125
- "stability": "stable",
1126
- "summary": "The hash of the asset source."
1172
+ "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1173
+ "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1174
+ "stability": "deprecated",
1175
+ "summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
1127
1176
  },
1128
1177
  "immutable": true,
1129
1178
  "locationInModule": {
1130
1179
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1131
- "line": 18
1180
+ "line": 93
1132
1181
  },
1133
- "name": "sourceHash",
1182
+ "name": "imageNameParameter",
1183
+ "optional": true,
1134
1184
  "type": {
1135
1185
  "primitive": "string"
1136
1186
  }
@@ -1138,40 +1188,34 @@
1138
1188
  {
1139
1189
  "abstract": true,
1140
1190
  "docs": {
1141
- "default": "no build args are passed",
1191
+ "default": "- this parameter is REQUIRED after 1.21.0",
1192
+ "remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
1142
1193
  "stability": "stable",
1143
- "summary": "Build args to pass to the `docker build` command."
1194
+ "summary": "The docker image tag to use for tagging pushed images."
1144
1195
  },
1145
1196
  "immutable": true,
1146
1197
  "locationInModule": {
1147
1198
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1148
- "line": 119
1199
+ "line": 112
1149
1200
  },
1150
- "name": "buildArgs",
1201
+ "name": "imageTag",
1151
1202
  "optional": true,
1152
1203
  "type": {
1153
- "collection": {
1154
- "elementtype": {
1155
- "primitive": "string"
1156
- },
1157
- "kind": "map"
1158
- }
1204
+ "primitive": "string"
1159
1205
  }
1160
1206
  },
1161
1207
  {
1162
1208
  "abstract": true,
1163
1209
  "docs": {
1164
- "default": "- no file is passed",
1165
1210
  "stability": "stable",
1166
- "summary": "Path to the Dockerfile (relative to the directory)."
1211
+ "summary": "Type of asset."
1167
1212
  },
1168
1213
  "immutable": true,
1169
1214
  "locationInModule": {
1170
1215
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1171
- "line": 133
1216
+ "line": 81
1172
1217
  },
1173
- "name": "file",
1174
- "optional": true,
1218
+ "name": "packaging",
1175
1219
  "type": {
1176
1220
  "primitive": "string"
1177
1221
  }
@@ -1179,18 +1223,15 @@
1179
1223
  {
1180
1224
  "abstract": true,
1181
1225
  "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."
1226
+ "stability": "stable",
1227
+ "summary": "Path on disk to the asset."
1186
1228
  },
1187
1229
  "immutable": true,
1188
1230
  "locationInModule": {
1189
1231
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1190
- "line": 93
1232
+ "line": 23
1191
1233
  },
1192
- "name": "imageNameParameter",
1193
- "optional": true,
1234
+ "name": "path",
1194
1235
  "type": {
1195
1236
  "primitive": "string"
1196
1237
  }
@@ -1199,16 +1240,16 @@
1199
1240
  "abstract": true,
1200
1241
  "docs": {
1201
1242
  "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).",
1243
+ "remarks": "Specify this property if you need to statically address the\nimage, e.g. from a Kubernetes Pod. Note, this is only the repository name,\nwithout the registry and the tag parts.",
1203
1244
  "stability": "stable",
1204
- "summary": "The docker image tag to use for tagging pushed images."
1245
+ "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1205
1246
  },
1206
1247
  "immutable": true,
1207
1248
  "locationInModule": {
1208
1249
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1209
- "line": 112
1250
+ "line": 103
1210
1251
  },
1211
- "name": "imageTag",
1252
+ "name": "repositoryName",
1212
1253
  "optional": true,
1213
1254
  "type": {
1214
1255
  "primitive": "string"
@@ -1217,18 +1258,15 @@
1217
1258
  {
1218
1259
  "abstract": true,
1219
1260
  "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
1261
  "stability": "stable",
1223
- "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1262
+ "summary": "The hash of the asset source."
1224
1263
  },
1225
1264
  "immutable": true,
1226
1265
  "locationInModule": {
1227
1266
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1228
- "line": 103
1267
+ "line": 18
1229
1268
  },
1230
- "name": "repositoryName",
1231
- "optional": true,
1269
+ "name": "sourceHash",
1232
1270
  "type": {
1233
1271
  "primitive": "string"
1234
1272
  }
@@ -1251,7 +1289,8 @@
1251
1289
  "primitive": "string"
1252
1290
  }
1253
1291
  }
1254
- ]
1292
+ ],
1293
+ "symbolId": "lib/cloud-assembly/metadata-schema:ContainerImageAssetMetadataEntry"
1255
1294
  },
1256
1295
  "@aws-cdk/cloud-assembly-schema.ContextProvider": {
1257
1296
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1283,30 +1322,30 @@
1283
1322
  {
1284
1323
  "docs": {
1285
1324
  "stability": "stable",
1286
- "summary": "Route53 Hosted Zone provider."
1325
+ "summary": "VPC Endpoint Service AZ Provider."
1287
1326
  },
1288
- "name": "HOSTED_ZONE_PROVIDER"
1327
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1289
1328
  },
1290
1329
  {
1291
1330
  "docs": {
1292
1331
  "stability": "stable",
1293
- "summary": "SSM Parameter Provider."
1332
+ "summary": "Route53 Hosted Zone provider."
1294
1333
  },
1295
- "name": "SSM_PARAMETER_PROVIDER"
1334
+ "name": "HOSTED_ZONE_PROVIDER"
1296
1335
  },
1297
1336
  {
1298
1337
  "docs": {
1299
1338
  "stability": "stable",
1300
- "summary": "VPC Provider."
1339
+ "summary": "KMS Key Provider."
1301
1340
  },
1302
- "name": "VPC_PROVIDER"
1341
+ "name": "KEY_PROVIDER"
1303
1342
  },
1304
1343
  {
1305
1344
  "docs": {
1306
1345
  "stability": "stable",
1307
- "summary": "VPC Endpoint Service AZ Provider."
1346
+ "summary": "Load balancer listener provider."
1308
1347
  },
1309
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1348
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1310
1349
  },
1311
1350
  {
1312
1351
  "docs": {
@@ -1318,26 +1357,35 @@
1318
1357
  {
1319
1358
  "docs": {
1320
1359
  "stability": "stable",
1321
- "summary": "Load balancer listener provider."
1360
+ "summary": "Security group provider."
1322
1361
  },
1323
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1362
+ "name": "SECURITY_GROUP_PROVIDER"
1324
1363
  },
1325
1364
  {
1326
1365
  "docs": {
1327
1366
  "stability": "stable",
1328
- "summary": "Security group provider."
1367
+ "summary": "SSM Parameter Provider."
1329
1368
  },
1330
- "name": "SECURITY_GROUP_PROVIDER"
1369
+ "name": "SSM_PARAMETER_PROVIDER"
1370
+ },
1371
+ {
1372
+ "docs": {
1373
+ "stability": "stable",
1374
+ "summary": "VPC Provider."
1375
+ },
1376
+ "name": "VPC_PROVIDER"
1331
1377
  }
1332
1378
  ],
1333
- "name": "ContextProvider"
1379
+ "name": "ContextProvider",
1380
+ "symbolId": "lib/cloud-assembly/context-queries:ContextProvider"
1334
1381
  },
1335
1382
  "@aws-cdk/cloud-assembly-schema.DockerImageAsset": {
1336
1383
  "assembly": "@aws-cdk/cloud-assembly-schema",
1337
1384
  "datatype": true,
1338
1385
  "docs": {
1339
1386
  "stability": "stable",
1340
- "summary": "A file asset."
1387
+ "summary": "A file asset.",
1388
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n};"
1341
1389
  },
1342
1390
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1343
1391
  "kind": "interface",
@@ -1384,14 +1432,16 @@
1384
1432
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource"
1385
1433
  }
1386
1434
  }
1387
- ]
1435
+ ],
1436
+ "symbolId": "lib/assets/docker-image-asset:DockerImageAsset"
1388
1437
  },
1389
1438
  "@aws-cdk/cloud-assembly-schema.DockerImageDestination": {
1390
1439
  "assembly": "@aws-cdk/cloud-assembly-schema",
1391
1440
  "datatype": true,
1392
1441
  "docs": {
1393
1442
  "stability": "stable",
1394
- "summary": "Where to publish docker images."
1443
+ "summary": "Where to publish docker images.",
1444
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
1395
1445
  },
1396
1446
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1397
1447
  "interfaces": [
@@ -1436,14 +1486,16 @@
1436
1486
  "primitive": "string"
1437
1487
  }
1438
1488
  }
1439
- ]
1489
+ ],
1490
+ "symbolId": "lib/assets/docker-image-asset:DockerImageDestination"
1440
1491
  },
1441
1492
  "@aws-cdk/cloud-assembly-schema.DockerImageSource": {
1442
1493
  "assembly": "@aws-cdk/cloud-assembly-schema",
1443
1494
  "datatype": true,
1444
1495
  "docs": {
1445
1496
  "stability": "stable",
1446
- "summary": "Properties for how to produce a Docker image from a source."
1497
+ "summary": "Properties for how to produce a Docker image from a source.",
1498
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst dockerImageSource: cloud_assembly_schema.DockerImageSource = {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n};"
1447
1499
  },
1448
1500
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1449
1501
  "kind": "interface",
@@ -1557,20 +1609,22 @@
1557
1609
  }
1558
1610
  }
1559
1611
  }
1560
- ]
1612
+ ],
1613
+ "symbolId": "lib/assets/docker-image-asset:DockerImageSource"
1561
1614
  },
1562
1615
  "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery": {
1563
1616
  "assembly": "@aws-cdk/cloud-assembly-schema",
1564
1617
  "datatype": true,
1565
1618
  "docs": {
1566
1619
  "stability": "stable",
1567
- "summary": "Query to endpoint service context provider."
1620
+ "summary": "Query to endpoint service context provider.",
1621
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst endpointServiceAvailabilityZonesContextQuery: cloud_assembly_schema.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
1568
1622
  },
1569
1623
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1570
1624
  "kind": "interface",
1571
1625
  "locationInModule": {
1572
1626
  "filename": "lib/cloud-assembly/context-queries.ts",
1573
- "line": 233
1627
+ "line": 238
1574
1628
  },
1575
1629
  "name": "EndpointServiceAvailabilityZonesContextQuery",
1576
1630
  "properties": [
@@ -1583,7 +1637,7 @@
1583
1637
  "immutable": true,
1584
1638
  "locationInModule": {
1585
1639
  "filename": "lib/cloud-assembly/context-queries.ts",
1586
- "line": 237
1640
+ "line": 242
1587
1641
  },
1588
1642
  "name": "account",
1589
1643
  "type": {
@@ -1593,15 +1647,17 @@
1593
1647
  {
1594
1648
  "abstract": true,
1595
1649
  "docs": {
1650
+ "default": "- None",
1596
1651
  "stability": "stable",
1597
- "summary": "Query region."
1652
+ "summary": "The ARN of the role that should be used to look up the missing values."
1598
1653
  },
1599
1654
  "immutable": true,
1600
1655
  "locationInModule": {
1601
1656
  "filename": "lib/cloud-assembly/context-queries.ts",
1602
- "line": 242
1657
+ "line": 254
1603
1658
  },
1604
- "name": "region",
1659
+ "name": "lookupRoleArn",
1660
+ "optional": true,
1605
1661
  "type": {
1606
1662
  "primitive": "string"
1607
1663
  }
@@ -1610,14 +1666,14 @@
1610
1666
  "abstract": true,
1611
1667
  "docs": {
1612
1668
  "stability": "stable",
1613
- "summary": "Query service name."
1669
+ "summary": "Query region."
1614
1670
  },
1615
1671
  "immutable": true,
1616
1672
  "locationInModule": {
1617
1673
  "filename": "lib/cloud-assembly/context-queries.ts",
1618
- "line": 254
1674
+ "line": 247
1619
1675
  },
1620
- "name": "serviceName",
1676
+ "name": "region",
1621
1677
  "type": {
1622
1678
  "primitive": "string"
1623
1679
  }
@@ -1625,29 +1681,29 @@
1625
1681
  {
1626
1682
  "abstract": true,
1627
1683
  "docs": {
1628
- "default": "- None",
1629
1684
  "stability": "stable",
1630
- "summary": "The ARN of the role that should be used to look up the missing values."
1685
+ "summary": "Query service name."
1631
1686
  },
1632
1687
  "immutable": true,
1633
1688
  "locationInModule": {
1634
1689
  "filename": "lib/cloud-assembly/context-queries.ts",
1635
- "line": 249
1690
+ "line": 259
1636
1691
  },
1637
- "name": "lookupRoleArn",
1638
- "optional": true,
1692
+ "name": "serviceName",
1639
1693
  "type": {
1640
1694
  "primitive": "string"
1641
1695
  }
1642
1696
  }
1643
- ]
1697
+ ],
1698
+ "symbolId": "lib/cloud-assembly/context-queries:EndpointServiceAvailabilityZonesContextQuery"
1644
1699
  },
1645
1700
  "@aws-cdk/cloud-assembly-schema.FileAsset": {
1646
1701
  "assembly": "@aws-cdk/cloud-assembly-schema",
1647
1702
  "datatype": true,
1648
1703
  "docs": {
1649
1704
  "stability": "stable",
1650
- "summary": "A file asset."
1705
+ "summary": "A file asset.",
1706
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileAsset: cloud_assembly_schema.FileAsset = {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n};"
1651
1707
  },
1652
1708
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1653
1709
  "kind": "interface",
@@ -1694,14 +1750,16 @@
1694
1750
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource"
1695
1751
  }
1696
1752
  }
1697
- ]
1753
+ ],
1754
+ "symbolId": "lib/assets/file-asset:FileAsset"
1698
1755
  },
1699
1756
  "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry": {
1700
1757
  "assembly": "@aws-cdk/cloud-assembly-schema",
1701
1758
  "datatype": true,
1702
1759
  "docs": {
1703
1760
  "stability": "stable",
1704
- "summary": "Metadata Entry spec for files."
1761
+ "summary": "Metadata Entry spec for files.",
1762
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileAssetMetadataEntry: cloud_assembly_schema.FileAssetMetadataEntry = {\n artifactHashParameter: 'artifactHashParameter',\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n s3BucketParameter: 's3BucketParameter',\n s3KeyParameter: 's3KeyParameter',\n sourceHash: 'sourceHash',\n};"
1705
1763
  },
1706
1764
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1707
1765
  "kind": "interface",
@@ -1823,7 +1881,8 @@
1823
1881
  "primitive": "string"
1824
1882
  }
1825
1883
  }
1826
- ]
1884
+ ],
1885
+ "symbolId": "lib/cloud-assembly/metadata-schema:FileAssetMetadataEntry"
1827
1886
  },
1828
1887
  "@aws-cdk/cloud-assembly-schema.FileAssetPackaging": {
1829
1888
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1853,14 +1912,16 @@
1853
1912
  "name": "ZIP_DIRECTORY"
1854
1913
  }
1855
1914
  ],
1856
- "name": "FileAssetPackaging"
1915
+ "name": "FileAssetPackaging",
1916
+ "symbolId": "lib/assets/file-asset:FileAssetPackaging"
1857
1917
  },
1858
1918
  "@aws-cdk/cloud-assembly-schema.FileDestination": {
1859
1919
  "assembly": "@aws-cdk/cloud-assembly-schema",
1860
1920
  "datatype": true,
1861
1921
  "docs": {
1862
1922
  "stability": "stable",
1863
- "summary": "Where in S3 a file asset needs to be published."
1923
+ "summary": "Where in S3 a file asset needs to be published.",
1924
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileDestination: cloud_assembly_schema.FileDestination = {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};"
1864
1925
  },
1865
1926
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1866
1927
  "interfaces": [
@@ -1905,14 +1966,16 @@
1905
1966
  "primitive": "string"
1906
1967
  }
1907
1968
  }
1908
- ]
1969
+ ],
1970
+ "symbolId": "lib/assets/file-asset:FileDestination"
1909
1971
  },
1910
1972
  "@aws-cdk/cloud-assembly-schema.FileSource": {
1911
1973
  "assembly": "@aws-cdk/cloud-assembly-schema",
1912
1974
  "datatype": true,
1913
1975
  "docs": {
1914
1976
  "stability": "stable",
1915
- "summary": "Describe the source of a file asset."
1977
+ "summary": "Describe the source of a file asset.",
1978
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst fileSource: cloud_assembly_schema.FileSource = {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n};"
1916
1979
  },
1917
1980
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1918
1981
  "kind": "interface",
@@ -1983,20 +2046,22 @@
1983
2046
  "primitive": "string"
1984
2047
  }
1985
2048
  }
1986
- ]
2049
+ ],
2050
+ "symbolId": "lib/assets/file-asset:FileSource"
1987
2051
  },
1988
2052
  "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery": {
1989
2053
  "assembly": "@aws-cdk/cloud-assembly-schema",
1990
2054
  "datatype": true,
1991
2055
  "docs": {
1992
2056
  "stability": "stable",
1993
- "summary": "Query to hosted zone context provider."
2057
+ "summary": "Query to hosted zone context provider.",
2058
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {\n account: 'account',\n domainName: 'domainName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n privateZone: false,\n vpcId: 'vpcId',\n};"
1994
2059
  },
1995
2060
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
1996
2061
  "kind": "interface",
1997
2062
  "locationInModule": {
1998
2063
  "filename": "lib/cloud-assembly/context-queries.ts",
1999
- "line": 113
2064
+ "line": 118
2000
2065
  },
2001
2066
  "name": "HostedZoneContextQuery",
2002
2067
  "properties": [
@@ -2009,7 +2074,7 @@
2009
2074
  "immutable": true,
2010
2075
  "locationInModule": {
2011
2076
  "filename": "lib/cloud-assembly/context-queries.ts",
2012
- "line": 117
2077
+ "line": 122
2013
2078
  },
2014
2079
  "name": "account",
2015
2080
  "type": {
@@ -2020,14 +2085,120 @@
2020
2085
  "abstract": true,
2021
2086
  "docs": {
2022
2087
  "stability": "stable",
2023
- "summary": "The domain name e.g. example.com to lookup."
2088
+ "summary": "The domain name e.g. example.com to lookup."
2089
+ },
2090
+ "immutable": true,
2091
+ "locationInModule": {
2092
+ "filename": "lib/cloud-assembly/context-queries.ts",
2093
+ "line": 139
2094
+ },
2095
+ "name": "domainName",
2096
+ "type": {
2097
+ "primitive": "string"
2098
+ }
2099
+ },
2100
+ {
2101
+ "abstract": true,
2102
+ "docs": {
2103
+ "default": "- None",
2104
+ "stability": "stable",
2105
+ "summary": "The ARN of the role that should be used to look up the missing values."
2106
+ },
2107
+ "immutable": true,
2108
+ "locationInModule": {
2109
+ "filename": "lib/cloud-assembly/context-queries.ts",
2110
+ "line": 134
2111
+ },
2112
+ "name": "lookupRoleArn",
2113
+ "optional": true,
2114
+ "type": {
2115
+ "primitive": "string"
2116
+ }
2117
+ },
2118
+ {
2119
+ "abstract": true,
2120
+ "docs": {
2121
+ "default": "false",
2122
+ "stability": "stable",
2123
+ "summary": "True if the zone you want to find is a private hosted zone."
2124
+ },
2125
+ "immutable": true,
2126
+ "locationInModule": {
2127
+ "filename": "lib/cloud-assembly/context-queries.ts",
2128
+ "line": 146
2129
+ },
2130
+ "name": "privateZone",
2131
+ "optional": true,
2132
+ "type": {
2133
+ "primitive": "boolean"
2134
+ }
2135
+ },
2136
+ {
2137
+ "abstract": true,
2138
+ "docs": {
2139
+ "stability": "stable",
2140
+ "summary": "Query region."
2141
+ },
2142
+ "immutable": true,
2143
+ "locationInModule": {
2144
+ "filename": "lib/cloud-assembly/context-queries.ts",
2145
+ "line": 127
2146
+ },
2147
+ "name": "region",
2148
+ "type": {
2149
+ "primitive": "string"
2150
+ }
2151
+ },
2152
+ {
2153
+ "abstract": true,
2154
+ "docs": {
2155
+ "default": "- Required if privateZone=true",
2156
+ "remarks": "If you provide VPC ID and privateZone is false, this will return no results\nand raise an error.",
2157
+ "stability": "stable",
2158
+ "summary": "The VPC ID to that the private zone must be associated with."
2159
+ },
2160
+ "immutable": true,
2161
+ "locationInModule": {
2162
+ "filename": "lib/cloud-assembly/context-queries.ts",
2163
+ "line": 156
2164
+ },
2165
+ "name": "vpcId",
2166
+ "optional": true,
2167
+ "type": {
2168
+ "primitive": "string"
2169
+ }
2170
+ }
2171
+ ],
2172
+ "symbolId": "lib/cloud-assembly/context-queries:HostedZoneContextQuery"
2173
+ },
2174
+ "@aws-cdk/cloud-assembly-schema.KeyContextQuery": {
2175
+ "assembly": "@aws-cdk/cloud-assembly-schema",
2176
+ "datatype": true,
2177
+ "docs": {
2178
+ "stability": "stable",
2179
+ "summary": "Query input for looking up a KMS Key.",
2180
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst keyContextQuery: cloud_assembly_schema.KeyContextQuery = {\n account: 'account',\n aliasName: 'aliasName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
2181
+ },
2182
+ "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
2183
+ "kind": "interface",
2184
+ "locationInModule": {
2185
+ "filename": "lib/cloud-assembly/context-queries.ts",
2186
+ "line": 442
2187
+ },
2188
+ "name": "KeyContextQuery",
2189
+ "properties": [
2190
+ {
2191
+ "abstract": true,
2192
+ "docs": {
2193
+ "stability": "stable",
2194
+ "summary": "Query account."
2024
2195
  },
2025
2196
  "immutable": true,
2026
2197
  "locationInModule": {
2027
2198
  "filename": "lib/cloud-assembly/context-queries.ts",
2028
- "line": 134
2199
+ "line": 446
2029
2200
  },
2030
- "name": "domainName",
2201
+ "name": "account",
2031
2202
  "type": {
2032
2203
  "primitive": "string"
2033
2204
  }
@@ -2036,14 +2207,14 @@
2036
2207
  "abstract": true,
2037
2208
  "docs": {
2038
2209
  "stability": "stable",
2039
- "summary": "Query region."
2210
+ "summary": "Alias name used to search the Key."
2040
2211
  },
2041
2212
  "immutable": true,
2042
2213
  "locationInModule": {
2043
2214
  "filename": "lib/cloud-assembly/context-queries.ts",
2044
- "line": 122
2215
+ "line": 463
2045
2216
  },
2046
- "name": "region",
2217
+ "name": "aliasName",
2047
2218
  "type": {
2048
2219
  "primitive": "string"
2049
2220
  }
@@ -2058,7 +2229,7 @@
2058
2229
  "immutable": true,
2059
2230
  "locationInModule": {
2060
2231
  "filename": "lib/cloud-assembly/context-queries.ts",
2061
- "line": 129
2232
+ "line": 458
2062
2233
  },
2063
2234
  "name": "lookupRoleArn",
2064
2235
  "optional": true,
@@ -2069,48 +2240,29 @@
2069
2240
  {
2070
2241
  "abstract": true,
2071
2242
  "docs": {
2072
- "default": "false",
2073
- "stability": "stable",
2074
- "summary": "True if the zone you want to find is a private hosted zone."
2075
- },
2076
- "immutable": true,
2077
- "locationInModule": {
2078
- "filename": "lib/cloud-assembly/context-queries.ts",
2079
- "line": 141
2080
- },
2081
- "name": "privateZone",
2082
- "optional": true,
2083
- "type": {
2084
- "primitive": "boolean"
2085
- }
2086
- },
2087
- {
2088
- "abstract": true,
2089
- "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
2243
  "stability": "stable",
2093
- "summary": "The VPC ID to that the private zone must be associated with."
2244
+ "summary": "Query region."
2094
2245
  },
2095
2246
  "immutable": true,
2096
2247
  "locationInModule": {
2097
2248
  "filename": "lib/cloud-assembly/context-queries.ts",
2098
- "line": 151
2249
+ "line": 451
2099
2250
  },
2100
- "name": "vpcId",
2101
- "optional": true,
2251
+ "name": "region",
2102
2252
  "type": {
2103
2253
  "primitive": "string"
2104
2254
  }
2105
2255
  }
2106
- ]
2256
+ ],
2257
+ "symbolId": "lib/cloud-assembly/context-queries:KeyContextQuery"
2107
2258
  },
2108
2259
  "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery": {
2109
2260
  "assembly": "@aws-cdk/cloud-assembly-schema",
2110
2261
  "datatype": true,
2111
2262
  "docs": {
2112
2263
  "stability": "stable",
2113
- "summary": "Query input for looking up a load balancer."
2264
+ "summary": "Query input for looking up a load balancer.",
2265
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerContextQuery: cloud_assembly_schema.LoadBalancerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};"
2114
2266
  },
2115
2267
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2116
2268
  "interfaces": [
@@ -2119,7 +2271,7 @@
2119
2271
  "kind": "interface",
2120
2272
  "locationInModule": {
2121
2273
  "filename": "lib/cloud-assembly/context-queries.ts",
2122
- "line": 297
2274
+ "line": 302
2123
2275
  },
2124
2276
  "name": "LoadBalancerContextQuery",
2125
2277
  "properties": [
@@ -2132,7 +2284,7 @@
2132
2284
  "immutable": true,
2133
2285
  "locationInModule": {
2134
2286
  "filename": "lib/cloud-assembly/context-queries.ts",
2135
- "line": 301
2287
+ "line": 306
2136
2288
  },
2137
2289
  "name": "account",
2138
2290
  "type": {
@@ -2142,15 +2294,17 @@
2142
2294
  {
2143
2295
  "abstract": true,
2144
2296
  "docs": {
2297
+ "default": "- None",
2145
2298
  "stability": "stable",
2146
- "summary": "Query region."
2299
+ "summary": "The ARN of the role that should be used to look up the missing values."
2147
2300
  },
2148
2301
  "immutable": true,
2149
2302
  "locationInModule": {
2150
2303
  "filename": "lib/cloud-assembly/context-queries.ts",
2151
- "line": 306
2304
+ "line": 318
2152
2305
  },
2153
- "name": "region",
2306
+ "name": "lookupRoleArn",
2307
+ "optional": true,
2154
2308
  "type": {
2155
2309
  "primitive": "string"
2156
2310
  }
@@ -2158,54 +2312,38 @@
2158
2312
  {
2159
2313
  "abstract": true,
2160
2314
  "docs": {
2161
- "default": "- None",
2162
2315
  "stability": "stable",
2163
- "summary": "The ARN of the role that should be used to look up the missing values."
2316
+ "summary": "Query region."
2164
2317
  },
2165
2318
  "immutable": true,
2166
2319
  "locationInModule": {
2167
2320
  "filename": "lib/cloud-assembly/context-queries.ts",
2168
- "line": 313
2321
+ "line": 311
2169
2322
  },
2170
- "name": "lookupRoleArn",
2171
- "optional": true,
2323
+ "name": "region",
2172
2324
  "type": {
2173
2325
  "primitive": "string"
2174
2326
  }
2175
2327
  }
2176
- ]
2328
+ ],
2329
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerContextQuery"
2177
2330
  },
2178
2331
  "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter": {
2179
2332
  "assembly": "@aws-cdk/cloud-assembly-schema",
2180
2333
  "datatype": true,
2181
2334
  "docs": {
2182
2335
  "stability": "stable",
2183
- "summary": "Filters for selecting load balancers."
2336
+ "summary": "Filters for selecting load balancers.",
2337
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n};"
2184
2338
  },
2185
2339
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2186
2340
  "kind": "interface",
2187
2341
  "locationInModule": {
2188
2342
  "filename": "lib/cloud-assembly/context-queries.ts",
2189
- "line": 275
2343
+ "line": 280
2190
2344
  },
2191
2345
  "name": "LoadBalancerFilter",
2192
2346
  "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
2347
  {
2210
2348
  "abstract": true,
2211
2349
  "docs": {
@@ -2216,7 +2354,7 @@
2216
2354
  "immutable": true,
2217
2355
  "locationInModule": {
2218
2356
  "filename": "lib/cloud-assembly/context-queries.ts",
2219
- "line": 285
2357
+ "line": 290
2220
2358
  },
2221
2359
  "name": "loadBalancerArn",
2222
2360
  "optional": true,
@@ -2234,7 +2372,7 @@
2234
2372
  "immutable": true,
2235
2373
  "locationInModule": {
2236
2374
  "filename": "lib/cloud-assembly/context-queries.ts",
2237
- "line": 291
2375
+ "line": 296
2238
2376
  },
2239
2377
  "name": "loadBalancerTags",
2240
2378
  "optional": true,
@@ -2246,15 +2384,33 @@
2246
2384
  "kind": "array"
2247
2385
  }
2248
2386
  }
2387
+ },
2388
+ {
2389
+ "abstract": true,
2390
+ "docs": {
2391
+ "stability": "stable",
2392
+ "summary": "Filter load balancers by their type."
2393
+ },
2394
+ "immutable": true,
2395
+ "locationInModule": {
2396
+ "filename": "lib/cloud-assembly/context-queries.ts",
2397
+ "line": 284
2398
+ },
2399
+ "name": "loadBalancerType",
2400
+ "type": {
2401
+ "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2402
+ }
2249
2403
  }
2250
- ]
2404
+ ],
2405
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
2251
2406
  },
2252
2407
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery": {
2253
2408
  "assembly": "@aws-cdk/cloud-assembly-schema",
2254
2409
  "datatype": true,
2255
2410
  "docs": {
2256
2411
  "stability": "stable",
2257
- "summary": "Query input for looking up a load balancer listener."
2412
+ "summary": "Query input for looking up a load balancer listener.",
2413
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst loadBalancerListenerContextQuery: cloud_assembly_schema.LoadBalancerListenerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n listenerArn: 'listenerArn',\n listenerPort: 123,\n listenerProtocol: cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};"
2258
2414
  },
2259
2415
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2260
2416
  "interfaces": [
@@ -2263,7 +2419,7 @@
2263
2419
  "kind": "interface",
2264
2420
  "locationInModule": {
2265
2421
  "filename": "lib/cloud-assembly/context-queries.ts",
2266
- "line": 354
2422
+ "line": 359
2267
2423
  },
2268
2424
  "name": "LoadBalancerListenerContextQuery",
2269
2425
  "properties": [
@@ -2274,27 +2430,11 @@
2274
2430
  "summary": "Query account."
2275
2431
  },
2276
2432
  "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
2433
  "locationInModule": {
2294
2434
  "filename": "lib/cloud-assembly/context-queries.ts",
2295
2435
  "line": 363
2296
2436
  },
2297
- "name": "region",
2437
+ "name": "account",
2298
2438
  "type": {
2299
2439
  "primitive": "string"
2300
2440
  }
@@ -2309,7 +2449,7 @@
2309
2449
  "immutable": true,
2310
2450
  "locationInModule": {
2311
2451
  "filename": "lib/cloud-assembly/context-queries.ts",
2312
- "line": 376
2452
+ "line": 381
2313
2453
  },
2314
2454
  "name": "listenerArn",
2315
2455
  "optional": true,
@@ -2327,7 +2467,7 @@
2327
2467
  "immutable": true,
2328
2468
  "locationInModule": {
2329
2469
  "filename": "lib/cloud-assembly/context-queries.ts",
2330
- "line": 388
2470
+ "line": 393
2331
2471
  },
2332
2472
  "name": "listenerPort",
2333
2473
  "optional": true,
@@ -2345,7 +2485,7 @@
2345
2485
  "immutable": true,
2346
2486
  "locationInModule": {
2347
2487
  "filename": "lib/cloud-assembly/context-queries.ts",
2348
- "line": 382
2488
+ "line": 387
2349
2489
  },
2350
2490
  "name": "listenerProtocol",
2351
2491
  "optional": true,
@@ -2363,15 +2503,32 @@
2363
2503
  "immutable": true,
2364
2504
  "locationInModule": {
2365
2505
  "filename": "lib/cloud-assembly/context-queries.ts",
2366
- "line": 370
2506
+ "line": 375
2367
2507
  },
2368
2508
  "name": "lookupRoleArn",
2369
2509
  "optional": true,
2370
2510
  "type": {
2371
2511
  "primitive": "string"
2372
2512
  }
2513
+ },
2514
+ {
2515
+ "abstract": true,
2516
+ "docs": {
2517
+ "stability": "stable",
2518
+ "summary": "Query region."
2519
+ },
2520
+ "immutable": true,
2521
+ "locationInModule": {
2522
+ "filename": "lib/cloud-assembly/context-queries.ts",
2523
+ "line": 368
2524
+ },
2525
+ "name": "region",
2526
+ "type": {
2527
+ "primitive": "string"
2528
+ }
2373
2529
  }
2374
- ]
2530
+ ],
2531
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
2375
2532
  },
2376
2533
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerProtocol": {
2377
2534
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2383,7 +2540,7 @@
2383
2540
  "kind": "enum",
2384
2541
  "locationInModule": {
2385
2542
  "filename": "lib/cloud-assembly/context-queries.ts",
2386
- "line": 319
2543
+ "line": 324
2387
2544
  },
2388
2545
  "members": [
2389
2546
  {
@@ -2410,26 +2567,27 @@
2410
2567
  {
2411
2568
  "docs": {
2412
2569
  "stability": "stable",
2413
- "summary": "TLS protocol."
2570
+ "summary": "TCP and UDP protocol."
2414
2571
  },
2415
- "name": "TLS"
2572
+ "name": "TCP_UDP"
2416
2573
  },
2417
2574
  {
2418
2575
  "docs": {
2419
2576
  "stability": "stable",
2420
- "summary": "UDP protocol."
2577
+ "summary": "TLS protocol."
2421
2578
  },
2422
- "name": "UDP"
2579
+ "name": "TLS"
2423
2580
  },
2424
2581
  {
2425
2582
  "docs": {
2426
2583
  "stability": "stable",
2427
- "summary": "TCP and UDP protocol."
2584
+ "summary": "UDP protocol."
2428
2585
  },
2429
- "name": "TCP_UDP"
2586
+ "name": "UDP"
2430
2587
  }
2431
2588
  ],
2432
- "name": "LoadBalancerListenerProtocol"
2589
+ "name": "LoadBalancerListenerProtocol",
2590
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerProtocol"
2433
2591
  },
2434
2592
  "@aws-cdk/cloud-assembly-schema.LoadBalancerType": {
2435
2593
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2441,25 +2599,26 @@
2441
2599
  "kind": "enum",
2442
2600
  "locationInModule": {
2443
2601
  "filename": "lib/cloud-assembly/context-queries.ts",
2444
- "line": 260
2602
+ "line": 265
2445
2603
  },
2446
2604
  "members": [
2447
2605
  {
2448
2606
  "docs": {
2449
2607
  "stability": "stable",
2450
- "summary": "Network load balancer."
2608
+ "summary": "Application load balancer."
2451
2609
  },
2452
- "name": "NETWORK"
2610
+ "name": "APPLICATION"
2453
2611
  },
2454
2612
  {
2455
2613
  "docs": {
2456
2614
  "stability": "stable",
2457
- "summary": "Application load balancer."
2615
+ "summary": "Network load balancer."
2458
2616
  },
2459
- "name": "APPLICATION"
2617
+ "name": "NETWORK"
2460
2618
  }
2461
2619
  ],
2462
- "name": "LoadBalancerType"
2620
+ "name": "LoadBalancerType",
2621
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerType"
2463
2622
  },
2464
2623
  "@aws-cdk/cloud-assembly-schema.Manifest": {
2465
2624
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2665,14 +2824,16 @@
2665
2824
  "static": true
2666
2825
  }
2667
2826
  ],
2668
- "name": "Manifest"
2827
+ "name": "Manifest",
2828
+ "symbolId": "lib/manifest:Manifest"
2669
2829
  },
2670
2830
  "@aws-cdk/cloud-assembly-schema.MetadataEntry": {
2671
2831
  "assembly": "@aws-cdk/cloud-assembly-schema",
2672
2832
  "datatype": true,
2673
2833
  "docs": {
2674
2834
  "stability": "stable",
2675
- "summary": "A metadata entry in a cloud assembly artifact."
2835
+ "summary": "A metadata entry in a cloud assembly artifact.",
2836
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst metadataEntry: cloud_assembly_schema.MetadataEntry = {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};"
2676
2837
  },
2677
2838
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2678
2839
  "kind": "interface",
@@ -2682,22 +2843,6 @@
2682
2843
  },
2683
2844
  "name": "MetadataEntry",
2684
2845
  "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
2846
  {
2702
2847
  "abstract": true,
2703
2848
  "docs": {
@@ -2758,15 +2903,33 @@
2758
2903
  "kind": "array"
2759
2904
  }
2760
2905
  }
2906
+ },
2907
+ {
2908
+ "abstract": true,
2909
+ "docs": {
2910
+ "stability": "stable",
2911
+ "summary": "The type of the metadata entry."
2912
+ },
2913
+ "immutable": true,
2914
+ "locationInModule": {
2915
+ "filename": "lib/cloud-assembly/metadata-schema.ts",
2916
+ "line": 208
2917
+ },
2918
+ "name": "type",
2919
+ "type": {
2920
+ "primitive": "string"
2921
+ }
2761
2922
  }
2762
- ]
2923
+ ],
2924
+ "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
2763
2925
  },
2764
2926
  "@aws-cdk/cloud-assembly-schema.MissingContext": {
2765
2927
  "assembly": "@aws-cdk/cloud-assembly-schema",
2766
2928
  "datatype": true,
2767
2929
  "docs": {
2768
2930
  "stability": "stable",
2769
- "summary": "Represents a missing piece of context."
2931
+ "summary": "Represents a missing piece of context.",
2932
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst missingContext: cloud_assembly_schema.MissingContext = {\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n};"
2770
2933
  },
2771
2934
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2772
2935
  "kind": "interface",
@@ -2833,6 +2996,9 @@
2833
2996
  },
2834
2997
  {
2835
2998
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery"
2999
+ },
3000
+ {
3001
+ "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery"
2836
3002
  }
2837
3003
  ]
2838
3004
  }
@@ -2854,20 +3020,22 @@
2854
3020
  "fqn": "@aws-cdk/cloud-assembly-schema.ContextProvider"
2855
3021
  }
2856
3022
  }
2857
- ]
3023
+ ],
3024
+ "symbolId": "lib/cloud-assembly/schema:MissingContext"
2858
3025
  },
2859
3026
  "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties": {
2860
3027
  "assembly": "@aws-cdk/cloud-assembly-schema",
2861
3028
  "datatype": true,
2862
3029
  "docs": {
2863
3030
  "stability": "stable",
2864
- "summary": "Artifact properties for nested cloud assemblies."
3031
+ "summary": "Artifact properties for nested cloud assemblies.",
3032
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst nestedCloudAssemblyProperties: cloud_assembly_schema.NestedCloudAssemblyProperties = {\n directoryName: 'directoryName',\n\n // the properties below are optional\n displayName: 'displayName',\n};"
2865
3033
  },
2866
3034
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
2867
3035
  "kind": "interface",
2868
3036
  "locationInModule": {
2869
3037
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2870
- "line": 132
3038
+ "line": 139
2871
3039
  },
2872
3040
  "name": "NestedCloudAssemblyProperties",
2873
3041
  "properties": [
@@ -2880,7 +3048,7 @@
2880
3048
  "immutable": true,
2881
3049
  "locationInModule": {
2882
3050
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2883
- "line": 136
3051
+ "line": 143
2884
3052
  },
2885
3053
  "name": "directoryName",
2886
3054
  "type": {
@@ -2897,7 +3065,7 @@
2897
3065
  "immutable": true,
2898
3066
  "locationInModule": {
2899
3067
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2900
- "line": 143
3068
+ "line": 150
2901
3069
  },
2902
3070
  "name": "displayName",
2903
3071
  "optional": true,
@@ -2905,14 +3073,16 @@
2905
3073
  "primitive": "string"
2906
3074
  }
2907
3075
  }
2908
- ]
3076
+ ],
3077
+ "symbolId": "lib/cloud-assembly/artifact-schema:NestedCloudAssemblyProperties"
2909
3078
  },
2910
3079
  "@aws-cdk/cloud-assembly-schema.RuntimeInfo": {
2911
3080
  "assembly": "@aws-cdk/cloud-assembly-schema",
2912
3081
  "datatype": true,
2913
3082
  "docs": {
2914
3083
  "stability": "stable",
2915
- "summary": "Information about the application's runtime components."
3084
+ "summary": "Information about the application's runtime components.",
3085
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst runtimeInfo: cloud_assembly_schema.RuntimeInfo = {\n libraries: {\n librariesKey: 'libraries',\n },\n};"
2916
3086
  },
2917
3087
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
2918
3088
  "kind": "interface",
@@ -2943,20 +3113,22 @@
2943
3113
  }
2944
3114
  }
2945
3115
  }
2946
- ]
3116
+ ],
3117
+ "symbolId": "lib/cloud-assembly/schema:RuntimeInfo"
2947
3118
  },
2948
3119
  "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery": {
2949
3120
  "assembly": "@aws-cdk/cloud-assembly-schema",
2950
3121
  "datatype": true,
2951
3122
  "docs": {
2952
3123
  "stability": "stable",
2953
- "summary": "Query to SSM Parameter Context Provider."
3124
+ "summary": "Query to SSM Parameter Context Provider.",
3125
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst sSMParameterContextQuery: cloud_assembly_schema.SSMParameterContextQuery = {\n account: 'account',\n parameterName: 'parameterName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};"
2954
3126
  },
2955
3127
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
2956
3128
  "kind": "interface",
2957
3129
  "locationInModule": {
2958
3130
  "filename": "lib/cloud-assembly/context-queries.ts",
2959
- "line": 157
3131
+ "line": 162
2960
3132
  },
2961
3133
  "name": "SSMParameterContextQuery",
2962
3134
  "properties": [
@@ -2969,7 +3141,7 @@
2969
3141
  "immutable": true,
2970
3142
  "locationInModule": {
2971
3143
  "filename": "lib/cloud-assembly/context-queries.ts",
2972
- "line": 161
3144
+ "line": 166
2973
3145
  },
2974
3146
  "name": "account",
2975
3147
  "type": {
@@ -2979,15 +3151,17 @@
2979
3151
  {
2980
3152
  "abstract": true,
2981
3153
  "docs": {
3154
+ "default": "- None",
2982
3155
  "stability": "stable",
2983
- "summary": "Parameter name to query."
3156
+ "summary": "The ARN of the role that should be used to look up the missing values."
2984
3157
  },
2985
3158
  "immutable": true,
2986
3159
  "locationInModule": {
2987
3160
  "filename": "lib/cloud-assembly/context-queries.ts",
2988
3161
  "line": 178
2989
3162
  },
2990
- "name": "parameterName",
3163
+ "name": "lookupRoleArn",
3164
+ "optional": true,
2991
3165
  "type": {
2992
3166
  "primitive": "string"
2993
3167
  }
@@ -2996,14 +3170,14 @@
2996
3170
  "abstract": true,
2997
3171
  "docs": {
2998
3172
  "stability": "stable",
2999
- "summary": "Query region."
3173
+ "summary": "Parameter name to query."
3000
3174
  },
3001
3175
  "immutable": true,
3002
3176
  "locationInModule": {
3003
3177
  "filename": "lib/cloud-assembly/context-queries.ts",
3004
- "line": 166
3178
+ "line": 183
3005
3179
  },
3006
- "name": "region",
3180
+ "name": "parameterName",
3007
3181
  "type": {
3008
3182
  "primitive": "string"
3009
3183
  }
@@ -3011,35 +3185,35 @@
3011
3185
  {
3012
3186
  "abstract": true,
3013
3187
  "docs": {
3014
- "default": "- None",
3015
3188
  "stability": "stable",
3016
- "summary": "The ARN of the role that should be used to look up the missing values."
3189
+ "summary": "Query region."
3017
3190
  },
3018
3191
  "immutable": true,
3019
3192
  "locationInModule": {
3020
3193
  "filename": "lib/cloud-assembly/context-queries.ts",
3021
- "line": 173
3194
+ "line": 171
3022
3195
  },
3023
- "name": "lookupRoleArn",
3024
- "optional": true,
3196
+ "name": "region",
3025
3197
  "type": {
3026
3198
  "primitive": "string"
3027
3199
  }
3028
3200
  }
3029
- ]
3201
+ ],
3202
+ "symbolId": "lib/cloud-assembly/context-queries:SSMParameterContextQuery"
3030
3203
  },
3031
3204
  "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery": {
3032
3205
  "assembly": "@aws-cdk/cloud-assembly-schema",
3033
3206
  "datatype": true,
3034
3207
  "docs": {
3035
3208
  "stability": "stable",
3036
- "summary": "Query input for looking up a security group."
3209
+ "summary": "Query input for looking up a security group.",
3210
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n securityGroupId: 'securityGroupId',\n securityGroupName: 'securityGroupName',\n vpcId: 'vpcId',\n};"
3037
3211
  },
3038
3212
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
3039
3213
  "kind": "interface",
3040
3214
  "locationInModule": {
3041
3215
  "filename": "lib/cloud-assembly/context-queries.ts",
3042
- "line": 394
3216
+ "line": 399
3043
3217
  },
3044
3218
  "name": "SecurityGroupContextQuery",
3045
3219
  "properties": [
@@ -3052,13 +3226,31 @@
3052
3226
  "immutable": true,
3053
3227
  "locationInModule": {
3054
3228
  "filename": "lib/cloud-assembly/context-queries.ts",
3055
- "line": 398
3229
+ "line": 403
3056
3230
  },
3057
3231
  "name": "account",
3058
3232
  "type": {
3059
3233
  "primitive": "string"
3060
3234
  }
3061
3235
  },
3236
+ {
3237
+ "abstract": true,
3238
+ "docs": {
3239
+ "default": "- None",
3240
+ "stability": "stable",
3241
+ "summary": "The ARN of the role that should be used to look up the missing values."
3242
+ },
3243
+ "immutable": true,
3244
+ "locationInModule": {
3245
+ "filename": "lib/cloud-assembly/context-queries.ts",
3246
+ "line": 415
3247
+ },
3248
+ "name": "lookupRoleArn",
3249
+ "optional": true,
3250
+ "type": {
3251
+ "primitive": "string"
3252
+ }
3253
+ },
3062
3254
  {
3063
3255
  "abstract": true,
3064
3256
  "docs": {
@@ -3068,7 +3260,7 @@
3068
3260
  "immutable": true,
3069
3261
  "locationInModule": {
3070
3262
  "filename": "lib/cloud-assembly/context-queries.ts",
3071
- "line": 403
3263
+ "line": 408
3072
3264
  },
3073
3265
  "name": "region",
3074
3266
  "type": {
@@ -3078,15 +3270,17 @@
3078
3270
  {
3079
3271
  "abstract": true,
3080
3272
  "docs": {
3273
+ "default": "- None",
3081
3274
  "stability": "stable",
3082
3275
  "summary": "Security group id."
3083
3276
  },
3084
3277
  "immutable": true,
3085
3278
  "locationInModule": {
3086
3279
  "filename": "lib/cloud-assembly/context-queries.ts",
3087
- "line": 415
3280
+ "line": 422
3088
3281
  },
3089
3282
  "name": "securityGroupId",
3283
+ "optional": true,
3090
3284
  "type": {
3091
3285
  "primitive": "string"
3092
3286
  }
@@ -3096,27 +3290,47 @@
3096
3290
  "docs": {
3097
3291
  "default": "- None",
3098
3292
  "stability": "stable",
3099
- "summary": "The ARN of the role that should be used to look up the missing values."
3293
+ "summary": "Security group name."
3100
3294
  },
3101
3295
  "immutable": true,
3102
3296
  "locationInModule": {
3103
3297
  "filename": "lib/cloud-assembly/context-queries.ts",
3104
- "line": 410
3298
+ "line": 429
3105
3299
  },
3106
- "name": "lookupRoleArn",
3300
+ "name": "securityGroupName",
3301
+ "optional": true,
3302
+ "type": {
3303
+ "primitive": "string"
3304
+ }
3305
+ },
3306
+ {
3307
+ "abstract": true,
3308
+ "docs": {
3309
+ "default": "- None",
3310
+ "stability": "stable",
3311
+ "summary": "VPC ID."
3312
+ },
3313
+ "immutable": true,
3314
+ "locationInModule": {
3315
+ "filename": "lib/cloud-assembly/context-queries.ts",
3316
+ "line": 436
3317
+ },
3318
+ "name": "vpcId",
3107
3319
  "optional": true,
3108
3320
  "type": {
3109
3321
  "primitive": "string"
3110
3322
  }
3111
3323
  }
3112
- ]
3324
+ ],
3325
+ "symbolId": "lib/cloud-assembly/context-queries:SecurityGroupContextQuery"
3113
3326
  },
3114
3327
  "@aws-cdk/cloud-assembly-schema.Tag": {
3115
3328
  "assembly": "@aws-cdk/cloud-assembly-schema",
3116
3329
  "datatype": true,
3117
3330
  "docs": {
3118
3331
  "stability": "stable",
3119
- "summary": "Metadata Entry spec for stack tag."
3332
+ "summary": "Metadata Entry spec for stack tag.",
3333
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst tag: cloud_assembly_schema.Tag = {\n key: 'key',\n value: 'value',\n};"
3120
3334
  },
3121
3335
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
3122
3336
  "kind": "interface",
@@ -3160,20 +3374,22 @@
3160
3374
  "primitive": "string"
3161
3375
  }
3162
3376
  }
3163
- ]
3377
+ ],
3378
+ "symbolId": "lib/cloud-assembly/metadata-schema:Tag"
3164
3379
  },
3165
3380
  "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties": {
3166
3381
  "assembly": "@aws-cdk/cloud-assembly-schema",
3167
3382
  "datatype": true,
3168
3383
  "docs": {
3169
3384
  "stability": "stable",
3170
- "summary": "Artifact properties for the Construct Tree Artifact."
3385
+ "summary": "Artifact properties for the Construct Tree Artifact.",
3386
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst treeArtifactProperties: cloud_assembly_schema.TreeArtifactProperties = {\n file: 'file',\n};"
3171
3387
  },
3172
3388
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3173
3389
  "kind": "interface",
3174
3390
  "locationInModule": {
3175
3391
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3176
- "line": 122
3392
+ "line": 129
3177
3393
  },
3178
3394
  "name": "TreeArtifactProperties",
3179
3395
  "properties": [
@@ -3186,27 +3402,29 @@
3186
3402
  "immutable": true,
3187
3403
  "locationInModule": {
3188
3404
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3189
- "line": 126
3405
+ "line": 133
3190
3406
  },
3191
3407
  "name": "file",
3192
3408
  "type": {
3193
3409
  "primitive": "string"
3194
3410
  }
3195
3411
  }
3196
- ]
3412
+ ],
3413
+ "symbolId": "lib/cloud-assembly/artifact-schema:TreeArtifactProperties"
3197
3414
  },
3198
3415
  "@aws-cdk/cloud-assembly-schema.VpcContextQuery": {
3199
3416
  "assembly": "@aws-cdk/cloud-assembly-schema",
3200
3417
  "datatype": true,
3201
3418
  "docs": {
3202
3419
  "stability": "stable",
3203
- "summary": "Query input for looking up a VPC."
3420
+ "summary": "Query input for looking up a VPC.",
3421
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\n\nconst vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {\n account: 'account',\n filter: {\n filterKey: 'filter',\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n returnAsymmetricSubnets: false,\n subnetGroupNameTag: 'subnetGroupNameTag',\n};"
3204
3422
  },
3205
3423
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3206
3424
  "kind": "interface",
3207
3425
  "locationInModule": {
3208
3426
  "filename": "lib/cloud-assembly/context-queries.ts",
3209
- "line": 184
3427
+ "line": 189
3210
3428
  },
3211
3429
  "name": "VpcContextQuery",
3212
3430
  "properties": [
@@ -3219,7 +3437,7 @@
3219
3437
  "immutable": true,
3220
3438
  "locationInModule": {
3221
3439
  "filename": "lib/cloud-assembly/context-queries.ts",
3222
- "line": 188
3440
+ "line": 193
3223
3441
  },
3224
3442
  "name": "account",
3225
3443
  "type": {
@@ -3237,7 +3455,7 @@
3237
3455
  "immutable": true,
3238
3456
  "locationInModule": {
3239
3457
  "filename": "lib/cloud-assembly/context-queries.ts",
3240
- "line": 209
3458
+ "line": 214
3241
3459
  },
3242
3460
  "name": "filter",
3243
3461
  "type": {
@@ -3252,15 +3470,17 @@
3252
3470
  {
3253
3471
  "abstract": true,
3254
3472
  "docs": {
3473
+ "default": "- None",
3255
3474
  "stability": "stable",
3256
- "summary": "Query region."
3475
+ "summary": "The ARN of the role that should be used to look up the missing values."
3257
3476
  },
3258
3477
  "immutable": true,
3259
3478
  "locationInModule": {
3260
3479
  "filename": "lib/cloud-assembly/context-queries.ts",
3261
- "line": 193
3480
+ "line": 205
3262
3481
  },
3263
- "name": "region",
3482
+ "name": "lookupRoleArn",
3483
+ "optional": true,
3264
3484
  "type": {
3265
3485
  "primitive": "string"
3266
3486
  }
@@ -3268,17 +3488,15 @@
3268
3488
  {
3269
3489
  "abstract": true,
3270
3490
  "docs": {
3271
- "default": "- None",
3272
3491
  "stability": "stable",
3273
- "summary": "The ARN of the role that should be used to look up the missing values."
3492
+ "summary": "Query region."
3274
3493
  },
3275
3494
  "immutable": true,
3276
3495
  "locationInModule": {
3277
3496
  "filename": "lib/cloud-assembly/context-queries.ts",
3278
- "line": 200
3497
+ "line": 198
3279
3498
  },
3280
- "name": "lookupRoleArn",
3281
- "optional": true,
3499
+ "name": "region",
3282
3500
  "type": {
3283
3501
  "primitive": "string"
3284
3502
  }
@@ -3293,7 +3511,7 @@
3293
3511
  "immutable": true,
3294
3512
  "locationInModule": {
3295
3513
  "filename": "lib/cloud-assembly/context-queries.ts",
3296
- "line": 217
3514
+ "line": 222
3297
3515
  },
3298
3516
  "name": "returnAsymmetricSubnets",
3299
3517
  "optional": true,
@@ -3312,7 +3530,7 @@
3312
3530
  "immutable": true,
3313
3531
  "locationInModule": {
3314
3532
  "filename": "lib/cloud-assembly/context-queries.ts",
3315
- "line": 227
3533
+ "line": 232
3316
3534
  },
3317
3535
  "name": "subnetGroupNameTag",
3318
3536
  "optional": true,
@@ -3320,9 +3538,10 @@
3320
3538
  "primitive": "string"
3321
3539
  }
3322
3540
  }
3323
- ]
3541
+ ],
3542
+ "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3324
3543
  }
3325
3544
  },
3326
- "version": "2.0.0-rc.9",
3327
- "fingerprint": "5jf2oXiyNF/ntHp+H59Xr38PjEYoDvykNsF2aOLltUk="
3545
+ "version": "2.0.0",
3546
+ "fingerprint": "**********"
3328
3547
  }