@aws-cdk/cloud-assembly-schema 2.0.0-rc.6 → 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.29.0 (build 41df200)",
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": 77
113
+ "line": 89
112
114
  },
113
115
  "name": "filters",
114
116
  "type": {
@@ -128,15 +130,17 @@
128
130
  {
129
131
  "abstract": true,
130
132
  "docs": {
133
+ "default": "- None",
131
134
  "stability": "stable",
132
- "summary": "Region to query."
135
+ "summary": "The ARN of the role that should be used to look up the missing values."
133
136
  },
134
137
  "immutable": true,
135
138
  "locationInModule": {
136
139
  "filename": "lib/cloud-assembly/context-queries.ts",
137
- "line": 65
140
+ "line": 77
138
141
  },
139
- "name": "region",
142
+ "name": "lookupRoleArn",
143
+ "optional": true,
140
144
  "type": {
141
145
  "primitive": "string"
142
146
  }
@@ -151,7 +155,7 @@
151
155
  "immutable": true,
152
156
  "locationInModule": {
153
157
  "filename": "lib/cloud-assembly/context-queries.ts",
154
- "line": 72
158
+ "line": 84
155
159
  },
156
160
  "name": "owners",
157
161
  "optional": true,
@@ -163,15 +167,33 @@
163
167
  "kind": "array"
164
168
  }
165
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
+ }
166
186
  }
167
- ]
187
+ ],
188
+ "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
168
189
  },
169
190
  "@aws-cdk/cloud-assembly-schema.ArtifactManifest": {
170
191
  "assembly": "@aws-cdk/cloud-assembly-schema",
171
192
  "datatype": true,
172
193
  "docs": {
173
194
  "stability": "stable",
174
- "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};"
175
197
  },
176
198
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
177
199
  "kind": "interface",
@@ -181,22 +203,6 @@
181
203
  },
182
204
  "name": "ArtifactManifest",
183
205
  "properties": [
184
- {
185
- "abstract": true,
186
- "docs": {
187
- "stability": "stable",
188
- "summary": "The type of artifact."
189
- },
190
- "immutable": true,
191
- "locationInModule": {
192
- "filename": "lib/cloud-assembly/schema.ts",
193
- "line": 72
194
- },
195
- "name": "type",
196
- "type": {
197
- "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
198
- }
199
- },
200
206
  {
201
207
  "abstract": true,
202
208
  "docs": {
@@ -317,8 +323,25 @@
317
323
  ]
318
324
  }
319
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
+ }
320
342
  }
321
- ]
343
+ ],
344
+ "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
322
345
  },
323
346
  "@aws-cdk/cloud-assembly-schema.ArtifactMetadataEntryType": {
324
347
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -376,7 +399,8 @@
376
399
  "name": "STACK_TAGS"
377
400
  }
378
401
  ],
379
- "name": "ArtifactMetadataEntryType"
402
+ "name": "ArtifactMetadataEntryType",
403
+ "symbolId": "lib/cloud-assembly/metadata-schema:ArtifactMetadataEntryType"
380
404
  },
381
405
  "@aws-cdk/cloud-assembly-schema.ArtifactType": {
382
406
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -394,9 +418,9 @@
394
418
  {
395
419
  "docs": {
396
420
  "stability": "stable",
397
- "summary": "Stub required because of JSII."
421
+ "summary": "Manifest for all assets in the Cloud Assembly."
398
422
  },
399
- "name": "NONE"
423
+ "name": "ASSET_MANIFEST"
400
424
  },
401
425
  {
402
426
  "docs": {
@@ -415,26 +439,28 @@
415
439
  {
416
440
  "docs": {
417
441
  "stability": "stable",
418
- "summary": "Manifest for all assets in the Cloud Assembly."
442
+ "summary": "Nested Cloud Assembly."
419
443
  },
420
- "name": "ASSET_MANIFEST"
444
+ "name": "NESTED_CLOUD_ASSEMBLY"
421
445
  },
422
446
  {
423
447
  "docs": {
424
448
  "stability": "stable",
425
- "summary": "Nested Cloud Assembly."
449
+ "summary": "Stub required because of JSII."
426
450
  },
427
- "name": "NESTED_CLOUD_ASSEMBLY"
451
+ "name": "NONE"
428
452
  }
429
453
  ],
430
- "name": "ArtifactType"
454
+ "name": "ArtifactType",
455
+ "symbolId": "lib/cloud-assembly/schema:ArtifactType"
431
456
  },
432
457
  "@aws-cdk/cloud-assembly-schema.AssemblyManifest": {
433
458
  "assembly": "@aws-cdk/cloud-assembly-schema",
434
459
  "datatype": true,
435
460
  "docs": {
436
461
  "stability": "stable",
437
- "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};"
438
464
  },
439
465
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
440
466
  "kind": "interface",
@@ -444,22 +470,6 @@
444
470
  },
445
471
  "name": "AssemblyManifest",
446
472
  "properties": [
447
- {
448
- "abstract": true,
449
- "docs": {
450
- "stability": "stable",
451
- "summary": "Protocol version."
452
- },
453
- "immutable": true,
454
- "locationInModule": {
455
- "filename": "lib/cloud-assembly/schema.ts",
456
- "line": 117
457
- },
458
- "name": "version",
459
- "type": {
460
- "primitive": "string"
461
- }
462
- },
463
473
  {
464
474
  "abstract": true,
465
475
  "docs": {
@@ -524,15 +534,33 @@
524
534
  "type": {
525
535
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
526
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
+ }
527
553
  }
528
- ]
554
+ ],
555
+ "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
529
556
  },
530
557
  "@aws-cdk/cloud-assembly-schema.AssetManifest": {
531
558
  "assembly": "@aws-cdk/cloud-assembly-schema",
532
559
  "datatype": true,
533
560
  "docs": {
534
561
  "stability": "stable",
535
- "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};"
536
564
  },
537
565
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
538
566
  "kind": "interface",
@@ -542,22 +570,6 @@
542
570
  },
543
571
  "name": "AssetManifest",
544
572
  "properties": [
545
- {
546
- "abstract": true,
547
- "docs": {
548
- "stability": "stable",
549
- "summary": "Version of the manifest."
550
- },
551
- "immutable": true,
552
- "locationInModule": {
553
- "filename": "lib/assets/schema.ts",
554
- "line": 11
555
- },
556
- "name": "version",
557
- "type": {
558
- "primitive": "string"
559
- }
560
- },
561
573
  {
562
574
  "abstract": true,
563
575
  "docs": {
@@ -603,36 +615,57 @@
603
615
  "kind": "map"
604
616
  }
605
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
+ }
606
634
  }
607
- ]
635
+ ],
636
+ "symbolId": "lib/assets/schema:AssetManifest"
608
637
  },
609
638
  "@aws-cdk/cloud-assembly-schema.AssetManifestProperties": {
610
639
  "assembly": "@aws-cdk/cloud-assembly-schema",
611
640
  "datatype": true,
612
641
  "docs": {
613
642
  "stability": "stable",
614
- "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};"
615
645
  },
616
646
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
617
647
  "kind": "interface",
618
648
  "locationInModule": {
619
649
  "filename": "lib/cloud-assembly/artifact-schema.ts",
620
- "line": 92
650
+ "line": 99
621
651
  },
622
652
  "name": "AssetManifestProperties",
623
653
  "properties": [
624
654
  {
625
655
  "abstract": true,
626
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.",
627
659
  "stability": "stable",
628
- "summary": "Filename of the asset manifest."
660
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
629
661
  },
630
662
  "immutable": true,
631
663
  "locationInModule": {
632
664
  "filename": "lib/cloud-assembly/artifact-schema.ts",
633
- "line": 96
665
+ "line": 123
634
666
  },
635
- "name": "file",
667
+ "name": "bootstrapStackVersionSsmParameter",
668
+ "optional": true,
636
669
  "type": {
637
670
  "primitive": "string"
638
671
  }
@@ -640,18 +673,15 @@
640
673
  {
641
674
  "abstract": true,
642
675
  "docs": {
643
- "default": "- Bootstrap stack version number looked up",
644
- "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
676
  "stability": "stable",
646
- "summary": "SSM parameter where the bootstrap stack version number can be found."
677
+ "summary": "Filename of the asset manifest."
647
678
  },
648
679
  "immutable": true,
649
680
  "locationInModule": {
650
681
  "filename": "lib/cloud-assembly/artifact-schema.ts",
651
- "line": 116
682
+ "line": 103
652
683
  },
653
- "name": "bootstrapStackVersionSsmParameter",
654
- "optional": true,
684
+ "name": "file",
655
685
  "type": {
656
686
  "primitive": "string"
657
687
  }
@@ -666,7 +696,7 @@
666
696
  "immutable": true,
667
697
  "locationInModule": {
668
698
  "filename": "lib/cloud-assembly/artifact-schema.ts",
669
- "line": 103
699
+ "line": 110
670
700
  },
671
701
  "name": "requiresBootstrapStackVersion",
672
702
  "optional": true,
@@ -674,20 +704,22 @@
674
704
  "primitive": "number"
675
705
  }
676
706
  }
677
- ]
707
+ ],
708
+ "symbolId": "lib/cloud-assembly/artifact-schema:AssetManifestProperties"
678
709
  },
679
710
  "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery": {
680
711
  "assembly": "@aws-cdk/cloud-assembly-schema",
681
712
  "datatype": true,
682
713
  "docs": {
683
714
  "stability": "stable",
684
- "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};"
685
717
  },
686
718
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
687
719
  "kind": "interface",
688
720
  "locationInModule": {
689
721
  "filename": "lib/cloud-assembly/context-queries.ts",
690
- "line": 83
722
+ "line": 95
691
723
  },
692
724
  "name": "AvailabilityZonesContextQuery",
693
725
  "properties": [
@@ -700,13 +732,31 @@
700
732
  "immutable": true,
701
733
  "locationInModule": {
702
734
  "filename": "lib/cloud-assembly/context-queries.ts",
703
- "line": 87
735
+ "line": 99
704
736
  },
705
737
  "name": "account",
706
738
  "type": {
707
739
  "primitive": "string"
708
740
  }
709
741
  },
742
+ {
743
+ "abstract": true,
744
+ "docs": {
745
+ "default": "- None",
746
+ "stability": "stable",
747
+ "summary": "The ARN of the role that should be used to look up the missing values."
748
+ },
749
+ "immutable": true,
750
+ "locationInModule": {
751
+ "filename": "lib/cloud-assembly/context-queries.ts",
752
+ "line": 111
753
+ },
754
+ "name": "lookupRoleArn",
755
+ "optional": true,
756
+ "type": {
757
+ "primitive": "string"
758
+ }
759
+ },
710
760
  {
711
761
  "abstract": true,
712
762
  "docs": {
@@ -716,21 +766,23 @@
716
766
  "immutable": true,
717
767
  "locationInModule": {
718
768
  "filename": "lib/cloud-assembly/context-queries.ts",
719
- "line": 92
769
+ "line": 104
720
770
  },
721
771
  "name": "region",
722
772
  "type": {
723
773
  "primitive": "string"
724
774
  }
725
775
  }
726
- ]
776
+ ],
777
+ "symbolId": "lib/cloud-assembly/context-queries:AvailabilityZonesContextQuery"
727
778
  },
728
779
  "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties": {
729
780
  "assembly": "@aws-cdk/cloud-assembly-schema",
730
781
  "datatype": true,
731
782
  "docs": {
732
783
  "stability": "stable",
733
- "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};"
734
786
  },
735
787
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
736
788
  "kind": "interface",
@@ -743,15 +795,17 @@
743
795
  {
744
796
  "abstract": true,
745
797
  "docs": {
798
+ "default": "- No role is assumed (current credentials are used)",
746
799
  "stability": "stable",
747
- "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."
748
801
  },
749
802
  "immutable": true,
750
803
  "locationInModule": {
751
804
  "filename": "lib/cloud-assembly/artifact-schema.ts",
752
- "line": 9
805
+ "line": 43
753
806
  },
754
- "name": "templateFile",
807
+ "name": "assumeRoleArn",
808
+ "optional": true,
755
809
  "type": {
756
810
  "primitive": "string"
757
811
  }
@@ -759,16 +813,16 @@
759
813
  {
760
814
  "abstract": true,
761
815
  "docs": {
762
- "default": "- No role is assumed (current credentials are used)",
816
+ "default": "- No external ID",
763
817
  "stability": "stable",
764
- "summary": "The role that needs to be assumed to deploy the stack."
818
+ "summary": "External ID to use when assuming role for cloudformation deployments."
765
819
  },
766
820
  "immutable": true,
767
821
  "locationInModule": {
768
822
  "filename": "lib/cloud-assembly/artifact-schema.ts",
769
- "line": 43
823
+ "line": 50
770
824
  },
771
- "name": "assumeRoleArn",
825
+ "name": "assumeRoleExternalId",
772
826
  "optional": true,
773
827
  "type": {
774
828
  "primitive": "string"
@@ -785,7 +839,7 @@
785
839
  "immutable": true,
786
840
  "locationInModule": {
787
841
  "filename": "lib/cloud-assembly/artifact-schema.ts",
788
- "line": 79
842
+ "line": 86
789
843
  },
790
844
  "name": "bootstrapStackVersionSsmParameter",
791
845
  "optional": true,
@@ -803,7 +857,7 @@
803
857
  "immutable": true,
804
858
  "locationInModule": {
805
859
  "filename": "lib/cloud-assembly/artifact-schema.ts",
806
- "line": 50
860
+ "line": 57
807
861
  },
808
862
  "name": "cloudFormationExecutionRoleArn",
809
863
  "optional": true,
@@ -844,7 +898,7 @@
844
898
  "immutable": true,
845
899
  "locationInModule": {
846
900
  "filename": "lib/cloud-assembly/artifact-schema.ts",
847
- "line": 64
901
+ "line": 71
848
902
  },
849
903
  "name": "requiresBootstrapStackVersion",
850
904
  "optional": true,
@@ -880,7 +934,7 @@
880
934
  "immutable": true,
881
935
  "locationInModule": {
882
936
  "filename": "lib/cloud-assembly/artifact-schema.ts",
883
- "line": 57
937
+ "line": 64
884
938
  },
885
939
  "name": "stackTemplateAssetObjectUrl",
886
940
  "optional": true,
@@ -911,6 +965,22 @@
911
965
  }
912
966
  }
913
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
+ },
914
984
  {
915
985
  "abstract": true,
916
986
  "docs": {
@@ -939,7 +1009,7 @@
939
1009
  "immutable": true,
940
1010
  "locationInModule": {
941
1011
  "filename": "lib/cloud-assembly/artifact-schema.ts",
942
- "line": 86
1012
+ "line": 93
943
1013
  },
944
1014
  "name": "validateOnSynth",
945
1015
  "optional": true,
@@ -947,14 +1017,16 @@
947
1017
  "primitive": "boolean"
948
1018
  }
949
1019
  }
950
- ]
1020
+ ],
1021
+ "symbolId": "lib/cloud-assembly/artifact-schema:AwsCloudFormationStackProperties"
951
1022
  },
952
1023
  "@aws-cdk/cloud-assembly-schema.AwsDestination": {
953
1024
  "assembly": "@aws-cdk/cloud-assembly-schema",
954
1025
  "datatype": true,
955
1026
  "docs": {
956
1027
  "stability": "stable",
957
- "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};"
958
1030
  },
959
1031
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
960
1032
  "kind": "interface",
@@ -1018,14 +1090,16 @@
1018
1090
  "primitive": "string"
1019
1091
  }
1020
1092
  }
1021
- ]
1093
+ ],
1094
+ "symbolId": "lib/assets/aws-destination:AwsDestination"
1022
1095
  },
1023
1096
  "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry": {
1024
1097
  "assembly": "@aws-cdk/cloud-assembly-schema",
1025
1098
  "datatype": true,
1026
1099
  "docs": {
1027
1100
  "stability": "stable",
1028
- "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};"
1029
1103
  },
1030
1104
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1031
1105
  "kind": "interface",
@@ -1038,31 +1112,40 @@
1038
1112
  {
1039
1113
  "abstract": true,
1040
1114
  "docs": {
1115
+ "default": "no build args are passed",
1041
1116
  "stability": "stable",
1042
- "summary": "Logical identifier for the asset."
1117
+ "summary": "Build args to pass to the `docker build` command."
1043
1118
  },
1044
1119
  "immutable": true,
1045
1120
  "locationInModule": {
1046
1121
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1047
- "line": 13
1122
+ "line": 119
1048
1123
  },
1049
- "name": "id",
1124
+ "name": "buildArgs",
1125
+ "optional": true,
1050
1126
  "type": {
1051
- "primitive": "string"
1127
+ "collection": {
1128
+ "elementtype": {
1129
+ "primitive": "string"
1130
+ },
1131
+ "kind": "map"
1132
+ }
1052
1133
  }
1053
1134
  },
1054
1135
  {
1055
1136
  "abstract": true,
1056
1137
  "docs": {
1138
+ "default": "- no file is passed",
1057
1139
  "stability": "stable",
1058
- "summary": "Type of asset."
1140
+ "summary": "Path to the Dockerfile (relative to the directory)."
1059
1141
  },
1060
1142
  "immutable": true,
1061
1143
  "locationInModule": {
1062
1144
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1063
- "line": 81
1145
+ "line": 133
1064
1146
  },
1065
- "name": "packaging",
1147
+ "name": "file",
1148
+ "optional": true,
1066
1149
  "type": {
1067
1150
  "primitive": "string"
1068
1151
  }
@@ -1071,14 +1154,14 @@
1071
1154
  "abstract": true,
1072
1155
  "docs": {
1073
1156
  "stability": "stable",
1074
- "summary": "Path on disk to the asset."
1157
+ "summary": "Logical identifier for the asset."
1075
1158
  },
1076
1159
  "immutable": true,
1077
1160
  "locationInModule": {
1078
1161
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1079
- "line": 23
1162
+ "line": 13
1080
1163
  },
1081
- "name": "path",
1164
+ "name": "id",
1082
1165
  "type": {
1083
1166
  "primitive": "string"
1084
1167
  }
@@ -1086,15 +1169,18 @@
1086
1169
  {
1087
1170
  "abstract": true,
1088
1171
  "docs": {
1089
- "stability": "stable",
1090
- "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."
1091
1176
  },
1092
1177
  "immutable": true,
1093
1178
  "locationInModule": {
1094
1179
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1095
- "line": 18
1180
+ "line": 93
1096
1181
  },
1097
- "name": "sourceHash",
1182
+ "name": "imageNameParameter",
1183
+ "optional": true,
1098
1184
  "type": {
1099
1185
  "primitive": "string"
1100
1186
  }
@@ -1102,40 +1188,34 @@
1102
1188
  {
1103
1189
  "abstract": true,
1104
1190
  "docs": {
1105
- "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).",
1106
1193
  "stability": "stable",
1107
- "summary": "Build args to pass to the `docker build` command."
1194
+ "summary": "The docker image tag to use for tagging pushed images."
1108
1195
  },
1109
1196
  "immutable": true,
1110
1197
  "locationInModule": {
1111
1198
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1112
- "line": 119
1199
+ "line": 112
1113
1200
  },
1114
- "name": "buildArgs",
1201
+ "name": "imageTag",
1115
1202
  "optional": true,
1116
1203
  "type": {
1117
- "collection": {
1118
- "elementtype": {
1119
- "primitive": "string"
1120
- },
1121
- "kind": "map"
1122
- }
1204
+ "primitive": "string"
1123
1205
  }
1124
1206
  },
1125
1207
  {
1126
1208
  "abstract": true,
1127
1209
  "docs": {
1128
- "default": "- no file is passed",
1129
1210
  "stability": "stable",
1130
- "summary": "Path to the Dockerfile (relative to the directory)."
1211
+ "summary": "Type of asset."
1131
1212
  },
1132
1213
  "immutable": true,
1133
1214
  "locationInModule": {
1134
1215
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1135
- "line": 133
1216
+ "line": 81
1136
1217
  },
1137
- "name": "file",
1138
- "optional": true,
1218
+ "name": "packaging",
1139
1219
  "type": {
1140
1220
  "primitive": "string"
1141
1221
  }
@@ -1143,18 +1223,15 @@
1143
1223
  {
1144
1224
  "abstract": true,
1145
1225
  "docs": {
1146
- "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1147
- "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1148
- "stability": "deprecated",
1149
- "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."
1150
1228
  },
1151
1229
  "immutable": true,
1152
1230
  "locationInModule": {
1153
1231
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1154
- "line": 93
1232
+ "line": 23
1155
1233
  },
1156
- "name": "imageNameParameter",
1157
- "optional": true,
1234
+ "name": "path",
1158
1235
  "type": {
1159
1236
  "primitive": "string"
1160
1237
  }
@@ -1163,16 +1240,16 @@
1163
1240
  "abstract": true,
1164
1241
  "docs": {
1165
1242
  "default": "- this parameter is REQUIRED after 1.21.0",
1166
- "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.",
1167
1244
  "stability": "stable",
1168
- "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."
1169
1246
  },
1170
1247
  "immutable": true,
1171
1248
  "locationInModule": {
1172
1249
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1173
- "line": 112
1250
+ "line": 103
1174
1251
  },
1175
- "name": "imageTag",
1252
+ "name": "repositoryName",
1176
1253
  "optional": true,
1177
1254
  "type": {
1178
1255
  "primitive": "string"
@@ -1181,18 +1258,15 @@
1181
1258
  {
1182
1259
  "abstract": true,
1183
1260
  "docs": {
1184
- "default": "- this parameter is REQUIRED after 1.21.0",
1185
- "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.",
1186
1261
  "stability": "stable",
1187
- "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."
1188
1263
  },
1189
1264
  "immutable": true,
1190
1265
  "locationInModule": {
1191
1266
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1192
- "line": 103
1267
+ "line": 18
1193
1268
  },
1194
- "name": "repositoryName",
1195
- "optional": true,
1269
+ "name": "sourceHash",
1196
1270
  "type": {
1197
1271
  "primitive": "string"
1198
1272
  }
@@ -1215,7 +1289,8 @@
1215
1289
  "primitive": "string"
1216
1290
  }
1217
1291
  }
1218
- ]
1292
+ ],
1293
+ "symbolId": "lib/cloud-assembly/metadata-schema:ContainerImageAssetMetadataEntry"
1219
1294
  },
1220
1295
  "@aws-cdk/cloud-assembly-schema.ContextProvider": {
1221
1296
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1247,30 +1322,30 @@
1247
1322
  {
1248
1323
  "docs": {
1249
1324
  "stability": "stable",
1250
- "summary": "Route53 Hosted Zone provider."
1325
+ "summary": "VPC Endpoint Service AZ Provider."
1251
1326
  },
1252
- "name": "HOSTED_ZONE_PROVIDER"
1327
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1253
1328
  },
1254
1329
  {
1255
1330
  "docs": {
1256
1331
  "stability": "stable",
1257
- "summary": "SSM Parameter Provider."
1332
+ "summary": "Route53 Hosted Zone provider."
1258
1333
  },
1259
- "name": "SSM_PARAMETER_PROVIDER"
1334
+ "name": "HOSTED_ZONE_PROVIDER"
1260
1335
  },
1261
1336
  {
1262
1337
  "docs": {
1263
1338
  "stability": "stable",
1264
- "summary": "VPC Provider."
1339
+ "summary": "KMS Key Provider."
1265
1340
  },
1266
- "name": "VPC_PROVIDER"
1341
+ "name": "KEY_PROVIDER"
1267
1342
  },
1268
1343
  {
1269
1344
  "docs": {
1270
1345
  "stability": "stable",
1271
- "summary": "VPC Endpoint Service AZ Provider."
1346
+ "summary": "Load balancer listener provider."
1272
1347
  },
1273
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1348
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1274
1349
  },
1275
1350
  {
1276
1351
  "docs": {
@@ -1282,26 +1357,35 @@
1282
1357
  {
1283
1358
  "docs": {
1284
1359
  "stability": "stable",
1285
- "summary": "Load balancer listener provider."
1360
+ "summary": "Security group provider."
1286
1361
  },
1287
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1362
+ "name": "SECURITY_GROUP_PROVIDER"
1288
1363
  },
1289
1364
  {
1290
1365
  "docs": {
1291
1366
  "stability": "stable",
1292
- "summary": "Security group provider."
1367
+ "summary": "SSM Parameter Provider."
1293
1368
  },
1294
- "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"
1295
1377
  }
1296
1378
  ],
1297
- "name": "ContextProvider"
1379
+ "name": "ContextProvider",
1380
+ "symbolId": "lib/cloud-assembly/context-queries:ContextProvider"
1298
1381
  },
1299
1382
  "@aws-cdk/cloud-assembly-schema.DockerImageAsset": {
1300
1383
  "assembly": "@aws-cdk/cloud-assembly-schema",
1301
1384
  "datatype": true,
1302
1385
  "docs": {
1303
1386
  "stability": "stable",
1304
- "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};"
1305
1389
  },
1306
1390
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1307
1391
  "kind": "interface",
@@ -1348,14 +1432,16 @@
1348
1432
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource"
1349
1433
  }
1350
1434
  }
1351
- ]
1435
+ ],
1436
+ "symbolId": "lib/assets/docker-image-asset:DockerImageAsset"
1352
1437
  },
1353
1438
  "@aws-cdk/cloud-assembly-schema.DockerImageDestination": {
1354
1439
  "assembly": "@aws-cdk/cloud-assembly-schema",
1355
1440
  "datatype": true,
1356
1441
  "docs": {
1357
1442
  "stability": "stable",
1358
- "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};"
1359
1445
  },
1360
1446
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1361
1447
  "interfaces": [
@@ -1400,14 +1486,16 @@
1400
1486
  "primitive": "string"
1401
1487
  }
1402
1488
  }
1403
- ]
1489
+ ],
1490
+ "symbolId": "lib/assets/docker-image-asset:DockerImageDestination"
1404
1491
  },
1405
1492
  "@aws-cdk/cloud-assembly-schema.DockerImageSource": {
1406
1493
  "assembly": "@aws-cdk/cloud-assembly-schema",
1407
1494
  "datatype": true,
1408
1495
  "docs": {
1409
1496
  "stability": "stable",
1410
- "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};"
1411
1499
  },
1412
1500
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1413
1501
  "kind": "interface",
@@ -1521,20 +1609,22 @@
1521
1609
  }
1522
1610
  }
1523
1611
  }
1524
- ]
1612
+ ],
1613
+ "symbolId": "lib/assets/docker-image-asset:DockerImageSource"
1525
1614
  },
1526
1615
  "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery": {
1527
1616
  "assembly": "@aws-cdk/cloud-assembly-schema",
1528
1617
  "datatype": true,
1529
1618
  "docs": {
1530
1619
  "stability": "stable",
1531
- "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};"
1532
1622
  },
1533
1623
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1534
1624
  "kind": "interface",
1535
1625
  "locationInModule": {
1536
1626
  "filename": "lib/cloud-assembly/context-queries.ts",
1537
- "line": 197
1627
+ "line": 238
1538
1628
  },
1539
1629
  "name": "EndpointServiceAvailabilityZonesContextQuery",
1540
1630
  "properties": [
@@ -1547,13 +1637,31 @@
1547
1637
  "immutable": true,
1548
1638
  "locationInModule": {
1549
1639
  "filename": "lib/cloud-assembly/context-queries.ts",
1550
- "line": 201
1640
+ "line": 242
1551
1641
  },
1552
1642
  "name": "account",
1553
1643
  "type": {
1554
1644
  "primitive": "string"
1555
1645
  }
1556
1646
  },
1647
+ {
1648
+ "abstract": true,
1649
+ "docs": {
1650
+ "default": "- None",
1651
+ "stability": "stable",
1652
+ "summary": "The ARN of the role that should be used to look up the missing values."
1653
+ },
1654
+ "immutable": true,
1655
+ "locationInModule": {
1656
+ "filename": "lib/cloud-assembly/context-queries.ts",
1657
+ "line": 254
1658
+ },
1659
+ "name": "lookupRoleArn",
1660
+ "optional": true,
1661
+ "type": {
1662
+ "primitive": "string"
1663
+ }
1664
+ },
1557
1665
  {
1558
1666
  "abstract": true,
1559
1667
  "docs": {
@@ -1563,7 +1671,7 @@
1563
1671
  "immutable": true,
1564
1672
  "locationInModule": {
1565
1673
  "filename": "lib/cloud-assembly/context-queries.ts",
1566
- "line": 206
1674
+ "line": 247
1567
1675
  },
1568
1676
  "name": "region",
1569
1677
  "type": {
@@ -1579,21 +1687,23 @@
1579
1687
  "immutable": true,
1580
1688
  "locationInModule": {
1581
1689
  "filename": "lib/cloud-assembly/context-queries.ts",
1582
- "line": 211
1690
+ "line": 259
1583
1691
  },
1584
1692
  "name": "serviceName",
1585
1693
  "type": {
1586
1694
  "primitive": "string"
1587
1695
  }
1588
1696
  }
1589
- ]
1697
+ ],
1698
+ "symbolId": "lib/cloud-assembly/context-queries:EndpointServiceAvailabilityZonesContextQuery"
1590
1699
  },
1591
1700
  "@aws-cdk/cloud-assembly-schema.FileAsset": {
1592
1701
  "assembly": "@aws-cdk/cloud-assembly-schema",
1593
1702
  "datatype": true,
1594
1703
  "docs": {
1595
1704
  "stability": "stable",
1596
- "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};"
1597
1707
  },
1598
1708
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1599
1709
  "kind": "interface",
@@ -1640,14 +1750,16 @@
1640
1750
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource"
1641
1751
  }
1642
1752
  }
1643
- ]
1753
+ ],
1754
+ "symbolId": "lib/assets/file-asset:FileAsset"
1644
1755
  },
1645
1756
  "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry": {
1646
1757
  "assembly": "@aws-cdk/cloud-assembly-schema",
1647
1758
  "datatype": true,
1648
1759
  "docs": {
1649
1760
  "stability": "stable",
1650
- "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};"
1651
1763
  },
1652
1764
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1653
1765
  "kind": "interface",
@@ -1769,7 +1881,8 @@
1769
1881
  "primitive": "string"
1770
1882
  }
1771
1883
  }
1772
- ]
1884
+ ],
1885
+ "symbolId": "lib/cloud-assembly/metadata-schema:FileAssetMetadataEntry"
1773
1886
  },
1774
1887
  "@aws-cdk/cloud-assembly-schema.FileAssetPackaging": {
1775
1888
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -1799,14 +1912,16 @@
1799
1912
  "name": "ZIP_DIRECTORY"
1800
1913
  }
1801
1914
  ],
1802
- "name": "FileAssetPackaging"
1915
+ "name": "FileAssetPackaging",
1916
+ "symbolId": "lib/assets/file-asset:FileAssetPackaging"
1803
1917
  },
1804
1918
  "@aws-cdk/cloud-assembly-schema.FileDestination": {
1805
1919
  "assembly": "@aws-cdk/cloud-assembly-schema",
1806
1920
  "datatype": true,
1807
1921
  "docs": {
1808
1922
  "stability": "stable",
1809
- "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};"
1810
1925
  },
1811
1926
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1812
1927
  "interfaces": [
@@ -1851,14 +1966,16 @@
1851
1966
  "primitive": "string"
1852
1967
  }
1853
1968
  }
1854
- ]
1969
+ ],
1970
+ "symbolId": "lib/assets/file-asset:FileDestination"
1855
1971
  },
1856
1972
  "@aws-cdk/cloud-assembly-schema.FileSource": {
1857
1973
  "assembly": "@aws-cdk/cloud-assembly-schema",
1858
1974
  "datatype": true,
1859
1975
  "docs": {
1860
1976
  "stability": "stable",
1861
- "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};"
1862
1979
  },
1863
1980
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1864
1981
  "kind": "interface",
@@ -1929,20 +2046,22 @@
1929
2046
  "primitive": "string"
1930
2047
  }
1931
2048
  }
1932
- ]
2049
+ ],
2050
+ "symbolId": "lib/assets/file-asset:FileSource"
1933
2051
  },
1934
2052
  "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery": {
1935
2053
  "assembly": "@aws-cdk/cloud-assembly-schema",
1936
2054
  "datatype": true,
1937
2055
  "docs": {
1938
2056
  "stability": "stable",
1939
- "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};"
1940
2059
  },
1941
2060
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
1942
2061
  "kind": "interface",
1943
2062
  "locationInModule": {
1944
2063
  "filename": "lib/cloud-assembly/context-queries.ts",
1945
- "line": 98
2064
+ "line": 118
1946
2065
  },
1947
2066
  "name": "HostedZoneContextQuery",
1948
2067
  "properties": [
@@ -1955,7 +2074,7 @@
1955
2074
  "immutable": true,
1956
2075
  "locationInModule": {
1957
2076
  "filename": "lib/cloud-assembly/context-queries.ts",
1958
- "line": 102
2077
+ "line": 122
1959
2078
  },
1960
2079
  "name": "account",
1961
2080
  "type": {
@@ -1966,14 +2085,120 @@
1966
2085
  "abstract": true,
1967
2086
  "docs": {
1968
2087
  "stability": "stable",
1969
- "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."
1970
2195
  },
1971
2196
  "immutable": true,
1972
2197
  "locationInModule": {
1973
2198
  "filename": "lib/cloud-assembly/context-queries.ts",
1974
- "line": 112
2199
+ "line": 446
1975
2200
  },
1976
- "name": "domainName",
2201
+ "name": "account",
1977
2202
  "type": {
1978
2203
  "primitive": "string"
1979
2204
  }
@@ -1982,14 +2207,14 @@
1982
2207
  "abstract": true,
1983
2208
  "docs": {
1984
2209
  "stability": "stable",
1985
- "summary": "Query region."
2210
+ "summary": "Alias name used to search the Key."
1986
2211
  },
1987
2212
  "immutable": true,
1988
2213
  "locationInModule": {
1989
2214
  "filename": "lib/cloud-assembly/context-queries.ts",
1990
- "line": 107
2215
+ "line": 463
1991
2216
  },
1992
- "name": "region",
2217
+ "name": "aliasName",
1993
2218
  "type": {
1994
2219
  "primitive": "string"
1995
2220
  }
@@ -1997,48 +2222,47 @@
1997
2222
  {
1998
2223
  "abstract": true,
1999
2224
  "docs": {
2000
- "default": "false",
2225
+ "default": "- None",
2001
2226
  "stability": "stable",
2002
- "summary": "True if the zone you want to find is a private hosted zone."
2227
+ "summary": "The ARN of the role that should be used to look up the missing values."
2003
2228
  },
2004
2229
  "immutable": true,
2005
2230
  "locationInModule": {
2006
2231
  "filename": "lib/cloud-assembly/context-queries.ts",
2007
- "line": 119
2232
+ "line": 458
2008
2233
  },
2009
- "name": "privateZone",
2234
+ "name": "lookupRoleArn",
2010
2235
  "optional": true,
2011
2236
  "type": {
2012
- "primitive": "boolean"
2237
+ "primitive": "string"
2013
2238
  }
2014
2239
  },
2015
2240
  {
2016
2241
  "abstract": true,
2017
2242
  "docs": {
2018
- "default": "- Required if privateZone=true",
2019
- "remarks": "If you provide VPC ID and privateZone is false, this will return no results\nand raise an error.",
2020
2243
  "stability": "stable",
2021
- "summary": "The VPC ID to that the private zone must be associated with."
2244
+ "summary": "Query region."
2022
2245
  },
2023
2246
  "immutable": true,
2024
2247
  "locationInModule": {
2025
2248
  "filename": "lib/cloud-assembly/context-queries.ts",
2026
- "line": 129
2249
+ "line": 451
2027
2250
  },
2028
- "name": "vpcId",
2029
- "optional": true,
2251
+ "name": "region",
2030
2252
  "type": {
2031
2253
  "primitive": "string"
2032
2254
  }
2033
2255
  }
2034
- ]
2256
+ ],
2257
+ "symbolId": "lib/cloud-assembly/context-queries:KeyContextQuery"
2035
2258
  },
2036
2259
  "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery": {
2037
2260
  "assembly": "@aws-cdk/cloud-assembly-schema",
2038
2261
  "datatype": true,
2039
2262
  "docs": {
2040
2263
  "stability": "stable",
2041
- "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};"
2042
2266
  },
2043
2267
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2044
2268
  "interfaces": [
@@ -2047,7 +2271,7 @@
2047
2271
  "kind": "interface",
2048
2272
  "locationInModule": {
2049
2273
  "filename": "lib/cloud-assembly/context-queries.ts",
2050
- "line": 254
2274
+ "line": 302
2051
2275
  },
2052
2276
  "name": "LoadBalancerContextQuery",
2053
2277
  "properties": [
@@ -2060,13 +2284,31 @@
2060
2284
  "immutable": true,
2061
2285
  "locationInModule": {
2062
2286
  "filename": "lib/cloud-assembly/context-queries.ts",
2063
- "line": 258
2287
+ "line": 306
2064
2288
  },
2065
2289
  "name": "account",
2066
2290
  "type": {
2067
2291
  "primitive": "string"
2068
2292
  }
2069
2293
  },
2294
+ {
2295
+ "abstract": true,
2296
+ "docs": {
2297
+ "default": "- None",
2298
+ "stability": "stable",
2299
+ "summary": "The ARN of the role that should be used to look up the missing values."
2300
+ },
2301
+ "immutable": true,
2302
+ "locationInModule": {
2303
+ "filename": "lib/cloud-assembly/context-queries.ts",
2304
+ "line": 318
2305
+ },
2306
+ "name": "lookupRoleArn",
2307
+ "optional": true,
2308
+ "type": {
2309
+ "primitive": "string"
2310
+ }
2311
+ },
2070
2312
  {
2071
2313
  "abstract": true,
2072
2314
  "docs": {
@@ -2076,46 +2318,32 @@
2076
2318
  "immutable": true,
2077
2319
  "locationInModule": {
2078
2320
  "filename": "lib/cloud-assembly/context-queries.ts",
2079
- "line": 263
2321
+ "line": 311
2080
2322
  },
2081
2323
  "name": "region",
2082
2324
  "type": {
2083
2325
  "primitive": "string"
2084
2326
  }
2085
2327
  }
2086
- ]
2328
+ ],
2329
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerContextQuery"
2087
2330
  },
2088
2331
  "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter": {
2089
2332
  "assembly": "@aws-cdk/cloud-assembly-schema",
2090
2333
  "datatype": true,
2091
2334
  "docs": {
2092
2335
  "stability": "stable",
2093
- "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};"
2094
2338
  },
2095
2339
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2096
2340
  "kind": "interface",
2097
2341
  "locationInModule": {
2098
2342
  "filename": "lib/cloud-assembly/context-queries.ts",
2099
- "line": 232
2343
+ "line": 280
2100
2344
  },
2101
2345
  "name": "LoadBalancerFilter",
2102
2346
  "properties": [
2103
- {
2104
- "abstract": true,
2105
- "docs": {
2106
- "stability": "stable",
2107
- "summary": "Filter load balancers by their type."
2108
- },
2109
- "immutable": true,
2110
- "locationInModule": {
2111
- "filename": "lib/cloud-assembly/context-queries.ts",
2112
- "line": 236
2113
- },
2114
- "name": "loadBalancerType",
2115
- "type": {
2116
- "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2117
- }
2118
- },
2119
2347
  {
2120
2348
  "abstract": true,
2121
2349
  "docs": {
@@ -2126,7 +2354,7 @@
2126
2354
  "immutable": true,
2127
2355
  "locationInModule": {
2128
2356
  "filename": "lib/cloud-assembly/context-queries.ts",
2129
- "line": 242
2357
+ "line": 290
2130
2358
  },
2131
2359
  "name": "loadBalancerArn",
2132
2360
  "optional": true,
@@ -2144,7 +2372,7 @@
2144
2372
  "immutable": true,
2145
2373
  "locationInModule": {
2146
2374
  "filename": "lib/cloud-assembly/context-queries.ts",
2147
- "line": 248
2375
+ "line": 296
2148
2376
  },
2149
2377
  "name": "loadBalancerTags",
2150
2378
  "optional": true,
@@ -2156,15 +2384,33 @@
2156
2384
  "kind": "array"
2157
2385
  }
2158
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
+ }
2159
2403
  }
2160
- ]
2404
+ ],
2405
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
2161
2406
  },
2162
2407
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery": {
2163
2408
  "assembly": "@aws-cdk/cloud-assembly-schema",
2164
2409
  "datatype": true,
2165
2410
  "docs": {
2166
2411
  "stability": "stable",
2167
- "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};"
2168
2414
  },
2169
2415
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2170
2416
  "interfaces": [
@@ -2173,7 +2419,7 @@
2173
2419
  "kind": "interface",
2174
2420
  "locationInModule": {
2175
2421
  "filename": "lib/cloud-assembly/context-queries.ts",
2176
- "line": 304
2422
+ "line": 359
2177
2423
  },
2178
2424
  "name": "LoadBalancerListenerContextQuery",
2179
2425
  "properties": [
@@ -2186,7 +2432,7 @@
2186
2432
  "immutable": true,
2187
2433
  "locationInModule": {
2188
2434
  "filename": "lib/cloud-assembly/context-queries.ts",
2189
- "line": 308
2435
+ "line": 363
2190
2436
  },
2191
2437
  "name": "account",
2192
2438
  "type": {
@@ -2196,15 +2442,17 @@
2196
2442
  {
2197
2443
  "abstract": true,
2198
2444
  "docs": {
2445
+ "default": "- does not find by listener arn",
2199
2446
  "stability": "stable",
2200
- "summary": "Query region."
2447
+ "summary": "Find by listener's arn."
2201
2448
  },
2202
2449
  "immutable": true,
2203
2450
  "locationInModule": {
2204
2451
  "filename": "lib/cloud-assembly/context-queries.ts",
2205
- "line": 313
2452
+ "line": 381
2206
2453
  },
2207
- "name": "region",
2454
+ "name": "listenerArn",
2455
+ "optional": true,
2208
2456
  "type": {
2209
2457
  "primitive": "string"
2210
2458
  }
@@ -2212,58 +2460,75 @@
2212
2460
  {
2213
2461
  "abstract": true,
2214
2462
  "docs": {
2215
- "default": "- does not find by listener arn",
2463
+ "default": "- does not filter by a listener port",
2216
2464
  "stability": "stable",
2217
- "summary": "Find by listener's arn."
2465
+ "summary": "Filter listeners by listener port."
2218
2466
  },
2219
2467
  "immutable": true,
2220
2468
  "locationInModule": {
2221
2469
  "filename": "lib/cloud-assembly/context-queries.ts",
2222
- "line": 319
2470
+ "line": 393
2223
2471
  },
2224
- "name": "listenerArn",
2472
+ "name": "listenerPort",
2225
2473
  "optional": true,
2226
2474
  "type": {
2227
- "primitive": "string"
2475
+ "primitive": "number"
2228
2476
  }
2229
2477
  },
2230
2478
  {
2231
2479
  "abstract": true,
2232
2480
  "docs": {
2233
- "default": "- does not filter by a listener port",
2481
+ "default": "- does not filter by listener protocol",
2234
2482
  "stability": "stable",
2235
- "summary": "Filter listeners by listener port."
2483
+ "summary": "Filter by listener protocol."
2236
2484
  },
2237
2485
  "immutable": true,
2238
2486
  "locationInModule": {
2239
2487
  "filename": "lib/cloud-assembly/context-queries.ts",
2240
- "line": 331
2488
+ "line": 387
2241
2489
  },
2242
- "name": "listenerPort",
2490
+ "name": "listenerProtocol",
2243
2491
  "optional": true,
2244
2492
  "type": {
2245
- "primitive": "number"
2493
+ "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerProtocol"
2246
2494
  }
2247
2495
  },
2248
2496
  {
2249
2497
  "abstract": true,
2250
2498
  "docs": {
2251
- "default": "- does not filter by listener protocol",
2499
+ "default": "- None",
2252
2500
  "stability": "stable",
2253
- "summary": "Filter by listener protocol."
2501
+ "summary": "The ARN of the role that should be used to look up the missing values."
2254
2502
  },
2255
2503
  "immutable": true,
2256
2504
  "locationInModule": {
2257
2505
  "filename": "lib/cloud-assembly/context-queries.ts",
2258
- "line": 325
2506
+ "line": 375
2259
2507
  },
2260
- "name": "listenerProtocol",
2508
+ "name": "lookupRoleArn",
2261
2509
  "optional": true,
2262
2510
  "type": {
2263
- "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerProtocol"
2511
+ "primitive": "string"
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"
2264
2528
  }
2265
2529
  }
2266
- ]
2530
+ ],
2531
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
2267
2532
  },
2268
2533
  "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerProtocol": {
2269
2534
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2275,7 +2540,7 @@
2275
2540
  "kind": "enum",
2276
2541
  "locationInModule": {
2277
2542
  "filename": "lib/cloud-assembly/context-queries.ts",
2278
- "line": 269
2543
+ "line": 324
2279
2544
  },
2280
2545
  "members": [
2281
2546
  {
@@ -2302,26 +2567,27 @@
2302
2567
  {
2303
2568
  "docs": {
2304
2569
  "stability": "stable",
2305
- "summary": "TLS protocol."
2570
+ "summary": "TCP and UDP protocol."
2306
2571
  },
2307
- "name": "TLS"
2572
+ "name": "TCP_UDP"
2308
2573
  },
2309
2574
  {
2310
2575
  "docs": {
2311
2576
  "stability": "stable",
2312
- "summary": "UDP protocol."
2577
+ "summary": "TLS protocol."
2313
2578
  },
2314
- "name": "UDP"
2579
+ "name": "TLS"
2315
2580
  },
2316
2581
  {
2317
2582
  "docs": {
2318
2583
  "stability": "stable",
2319
- "summary": "TCP and UDP protocol."
2584
+ "summary": "UDP protocol."
2320
2585
  },
2321
- "name": "TCP_UDP"
2586
+ "name": "UDP"
2322
2587
  }
2323
2588
  ],
2324
- "name": "LoadBalancerListenerProtocol"
2589
+ "name": "LoadBalancerListenerProtocol",
2590
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerProtocol"
2325
2591
  },
2326
2592
  "@aws-cdk/cloud-assembly-schema.LoadBalancerType": {
2327
2593
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2333,25 +2599,26 @@
2333
2599
  "kind": "enum",
2334
2600
  "locationInModule": {
2335
2601
  "filename": "lib/cloud-assembly/context-queries.ts",
2336
- "line": 217
2602
+ "line": 265
2337
2603
  },
2338
2604
  "members": [
2339
2605
  {
2340
2606
  "docs": {
2341
2607
  "stability": "stable",
2342
- "summary": "Network load balancer."
2608
+ "summary": "Application load balancer."
2343
2609
  },
2344
- "name": "NETWORK"
2610
+ "name": "APPLICATION"
2345
2611
  },
2346
2612
  {
2347
2613
  "docs": {
2348
2614
  "stability": "stable",
2349
- "summary": "Application load balancer."
2615
+ "summary": "Network load balancer."
2350
2616
  },
2351
- "name": "APPLICATION"
2617
+ "name": "NETWORK"
2352
2618
  }
2353
2619
  ],
2354
- "name": "LoadBalancerType"
2620
+ "name": "LoadBalancerType",
2621
+ "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerType"
2355
2622
  },
2356
2623
  "@aws-cdk/cloud-assembly-schema.Manifest": {
2357
2624
  "assembly": "@aws-cdk/cloud-assembly-schema",
@@ -2557,14 +2824,16 @@
2557
2824
  "static": true
2558
2825
  }
2559
2826
  ],
2560
- "name": "Manifest"
2827
+ "name": "Manifest",
2828
+ "symbolId": "lib/manifest:Manifest"
2561
2829
  },
2562
2830
  "@aws-cdk/cloud-assembly-schema.MetadataEntry": {
2563
2831
  "assembly": "@aws-cdk/cloud-assembly-schema",
2564
2832
  "datatype": true,
2565
2833
  "docs": {
2566
2834
  "stability": "stable",
2567
- "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};"
2568
2837
  },
2569
2838
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2570
2839
  "kind": "interface",
@@ -2574,22 +2843,6 @@
2574
2843
  },
2575
2844
  "name": "MetadataEntry",
2576
2845
  "properties": [
2577
- {
2578
- "abstract": true,
2579
- "docs": {
2580
- "stability": "stable",
2581
- "summary": "The type of the metadata entry."
2582
- },
2583
- "immutable": true,
2584
- "locationInModule": {
2585
- "filename": "lib/cloud-assembly/metadata-schema.ts",
2586
- "line": 208
2587
- },
2588
- "name": "type",
2589
- "type": {
2590
- "primitive": "string"
2591
- }
2592
- },
2593
2846
  {
2594
2847
  "abstract": true,
2595
2848
  "docs": {
@@ -2650,15 +2903,33 @@
2650
2903
  "kind": "array"
2651
2904
  }
2652
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
+ }
2653
2922
  }
2654
- ]
2923
+ ],
2924
+ "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
2655
2925
  },
2656
2926
  "@aws-cdk/cloud-assembly-schema.MissingContext": {
2657
2927
  "assembly": "@aws-cdk/cloud-assembly-schema",
2658
2928
  "datatype": true,
2659
2929
  "docs": {
2660
2930
  "stability": "stable",
2661
- "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};"
2662
2933
  },
2663
2934
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2664
2935
  "kind": "interface",
@@ -2725,6 +2996,9 @@
2725
2996
  },
2726
2997
  {
2727
2998
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery"
2999
+ },
3000
+ {
3001
+ "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery"
2728
3002
  }
2729
3003
  ]
2730
3004
  }
@@ -2746,20 +3020,22 @@
2746
3020
  "fqn": "@aws-cdk/cloud-assembly-schema.ContextProvider"
2747
3021
  }
2748
3022
  }
2749
- ]
3023
+ ],
3024
+ "symbolId": "lib/cloud-assembly/schema:MissingContext"
2750
3025
  },
2751
3026
  "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties": {
2752
3027
  "assembly": "@aws-cdk/cloud-assembly-schema",
2753
3028
  "datatype": true,
2754
3029
  "docs": {
2755
3030
  "stability": "stable",
2756
- "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};"
2757
3033
  },
2758
3034
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
2759
3035
  "kind": "interface",
2760
3036
  "locationInModule": {
2761
3037
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2762
- "line": 132
3038
+ "line": 139
2763
3039
  },
2764
3040
  "name": "NestedCloudAssemblyProperties",
2765
3041
  "properties": [
@@ -2772,7 +3048,7 @@
2772
3048
  "immutable": true,
2773
3049
  "locationInModule": {
2774
3050
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2775
- "line": 136
3051
+ "line": 143
2776
3052
  },
2777
3053
  "name": "directoryName",
2778
3054
  "type": {
@@ -2789,7 +3065,7 @@
2789
3065
  "immutable": true,
2790
3066
  "locationInModule": {
2791
3067
  "filename": "lib/cloud-assembly/artifact-schema.ts",
2792
- "line": 143
3068
+ "line": 150
2793
3069
  },
2794
3070
  "name": "displayName",
2795
3071
  "optional": true,
@@ -2797,14 +3073,16 @@
2797
3073
  "primitive": "string"
2798
3074
  }
2799
3075
  }
2800
- ]
3076
+ ],
3077
+ "symbolId": "lib/cloud-assembly/artifact-schema:NestedCloudAssemblyProperties"
2801
3078
  },
2802
3079
  "@aws-cdk/cloud-assembly-schema.RuntimeInfo": {
2803
3080
  "assembly": "@aws-cdk/cloud-assembly-schema",
2804
3081
  "datatype": true,
2805
3082
  "docs": {
2806
3083
  "stability": "stable",
2807
- "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};"
2808
3086
  },
2809
3087
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
2810
3088
  "kind": "interface",
@@ -2835,20 +3113,22 @@
2835
3113
  }
2836
3114
  }
2837
3115
  }
2838
- ]
3116
+ ],
3117
+ "symbolId": "lib/cloud-assembly/schema:RuntimeInfo"
2839
3118
  },
2840
3119
  "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery": {
2841
3120
  "assembly": "@aws-cdk/cloud-assembly-schema",
2842
3121
  "datatype": true,
2843
3122
  "docs": {
2844
3123
  "stability": "stable",
2845
- "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};"
2846
3126
  },
2847
3127
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
2848
3128
  "kind": "interface",
2849
3129
  "locationInModule": {
2850
3130
  "filename": "lib/cloud-assembly/context-queries.ts",
2851
- "line": 135
3131
+ "line": 162
2852
3132
  },
2853
3133
  "name": "SSMParameterContextQuery",
2854
3134
  "properties": [
@@ -2861,13 +3141,31 @@
2861
3141
  "immutable": true,
2862
3142
  "locationInModule": {
2863
3143
  "filename": "lib/cloud-assembly/context-queries.ts",
2864
- "line": 139
3144
+ "line": 166
2865
3145
  },
2866
3146
  "name": "account",
2867
3147
  "type": {
2868
3148
  "primitive": "string"
2869
3149
  }
2870
3150
  },
3151
+ {
3152
+ "abstract": true,
3153
+ "docs": {
3154
+ "default": "- None",
3155
+ "stability": "stable",
3156
+ "summary": "The ARN of the role that should be used to look up the missing values."
3157
+ },
3158
+ "immutable": true,
3159
+ "locationInModule": {
3160
+ "filename": "lib/cloud-assembly/context-queries.ts",
3161
+ "line": 178
3162
+ },
3163
+ "name": "lookupRoleArn",
3164
+ "optional": true,
3165
+ "type": {
3166
+ "primitive": "string"
3167
+ }
3168
+ },
2871
3169
  {
2872
3170
  "abstract": true,
2873
3171
  "docs": {
@@ -2877,7 +3175,7 @@
2877
3175
  "immutable": true,
2878
3176
  "locationInModule": {
2879
3177
  "filename": "lib/cloud-assembly/context-queries.ts",
2880
- "line": 149
3178
+ "line": 183
2881
3179
  },
2882
3180
  "name": "parameterName",
2883
3181
  "type": {
@@ -2893,27 +3191,29 @@
2893
3191
  "immutable": true,
2894
3192
  "locationInModule": {
2895
3193
  "filename": "lib/cloud-assembly/context-queries.ts",
2896
- "line": 144
3194
+ "line": 171
2897
3195
  },
2898
3196
  "name": "region",
2899
3197
  "type": {
2900
3198
  "primitive": "string"
2901
3199
  }
2902
3200
  }
2903
- ]
3201
+ ],
3202
+ "symbolId": "lib/cloud-assembly/context-queries:SSMParameterContextQuery"
2904
3203
  },
2905
3204
  "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery": {
2906
3205
  "assembly": "@aws-cdk/cloud-assembly-schema",
2907
3206
  "datatype": true,
2908
3207
  "docs": {
2909
3208
  "stability": "stable",
2910
- "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};"
2911
3211
  },
2912
3212
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
2913
3213
  "kind": "interface",
2914
3214
  "locationInModule": {
2915
3215
  "filename": "lib/cloud-assembly/context-queries.ts",
2916
- "line": 337
3216
+ "line": 399
2917
3217
  },
2918
3218
  "name": "SecurityGroupContextQuery",
2919
3219
  "properties": [
@@ -2926,13 +3226,31 @@
2926
3226
  "immutable": true,
2927
3227
  "locationInModule": {
2928
3228
  "filename": "lib/cloud-assembly/context-queries.ts",
2929
- "line": 341
3229
+ "line": 403
2930
3230
  },
2931
3231
  "name": "account",
2932
3232
  "type": {
2933
3233
  "primitive": "string"
2934
3234
  }
2935
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
+ },
2936
3254
  {
2937
3255
  "abstract": true,
2938
3256
  "docs": {
@@ -2942,7 +3260,7 @@
2942
3260
  "immutable": true,
2943
3261
  "locationInModule": {
2944
3262
  "filename": "lib/cloud-assembly/context-queries.ts",
2945
- "line": 346
3263
+ "line": 408
2946
3264
  },
2947
3265
  "name": "region",
2948
3266
  "type": {
@@ -2952,27 +3270,67 @@
2952
3270
  {
2953
3271
  "abstract": true,
2954
3272
  "docs": {
3273
+ "default": "- None",
2955
3274
  "stability": "stable",
2956
3275
  "summary": "Security group id."
2957
3276
  },
2958
3277
  "immutable": true,
2959
3278
  "locationInModule": {
2960
3279
  "filename": "lib/cloud-assembly/context-queries.ts",
2961
- "line": 351
3280
+ "line": 422
2962
3281
  },
2963
3282
  "name": "securityGroupId",
3283
+ "optional": true,
3284
+ "type": {
3285
+ "primitive": "string"
3286
+ }
3287
+ },
3288
+ {
3289
+ "abstract": true,
3290
+ "docs": {
3291
+ "default": "- None",
3292
+ "stability": "stable",
3293
+ "summary": "Security group name."
3294
+ },
3295
+ "immutable": true,
3296
+ "locationInModule": {
3297
+ "filename": "lib/cloud-assembly/context-queries.ts",
3298
+ "line": 429
3299
+ },
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",
3319
+ "optional": true,
2964
3320
  "type": {
2965
3321
  "primitive": "string"
2966
3322
  }
2967
3323
  }
2968
- ]
3324
+ ],
3325
+ "symbolId": "lib/cloud-assembly/context-queries:SecurityGroupContextQuery"
2969
3326
  },
2970
3327
  "@aws-cdk/cloud-assembly-schema.Tag": {
2971
3328
  "assembly": "@aws-cdk/cloud-assembly-schema",
2972
3329
  "datatype": true,
2973
3330
  "docs": {
2974
3331
  "stability": "stable",
2975
- "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};"
2976
3334
  },
2977
3335
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
2978
3336
  "kind": "interface",
@@ -3016,20 +3374,22 @@
3016
3374
  "primitive": "string"
3017
3375
  }
3018
3376
  }
3019
- ]
3377
+ ],
3378
+ "symbolId": "lib/cloud-assembly/metadata-schema:Tag"
3020
3379
  },
3021
3380
  "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties": {
3022
3381
  "assembly": "@aws-cdk/cloud-assembly-schema",
3023
3382
  "datatype": true,
3024
3383
  "docs": {
3025
3384
  "stability": "stable",
3026
- "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};"
3027
3387
  },
3028
3388
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3029
3389
  "kind": "interface",
3030
3390
  "locationInModule": {
3031
3391
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3032
- "line": 122
3392
+ "line": 129
3033
3393
  },
3034
3394
  "name": "TreeArtifactProperties",
3035
3395
  "properties": [
@@ -3042,27 +3402,29 @@
3042
3402
  "immutable": true,
3043
3403
  "locationInModule": {
3044
3404
  "filename": "lib/cloud-assembly/artifact-schema.ts",
3045
- "line": 126
3405
+ "line": 133
3046
3406
  },
3047
3407
  "name": "file",
3048
3408
  "type": {
3049
3409
  "primitive": "string"
3050
3410
  }
3051
3411
  }
3052
- ]
3412
+ ],
3413
+ "symbolId": "lib/cloud-assembly/artifact-schema:TreeArtifactProperties"
3053
3414
  },
3054
3415
  "@aws-cdk/cloud-assembly-schema.VpcContextQuery": {
3055
3416
  "assembly": "@aws-cdk/cloud-assembly-schema",
3056
3417
  "datatype": true,
3057
3418
  "docs": {
3058
3419
  "stability": "stable",
3059
- "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};"
3060
3422
  },
3061
3423
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3062
3424
  "kind": "interface",
3063
3425
  "locationInModule": {
3064
3426
  "filename": "lib/cloud-assembly/context-queries.ts",
3065
- "line": 155
3427
+ "line": 189
3066
3428
  },
3067
3429
  "name": "VpcContextQuery",
3068
3430
  "properties": [
@@ -3075,7 +3437,7 @@
3075
3437
  "immutable": true,
3076
3438
  "locationInModule": {
3077
3439
  "filename": "lib/cloud-assembly/context-queries.ts",
3078
- "line": 159
3440
+ "line": 193
3079
3441
  },
3080
3442
  "name": "account",
3081
3443
  "type": {
@@ -3093,7 +3455,7 @@
3093
3455
  "immutable": true,
3094
3456
  "locationInModule": {
3095
3457
  "filename": "lib/cloud-assembly/context-queries.ts",
3096
- "line": 173
3458
+ "line": 214
3097
3459
  },
3098
3460
  "name": "filter",
3099
3461
  "type": {
@@ -3105,6 +3467,24 @@
3105
3467
  }
3106
3468
  }
3107
3469
  },
3470
+ {
3471
+ "abstract": true,
3472
+ "docs": {
3473
+ "default": "- None",
3474
+ "stability": "stable",
3475
+ "summary": "The ARN of the role that should be used to look up the missing values."
3476
+ },
3477
+ "immutable": true,
3478
+ "locationInModule": {
3479
+ "filename": "lib/cloud-assembly/context-queries.ts",
3480
+ "line": 205
3481
+ },
3482
+ "name": "lookupRoleArn",
3483
+ "optional": true,
3484
+ "type": {
3485
+ "primitive": "string"
3486
+ }
3487
+ },
3108
3488
  {
3109
3489
  "abstract": true,
3110
3490
  "docs": {
@@ -3114,7 +3494,7 @@
3114
3494
  "immutable": true,
3115
3495
  "locationInModule": {
3116
3496
  "filename": "lib/cloud-assembly/context-queries.ts",
3117
- "line": 164
3497
+ "line": 198
3118
3498
  },
3119
3499
  "name": "region",
3120
3500
  "type": {
@@ -3131,7 +3511,7 @@
3131
3511
  "immutable": true,
3132
3512
  "locationInModule": {
3133
3513
  "filename": "lib/cloud-assembly/context-queries.ts",
3134
- "line": 181
3514
+ "line": 222
3135
3515
  },
3136
3516
  "name": "returnAsymmetricSubnets",
3137
3517
  "optional": true,
@@ -3150,7 +3530,7 @@
3150
3530
  "immutable": true,
3151
3531
  "locationInModule": {
3152
3532
  "filename": "lib/cloud-assembly/context-queries.ts",
3153
- "line": 191
3533
+ "line": 232
3154
3534
  },
3155
3535
  "name": "subnetGroupNameTag",
3156
3536
  "optional": true,
@@ -3158,9 +3538,10 @@
3158
3538
  "primitive": "string"
3159
3539
  }
3160
3540
  }
3161
- ]
3541
+ ],
3542
+ "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3162
3543
  }
3163
3544
  },
3164
- "version": "2.0.0-rc.6",
3165
- "fingerprint": "+TQFntDWUP4XsOPZTAUWTSpw4yFOTUPZaeNMXD2TqcU="
3545
+ "version": "2.0.0",
3546
+ "fingerprint": "**********"
3166
3547
  }