@aws-cdk/cloud-assembly-schema 2.0.0 → 2.4.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.46.0 (build cd08c55)",
19
+ "jsiiVersion": "1.50.0 (build d1830a4)",
20
20
  "keywords": [
21
21
  "aws",
22
22
  "cdk"
@@ -75,7 +75,10 @@
75
75
  "docs": {
76
76
  "stability": "stable",
77
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};"
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';\nconst amiContextQuery: cloud_assembly_schema.AmiContextQuery = {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n};",
79
+ "custom": {
80
+ "exampleMetadata": "fixture=_generated"
81
+ }
79
82
  },
80
83
  "fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
81
84
  "kind": "interface",
@@ -127,6 +130,22 @@
127
130
  }
128
131
  }
129
132
  },
133
+ {
134
+ "abstract": true,
135
+ "docs": {
136
+ "stability": "stable",
137
+ "summary": "Region to query."
138
+ },
139
+ "immutable": true,
140
+ "locationInModule": {
141
+ "filename": "lib/cloud-assembly/context-queries.ts",
142
+ "line": 70
143
+ },
144
+ "name": "region",
145
+ "type": {
146
+ "primitive": "string"
147
+ }
148
+ },
130
149
  {
131
150
  "abstract": true,
132
151
  "docs": {
@@ -167,22 +186,6 @@
167
186
  "kind": "array"
168
187
  }
169
188
  }
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
- }
186
189
  }
187
190
  ],
188
191
  "symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
@@ -193,7 +196,10 @@
193
196
  "docs": {
194
197
  "stability": "stable",
195
198
  "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};"
199
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n};",
200
+ "custom": {
201
+ "exampleMetadata": "fixture=_generated"
202
+ }
197
203
  },
198
204
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
199
205
  "kind": "interface",
@@ -203,6 +209,22 @@
203
209
  },
204
210
  "name": "ArtifactManifest",
205
211
  "properties": [
212
+ {
213
+ "abstract": true,
214
+ "docs": {
215
+ "stability": "stable",
216
+ "summary": "The type of artifact."
217
+ },
218
+ "immutable": true,
219
+ "locationInModule": {
220
+ "filename": "lib/cloud-assembly/schema.ts",
221
+ "line": 72
222
+ },
223
+ "name": "type",
224
+ "type": {
225
+ "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
226
+ }
227
+ },
206
228
  {
207
229
  "abstract": true,
208
230
  "docs": {
@@ -323,22 +345,6 @@
323
345
  ]
324
346
  }
325
347
  }
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
- }
342
348
  }
343
349
  ],
344
350
  "symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
@@ -418,9 +424,9 @@
418
424
  {
419
425
  "docs": {
420
426
  "stability": "stable",
421
- "summary": "Manifest for all assets in the Cloud Assembly."
427
+ "summary": "Stub required because of JSII."
422
428
  },
423
- "name": "ASSET_MANIFEST"
429
+ "name": "NONE"
424
430
  },
425
431
  {
426
432
  "docs": {
@@ -439,16 +445,16 @@
439
445
  {
440
446
  "docs": {
441
447
  "stability": "stable",
442
- "summary": "Nested Cloud Assembly."
448
+ "summary": "Manifest for all assets in the Cloud Assembly."
443
449
  },
444
- "name": "NESTED_CLOUD_ASSEMBLY"
450
+ "name": "ASSET_MANIFEST"
445
451
  },
446
452
  {
447
453
  "docs": {
448
454
  "stability": "stable",
449
- "summary": "Stub required because of JSII."
455
+ "summary": "Nested Cloud Assembly."
450
456
  },
451
- "name": "NONE"
457
+ "name": "NESTED_CLOUD_ASSEMBLY"
452
458
  }
453
459
  ],
454
460
  "name": "ArtifactType",
@@ -460,7 +466,10 @@
460
466
  "docs": {
461
467
  "stability": "stable",
462
468
  "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};"
469
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n version: 'version',\n\n // the properties below are optional\n artifacts: {\n artifactsKey: {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n },\n },\n missing: [{\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n }],\n runtime: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};",
470
+ "custom": {
471
+ "exampleMetadata": "fixture=_generated"
472
+ }
464
473
  },
465
474
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
466
475
  "kind": "interface",
@@ -470,6 +479,22 @@
470
479
  },
471
480
  "name": "AssemblyManifest",
472
481
  "properties": [
482
+ {
483
+ "abstract": true,
484
+ "docs": {
485
+ "stability": "stable",
486
+ "summary": "Protocol version."
487
+ },
488
+ "immutable": true,
489
+ "locationInModule": {
490
+ "filename": "lib/cloud-assembly/schema.ts",
491
+ "line": 117
492
+ },
493
+ "name": "version",
494
+ "type": {
495
+ "primitive": "string"
496
+ }
497
+ },
473
498
  {
474
499
  "abstract": true,
475
500
  "docs": {
@@ -534,22 +559,6 @@
534
559
  "type": {
535
560
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
536
561
  }
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
- }
553
562
  }
554
563
  ],
555
564
  "symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
@@ -560,7 +569,10 @@
560
569
  "docs": {
561
570
  "stability": "stable",
562
571
  "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};"
572
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assetManifest: cloud_assembly_schema.AssetManifest = {\n version: 'version',\n\n // the properties below are optional\n dockerImages: {\n dockerImagesKey: {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n },\n },\n files: {\n filesKey: {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n },\n },\n};",
573
+ "custom": {
574
+ "exampleMetadata": "fixture=_generated"
575
+ }
564
576
  },
565
577
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
566
578
  "kind": "interface",
@@ -570,6 +582,22 @@
570
582
  },
571
583
  "name": "AssetManifest",
572
584
  "properties": [
585
+ {
586
+ "abstract": true,
587
+ "docs": {
588
+ "stability": "stable",
589
+ "summary": "Version of the manifest."
590
+ },
591
+ "immutable": true,
592
+ "locationInModule": {
593
+ "filename": "lib/assets/schema.ts",
594
+ "line": 11
595
+ },
596
+ "name": "version",
597
+ "type": {
598
+ "primitive": "string"
599
+ }
600
+ },
573
601
  {
574
602
  "abstract": true,
575
603
  "docs": {
@@ -615,22 +643,6 @@
615
643
  "kind": "map"
616
644
  }
617
645
  }
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
- }
634
646
  }
635
647
  ],
636
648
  "symbolId": "lib/assets/schema:AssetManifest"
@@ -641,7 +653,10 @@
641
653
  "docs": {
642
654
  "stability": "stable",
643
655
  "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};"
656
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assetManifestProperties: cloud_assembly_schema.AssetManifestProperties = {\n file: 'file',\n\n // the properties below are optional\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
657
+ "custom": {
658
+ "exampleMetadata": "fixture=_generated"
659
+ }
645
660
  },
646
661
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
647
662
  "kind": "interface",
@@ -654,18 +669,15 @@
654
669
  {
655
670
  "abstract": true,
656
671
  "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.",
659
672
  "stability": "stable",
660
- "summary": "SSM parameter where the bootstrap stack version number can be found."
673
+ "summary": "Filename of the asset manifest."
661
674
  },
662
675
  "immutable": true,
663
676
  "locationInModule": {
664
677
  "filename": "lib/cloud-assembly/artifact-schema.ts",
665
- "line": 123
678
+ "line": 103
666
679
  },
667
- "name": "bootstrapStackVersionSsmParameter",
668
- "optional": true,
680
+ "name": "file",
669
681
  "type": {
670
682
  "primitive": "string"
671
683
  }
@@ -673,15 +685,18 @@
673
685
  {
674
686
  "abstract": true,
675
687
  "docs": {
688
+ "default": "- Bootstrap stack version number looked up",
689
+ "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.",
676
690
  "stability": "stable",
677
- "summary": "Filename of the asset manifest."
691
+ "summary": "SSM parameter where the bootstrap stack version number can be found."
678
692
  },
679
693
  "immutable": true,
680
694
  "locationInModule": {
681
695
  "filename": "lib/cloud-assembly/artifact-schema.ts",
682
- "line": 103
696
+ "line": 123
683
697
  },
684
- "name": "file",
698
+ "name": "bootstrapStackVersionSsmParameter",
699
+ "optional": true,
685
700
  "type": {
686
701
  "primitive": "string"
687
702
  }
@@ -713,7 +728,10 @@
713
728
  "docs": {
714
729
  "stability": "stable",
715
730
  "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};"
731
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst availabilityZonesContextQuery: cloud_assembly_schema.AvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
732
+ "custom": {
733
+ "exampleMetadata": "fixture=_generated"
734
+ }
717
735
  },
718
736
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
719
737
  "kind": "interface",
@@ -742,17 +760,15 @@
742
760
  {
743
761
  "abstract": true,
744
762
  "docs": {
745
- "default": "- None",
746
763
  "stability": "stable",
747
- "summary": "The ARN of the role that should be used to look up the missing values."
764
+ "summary": "Query region."
748
765
  },
749
766
  "immutable": true,
750
767
  "locationInModule": {
751
768
  "filename": "lib/cloud-assembly/context-queries.ts",
752
- "line": 111
769
+ "line": 104
753
770
  },
754
- "name": "lookupRoleArn",
755
- "optional": true,
771
+ "name": "region",
756
772
  "type": {
757
773
  "primitive": "string"
758
774
  }
@@ -760,15 +776,17 @@
760
776
  {
761
777
  "abstract": true,
762
778
  "docs": {
779
+ "default": "- None",
763
780
  "stability": "stable",
764
- "summary": "Query region."
781
+ "summary": "The ARN of the role that should be used to look up the missing values."
765
782
  },
766
783
  "immutable": true,
767
784
  "locationInModule": {
768
785
  "filename": "lib/cloud-assembly/context-queries.ts",
769
- "line": 104
786
+ "line": 111
770
787
  },
771
- "name": "region",
788
+ "name": "lookupRoleArn",
789
+ "optional": true,
772
790
  "type": {
773
791
  "primitive": "string"
774
792
  }
@@ -782,7 +800,10 @@
782
800
  "docs": {
783
801
  "stability": "stable",
784
802
  "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};"
803
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n};",
804
+ "custom": {
805
+ "exampleMetadata": "fixture=_generated"
806
+ }
786
807
  },
787
808
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
788
809
  "kind": "interface",
@@ -792,6 +813,22 @@
792
813
  },
793
814
  "name": "AwsCloudFormationStackProperties",
794
815
  "properties": [
816
+ {
817
+ "abstract": true,
818
+ "docs": {
819
+ "stability": "stable",
820
+ "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
821
+ },
822
+ "immutable": true,
823
+ "locationInModule": {
824
+ "filename": "lib/cloud-assembly/artifact-schema.ts",
825
+ "line": 9
826
+ },
827
+ "name": "templateFile",
828
+ "type": {
829
+ "primitive": "string"
830
+ }
831
+ },
795
832
  {
796
833
  "abstract": true,
797
834
  "docs": {
@@ -965,22 +1002,6 @@
965
1002
  }
966
1003
  }
967
1004
  },
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
- },
984
1005
  {
985
1006
  "abstract": true,
986
1007
  "docs": {
@@ -1026,7 +1047,10 @@
1026
1047
  "docs": {
1027
1048
  "stability": "stable",
1028
1049
  "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};"
1050
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsDestination: cloud_assembly_schema.AwsDestination = {\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
1051
+ "custom": {
1052
+ "exampleMetadata": "fixture=_generated"
1053
+ }
1030
1054
  },
1031
1055
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
1032
1056
  "kind": "interface",
@@ -1099,7 +1123,10 @@
1099
1123
  "docs": {
1100
1124
  "stability": "stable",
1101
1125
  "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};"
1126
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst containerImageAssetMetadataEntry: cloud_assembly_schema.ContainerImageAssetMetadataEntry = {\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n sourceHash: 'sourceHash',\n\n // the properties below are optional\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n file: 'file',\n imageNameParameter: 'imageNameParameter',\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n target: 'target',\n};",
1127
+ "custom": {
1128
+ "exampleMetadata": "fixture=_generated"
1129
+ }
1103
1130
  },
1104
1131
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry",
1105
1132
  "kind": "interface",
@@ -1112,40 +1139,31 @@
1112
1139
  {
1113
1140
  "abstract": true,
1114
1141
  "docs": {
1115
- "default": "no build args are passed",
1116
1142
  "stability": "stable",
1117
- "summary": "Build args to pass to the `docker build` command."
1143
+ "summary": "Logical identifier for the asset."
1118
1144
  },
1119
1145
  "immutable": true,
1120
1146
  "locationInModule": {
1121
1147
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1122
- "line": 119
1148
+ "line": 13
1123
1149
  },
1124
- "name": "buildArgs",
1125
- "optional": true,
1150
+ "name": "id",
1126
1151
  "type": {
1127
- "collection": {
1128
- "elementtype": {
1129
- "primitive": "string"
1130
- },
1131
- "kind": "map"
1132
- }
1152
+ "primitive": "string"
1133
1153
  }
1134
1154
  },
1135
1155
  {
1136
1156
  "abstract": true,
1137
1157
  "docs": {
1138
- "default": "- no file is passed",
1139
1158
  "stability": "stable",
1140
- "summary": "Path to the Dockerfile (relative to the directory)."
1159
+ "summary": "Type of asset."
1141
1160
  },
1142
1161
  "immutable": true,
1143
1162
  "locationInModule": {
1144
1163
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1145
- "line": 133
1164
+ "line": 81
1146
1165
  },
1147
- "name": "file",
1148
- "optional": true,
1166
+ "name": "packaging",
1149
1167
  "type": {
1150
1168
  "primitive": "string"
1151
1169
  }
@@ -1154,14 +1172,14 @@
1154
1172
  "abstract": true,
1155
1173
  "docs": {
1156
1174
  "stability": "stable",
1157
- "summary": "Logical identifier for the asset."
1175
+ "summary": "Path on disk to the asset."
1158
1176
  },
1159
1177
  "immutable": true,
1160
1178
  "locationInModule": {
1161
1179
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1162
- "line": 13
1180
+ "line": 23
1163
1181
  },
1164
- "name": "id",
1182
+ "name": "path",
1165
1183
  "type": {
1166
1184
  "primitive": "string"
1167
1185
  }
@@ -1169,18 +1187,15 @@
1169
1187
  {
1170
1188
  "abstract": true,
1171
1189
  "docs": {
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."
1190
+ "stability": "stable",
1191
+ "summary": "The hash of the asset source."
1176
1192
  },
1177
1193
  "immutable": true,
1178
1194
  "locationInModule": {
1179
1195
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1180
- "line": 93
1196
+ "line": 18
1181
1197
  },
1182
- "name": "imageNameParameter",
1183
- "optional": true,
1198
+ "name": "sourceHash",
1184
1199
  "type": {
1185
1200
  "primitive": "string"
1186
1201
  }
@@ -1188,34 +1203,40 @@
1188
1203
  {
1189
1204
  "abstract": true,
1190
1205
  "docs": {
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).",
1206
+ "default": "no build args are passed",
1193
1207
  "stability": "stable",
1194
- "summary": "The docker image tag to use for tagging pushed images."
1208
+ "summary": "Build args to pass to the `docker build` command."
1195
1209
  },
1196
1210
  "immutable": true,
1197
1211
  "locationInModule": {
1198
1212
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1199
- "line": 112
1213
+ "line": 119
1200
1214
  },
1201
- "name": "imageTag",
1215
+ "name": "buildArgs",
1202
1216
  "optional": true,
1203
1217
  "type": {
1204
- "primitive": "string"
1218
+ "collection": {
1219
+ "elementtype": {
1220
+ "primitive": "string"
1221
+ },
1222
+ "kind": "map"
1223
+ }
1205
1224
  }
1206
1225
  },
1207
1226
  {
1208
1227
  "abstract": true,
1209
1228
  "docs": {
1229
+ "default": "- no file is passed",
1210
1230
  "stability": "stable",
1211
- "summary": "Type of asset."
1231
+ "summary": "Path to the Dockerfile (relative to the directory)."
1212
1232
  },
1213
1233
  "immutable": true,
1214
1234
  "locationInModule": {
1215
1235
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1216
- "line": 81
1236
+ "line": 133
1217
1237
  },
1218
- "name": "packaging",
1238
+ "name": "file",
1239
+ "optional": true,
1219
1240
  "type": {
1220
1241
  "primitive": "string"
1221
1242
  }
@@ -1223,15 +1244,18 @@
1223
1244
  {
1224
1245
  "abstract": true,
1225
1246
  "docs": {
1226
- "stability": "stable",
1227
- "summary": "Path on disk to the asset."
1247
+ "default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
1248
+ "deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
1249
+ "stability": "deprecated",
1250
+ "summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
1228
1251
  },
1229
1252
  "immutable": true,
1230
1253
  "locationInModule": {
1231
1254
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1232
- "line": 23
1255
+ "line": 93
1233
1256
  },
1234
- "name": "path",
1257
+ "name": "imageNameParameter",
1258
+ "optional": true,
1235
1259
  "type": {
1236
1260
  "primitive": "string"
1237
1261
  }
@@ -1240,16 +1264,16 @@
1240
1264
  "abstract": true,
1241
1265
  "docs": {
1242
1266
  "default": "- this parameter is REQUIRED after 1.21.0",
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.",
1267
+ "remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
1244
1268
  "stability": "stable",
1245
- "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1269
+ "summary": "The docker image tag to use for tagging pushed images."
1246
1270
  },
1247
1271
  "immutable": true,
1248
1272
  "locationInModule": {
1249
1273
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1250
- "line": 103
1274
+ "line": 112
1251
1275
  },
1252
- "name": "repositoryName",
1276
+ "name": "imageTag",
1253
1277
  "optional": true,
1254
1278
  "type": {
1255
1279
  "primitive": "string"
@@ -1258,15 +1282,18 @@
1258
1282
  {
1259
1283
  "abstract": true,
1260
1284
  "docs": {
1285
+ "default": "- this parameter is REQUIRED after 1.21.0",
1286
+ "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.",
1261
1287
  "stability": "stable",
1262
- "summary": "The hash of the asset source."
1288
+ "summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
1263
1289
  },
1264
1290
  "immutable": true,
1265
1291
  "locationInModule": {
1266
1292
  "filename": "lib/cloud-assembly/metadata-schema.ts",
1267
- "line": 18
1293
+ "line": 103
1268
1294
  },
1269
- "name": "sourceHash",
1295
+ "name": "repositoryName",
1296
+ "optional": true,
1270
1297
  "type": {
1271
1298
  "primitive": "string"
1272
1299
  }
@@ -1322,30 +1349,30 @@
1322
1349
  {
1323
1350
  "docs": {
1324
1351
  "stability": "stable",
1325
- "summary": "VPC Endpoint Service AZ Provider."
1352
+ "summary": "Route53 Hosted Zone provider."
1326
1353
  },
1327
- "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1354
+ "name": "HOSTED_ZONE_PROVIDER"
1328
1355
  },
1329
1356
  {
1330
1357
  "docs": {
1331
1358
  "stability": "stable",
1332
- "summary": "Route53 Hosted Zone provider."
1359
+ "summary": "SSM Parameter Provider."
1333
1360
  },
1334
- "name": "HOSTED_ZONE_PROVIDER"
1361
+ "name": "SSM_PARAMETER_PROVIDER"
1335
1362
  },
1336
1363
  {
1337
1364
  "docs": {
1338
1365
  "stability": "stable",
1339
- "summary": "KMS Key Provider."
1366
+ "summary": "VPC Provider."
1340
1367
  },
1341
- "name": "KEY_PROVIDER"
1368
+ "name": "VPC_PROVIDER"
1342
1369
  },
1343
1370
  {
1344
1371
  "docs": {
1345
1372
  "stability": "stable",
1346
- "summary": "Load balancer listener provider."
1373
+ "summary": "VPC Endpoint Service AZ Provider."
1347
1374
  },
1348
- "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1375
+ "name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
1349
1376
  },
1350
1377
  {
1351
1378
  "docs": {
@@ -1357,23 +1384,23 @@
1357
1384
  {
1358
1385
  "docs": {
1359
1386
  "stability": "stable",
1360
- "summary": "Security group provider."
1387
+ "summary": "Load balancer listener provider."
1361
1388
  },
1362
- "name": "SECURITY_GROUP_PROVIDER"
1389
+ "name": "LOAD_BALANCER_LISTENER_PROVIDER"
1363
1390
  },
1364
1391
  {
1365
1392
  "docs": {
1366
1393
  "stability": "stable",
1367
- "summary": "SSM Parameter Provider."
1394
+ "summary": "Security group provider."
1368
1395
  },
1369
- "name": "SSM_PARAMETER_PROVIDER"
1396
+ "name": "SECURITY_GROUP_PROVIDER"
1370
1397
  },
1371
1398
  {
1372
1399
  "docs": {
1373
1400
  "stability": "stable",
1374
- "summary": "VPC Provider."
1401
+ "summary": "KMS Key Provider."
1375
1402
  },
1376
- "name": "VPC_PROVIDER"
1403
+ "name": "KEY_PROVIDER"
1377
1404
  }
1378
1405
  ],
1379
1406
  "name": "ContextProvider",
@@ -1385,7 +1412,10 @@
1385
1412
  "docs": {
1386
1413
  "stability": "stable",
1387
1414
  "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};"
1415
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n },\n};",
1416
+ "custom": {
1417
+ "exampleMetadata": "fixture=_generated"
1418
+ }
1389
1419
  },
1390
1420
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
1391
1421
  "kind": "interface",
@@ -1441,7 +1471,10 @@
1441
1471
  "docs": {
1442
1472
  "stability": "stable",
1443
1473
  "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};"
1474
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
1475
+ "custom": {
1476
+ "exampleMetadata": "fixture=_generated"
1477
+ }
1445
1478
  },
1446
1479
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
1447
1480
  "interfaces": [
@@ -1495,7 +1528,10 @@
1495
1528
  "docs": {
1496
1529
  "stability": "stable",
1497
1530
  "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};"
1531
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageSource: cloud_assembly_schema.DockerImageSource = {\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n executable: ['executable'],\n};",
1532
+ "custom": {
1533
+ "exampleMetadata": "fixture=_generated"
1534
+ }
1499
1535
  },
1500
1536
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
1501
1537
  "kind": "interface",
@@ -1618,7 +1654,10 @@
1618
1654
  "docs": {
1619
1655
  "stability": "stable",
1620
1656
  "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};"
1657
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst endpointServiceAvailabilityZonesContextQuery: cloud_assembly_schema.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
1658
+ "custom": {
1659
+ "exampleMetadata": "fixture=_generated"
1660
+ }
1622
1661
  },
1623
1662
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
1624
1663
  "kind": "interface",
@@ -1647,17 +1686,15 @@
1647
1686
  {
1648
1687
  "abstract": true,
1649
1688
  "docs": {
1650
- "default": "- None",
1651
1689
  "stability": "stable",
1652
- "summary": "The ARN of the role that should be used to look up the missing values."
1690
+ "summary": "Query region."
1653
1691
  },
1654
1692
  "immutable": true,
1655
1693
  "locationInModule": {
1656
1694
  "filename": "lib/cloud-assembly/context-queries.ts",
1657
- "line": 254
1695
+ "line": 247
1658
1696
  },
1659
- "name": "lookupRoleArn",
1660
- "optional": true,
1697
+ "name": "region",
1661
1698
  "type": {
1662
1699
  "primitive": "string"
1663
1700
  }
@@ -1666,14 +1703,14 @@
1666
1703
  "abstract": true,
1667
1704
  "docs": {
1668
1705
  "stability": "stable",
1669
- "summary": "Query region."
1706
+ "summary": "Query service name."
1670
1707
  },
1671
1708
  "immutable": true,
1672
1709
  "locationInModule": {
1673
1710
  "filename": "lib/cloud-assembly/context-queries.ts",
1674
- "line": 247
1711
+ "line": 259
1675
1712
  },
1676
- "name": "region",
1713
+ "name": "serviceName",
1677
1714
  "type": {
1678
1715
  "primitive": "string"
1679
1716
  }
@@ -1681,15 +1718,17 @@
1681
1718
  {
1682
1719
  "abstract": true,
1683
1720
  "docs": {
1721
+ "default": "- None",
1684
1722
  "stability": "stable",
1685
- "summary": "Query service name."
1723
+ "summary": "The ARN of the role that should be used to look up the missing values."
1686
1724
  },
1687
1725
  "immutable": true,
1688
1726
  "locationInModule": {
1689
1727
  "filename": "lib/cloud-assembly/context-queries.ts",
1690
- "line": 259
1728
+ "line": 254
1691
1729
  },
1692
- "name": "serviceName",
1730
+ "name": "lookupRoleArn",
1731
+ "optional": true,
1693
1732
  "type": {
1694
1733
  "primitive": "string"
1695
1734
  }
@@ -1703,7 +1742,10 @@
1703
1742
  "docs": {
1704
1743
  "stability": "stable",
1705
1744
  "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};"
1745
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileAsset: cloud_assembly_schema.FileAsset = {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n};",
1746
+ "custom": {
1747
+ "exampleMetadata": "fixture=_generated"
1748
+ }
1707
1749
  },
1708
1750
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
1709
1751
  "kind": "interface",
@@ -1759,7 +1801,10 @@
1759
1801
  "docs": {
1760
1802
  "stability": "stable",
1761
1803
  "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};"
1804
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileAssetMetadataEntry: cloud_assembly_schema.FileAssetMetadataEntry = {\n artifactHashParameter: 'artifactHashParameter',\n id: 'id',\n packaging: 'packaging',\n path: 'path',\n s3BucketParameter: 's3BucketParameter',\n s3KeyParameter: 's3KeyParameter',\n sourceHash: 'sourceHash',\n};",
1805
+ "custom": {
1806
+ "exampleMetadata": "fixture=_generated"
1807
+ }
1763
1808
  },
1764
1809
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry",
1765
1810
  "kind": "interface",
@@ -1921,7 +1966,10 @@
1921
1966
  "docs": {
1922
1967
  "stability": "stable",
1923
1968
  "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};"
1969
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileDestination: cloud_assembly_schema.FileDestination = {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
1970
+ "custom": {
1971
+ "exampleMetadata": "fixture=_generated"
1972
+ }
1925
1973
  },
1926
1974
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
1927
1975
  "interfaces": [
@@ -1975,7 +2023,10 @@
1975
2023
  "docs": {
1976
2024
  "stability": "stable",
1977
2025
  "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};"
2026
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileSource: cloud_assembly_schema.FileSource = {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n};",
2027
+ "custom": {
2028
+ "exampleMetadata": "fixture=_generated"
2029
+ }
1979
2030
  },
1980
2031
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
1981
2032
  "kind": "interface",
@@ -2055,7 +2106,10 @@
2055
2106
  "docs": {
2056
2107
  "stability": "stable",
2057
2108
  "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};"
2109
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {\n account: 'account',\n domainName: 'domainName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n privateZone: false,\n vpcId: 'vpcId',\n};",
2110
+ "custom": {
2111
+ "exampleMetadata": "fixture=_generated"
2112
+ }
2059
2113
  },
2060
2114
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
2061
2115
  "kind": "interface",
@@ -2100,17 +2154,15 @@
2100
2154
  {
2101
2155
  "abstract": true,
2102
2156
  "docs": {
2103
- "default": "- None",
2104
2157
  "stability": "stable",
2105
- "summary": "The ARN of the role that should be used to look up the missing values."
2158
+ "summary": "Query region."
2106
2159
  },
2107
2160
  "immutable": true,
2108
2161
  "locationInModule": {
2109
2162
  "filename": "lib/cloud-assembly/context-queries.ts",
2110
- "line": 134
2163
+ "line": 127
2111
2164
  },
2112
- "name": "lookupRoleArn",
2113
- "optional": true,
2165
+ "name": "region",
2114
2166
  "type": {
2115
2167
  "primitive": "string"
2116
2168
  }
@@ -2118,35 +2170,37 @@
2118
2170
  {
2119
2171
  "abstract": true,
2120
2172
  "docs": {
2121
- "default": "false",
2173
+ "default": "- None",
2122
2174
  "stability": "stable",
2123
- "summary": "True if the zone you want to find is a private hosted zone."
2175
+ "summary": "The ARN of the role that should be used to look up the missing values."
2124
2176
  },
2125
2177
  "immutable": true,
2126
2178
  "locationInModule": {
2127
2179
  "filename": "lib/cloud-assembly/context-queries.ts",
2128
- "line": 146
2180
+ "line": 134
2129
2181
  },
2130
- "name": "privateZone",
2182
+ "name": "lookupRoleArn",
2131
2183
  "optional": true,
2132
2184
  "type": {
2133
- "primitive": "boolean"
2185
+ "primitive": "string"
2134
2186
  }
2135
2187
  },
2136
2188
  {
2137
2189
  "abstract": true,
2138
2190
  "docs": {
2191
+ "default": "false",
2139
2192
  "stability": "stable",
2140
- "summary": "Query region."
2193
+ "summary": "True if the zone you want to find is a private hosted zone."
2141
2194
  },
2142
2195
  "immutable": true,
2143
2196
  "locationInModule": {
2144
2197
  "filename": "lib/cloud-assembly/context-queries.ts",
2145
- "line": 127
2198
+ "line": 146
2146
2199
  },
2147
- "name": "region",
2200
+ "name": "privateZone",
2201
+ "optional": true,
2148
2202
  "type": {
2149
- "primitive": "string"
2203
+ "primitive": "boolean"
2150
2204
  }
2151
2205
  },
2152
2206
  {
@@ -2177,7 +2231,10 @@
2177
2231
  "docs": {
2178
2232
  "stability": "stable",
2179
2233
  "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};"
2234
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst keyContextQuery: cloud_assembly_schema.KeyContextQuery = {\n account: 'account',\n aliasName: 'aliasName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
2235
+ "custom": {
2236
+ "exampleMetadata": "fixture=_generated"
2237
+ }
2181
2238
  },
2182
2239
  "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
2183
2240
  "kind": "interface",
@@ -2222,17 +2279,15 @@
2222
2279
  {
2223
2280
  "abstract": true,
2224
2281
  "docs": {
2225
- "default": "- None",
2226
2282
  "stability": "stable",
2227
- "summary": "The ARN of the role that should be used to look up the missing values."
2283
+ "summary": "Query region."
2228
2284
  },
2229
2285
  "immutable": true,
2230
2286
  "locationInModule": {
2231
2287
  "filename": "lib/cloud-assembly/context-queries.ts",
2232
- "line": 458
2288
+ "line": 451
2233
2289
  },
2234
- "name": "lookupRoleArn",
2235
- "optional": true,
2290
+ "name": "region",
2236
2291
  "type": {
2237
2292
  "primitive": "string"
2238
2293
  }
@@ -2240,15 +2295,17 @@
2240
2295
  {
2241
2296
  "abstract": true,
2242
2297
  "docs": {
2298
+ "default": "- None",
2243
2299
  "stability": "stable",
2244
- "summary": "Query region."
2300
+ "summary": "The ARN of the role that should be used to look up the missing values."
2245
2301
  },
2246
2302
  "immutable": true,
2247
2303
  "locationInModule": {
2248
2304
  "filename": "lib/cloud-assembly/context-queries.ts",
2249
- "line": 451
2305
+ "line": 458
2250
2306
  },
2251
- "name": "region",
2307
+ "name": "lookupRoleArn",
2308
+ "optional": true,
2252
2309
  "type": {
2253
2310
  "primitive": "string"
2254
2311
  }
@@ -2262,7 +2319,10 @@
2262
2319
  "docs": {
2263
2320
  "stability": "stable",
2264
2321
  "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};"
2322
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerContextQuery: cloud_assembly_schema.LoadBalancerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};",
2323
+ "custom": {
2324
+ "exampleMetadata": "fixture=_generated"
2325
+ }
2266
2326
  },
2267
2327
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
2268
2328
  "interfaces": [
@@ -2294,17 +2354,15 @@
2294
2354
  {
2295
2355
  "abstract": true,
2296
2356
  "docs": {
2297
- "default": "- None",
2298
2357
  "stability": "stable",
2299
- "summary": "The ARN of the role that should be used to look up the missing values."
2358
+ "summary": "Query region."
2300
2359
  },
2301
2360
  "immutable": true,
2302
2361
  "locationInModule": {
2303
2362
  "filename": "lib/cloud-assembly/context-queries.ts",
2304
- "line": 318
2363
+ "line": 311
2305
2364
  },
2306
- "name": "lookupRoleArn",
2307
- "optional": true,
2365
+ "name": "region",
2308
2366
  "type": {
2309
2367
  "primitive": "string"
2310
2368
  }
@@ -2312,15 +2370,17 @@
2312
2370
  {
2313
2371
  "abstract": true,
2314
2372
  "docs": {
2373
+ "default": "- None",
2315
2374
  "stability": "stable",
2316
- "summary": "Query region."
2375
+ "summary": "The ARN of the role that should be used to look up the missing values."
2317
2376
  },
2318
2377
  "immutable": true,
2319
2378
  "locationInModule": {
2320
2379
  "filename": "lib/cloud-assembly/context-queries.ts",
2321
- "line": 311
2380
+ "line": 318
2322
2381
  },
2323
- "name": "region",
2382
+ "name": "lookupRoleArn",
2383
+ "optional": true,
2324
2384
  "type": {
2325
2385
  "primitive": "string"
2326
2386
  }
@@ -2334,7 +2394,10 @@
2334
2394
  "docs": {
2335
2395
  "stability": "stable",
2336
2396
  "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};"
2397
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n};",
2398
+ "custom": {
2399
+ "exampleMetadata": "fixture=_generated"
2400
+ }
2338
2401
  },
2339
2402
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
2340
2403
  "kind": "interface",
@@ -2344,6 +2407,22 @@
2344
2407
  },
2345
2408
  "name": "LoadBalancerFilter",
2346
2409
  "properties": [
2410
+ {
2411
+ "abstract": true,
2412
+ "docs": {
2413
+ "stability": "stable",
2414
+ "summary": "Filter load balancers by their type."
2415
+ },
2416
+ "immutable": true,
2417
+ "locationInModule": {
2418
+ "filename": "lib/cloud-assembly/context-queries.ts",
2419
+ "line": 284
2420
+ },
2421
+ "name": "loadBalancerType",
2422
+ "type": {
2423
+ "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
2424
+ }
2425
+ },
2347
2426
  {
2348
2427
  "abstract": true,
2349
2428
  "docs": {
@@ -2384,22 +2463,6 @@
2384
2463
  "kind": "array"
2385
2464
  }
2386
2465
  }
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
- }
2403
2466
  }
2404
2467
  ],
2405
2468
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
@@ -2410,7 +2473,10 @@
2410
2473
  "docs": {
2411
2474
  "stability": "stable",
2412
2475
  "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};"
2476
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerListenerContextQuery: cloud_assembly_schema.LoadBalancerListenerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n listenerArn: 'listenerArn',\n listenerPort: 123,\n listenerProtocol: cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};",
2477
+ "custom": {
2478
+ "exampleMetadata": "fixture=_generated"
2479
+ }
2414
2480
  },
2415
2481
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
2416
2482
  "interfaces": [
@@ -2439,6 +2505,22 @@
2439
2505
  "primitive": "string"
2440
2506
  }
2441
2507
  },
2508
+ {
2509
+ "abstract": true,
2510
+ "docs": {
2511
+ "stability": "stable",
2512
+ "summary": "Query region."
2513
+ },
2514
+ "immutable": true,
2515
+ "locationInModule": {
2516
+ "filename": "lib/cloud-assembly/context-queries.ts",
2517
+ "line": 368
2518
+ },
2519
+ "name": "region",
2520
+ "type": {
2521
+ "primitive": "string"
2522
+ }
2523
+ },
2442
2524
  {
2443
2525
  "abstract": true,
2444
2526
  "docs": {
@@ -2510,22 +2592,6 @@
2510
2592
  "type": {
2511
2593
  "primitive": "string"
2512
2594
  }
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
- }
2529
2595
  }
2530
2596
  ],
2531
2597
  "symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
@@ -2567,23 +2633,23 @@
2567
2633
  {
2568
2634
  "docs": {
2569
2635
  "stability": "stable",
2570
- "summary": "TCP and UDP protocol."
2636
+ "summary": "TLS protocol."
2571
2637
  },
2572
- "name": "TCP_UDP"
2638
+ "name": "TLS"
2573
2639
  },
2574
2640
  {
2575
2641
  "docs": {
2576
2642
  "stability": "stable",
2577
- "summary": "TLS protocol."
2643
+ "summary": "UDP protocol."
2578
2644
  },
2579
- "name": "TLS"
2645
+ "name": "UDP"
2580
2646
  },
2581
2647
  {
2582
2648
  "docs": {
2583
2649
  "stability": "stable",
2584
- "summary": "UDP protocol."
2650
+ "summary": "TCP and UDP protocol."
2585
2651
  },
2586
- "name": "UDP"
2652
+ "name": "TCP_UDP"
2587
2653
  }
2588
2654
  ],
2589
2655
  "name": "LoadBalancerListenerProtocol",
@@ -2605,16 +2671,16 @@
2605
2671
  {
2606
2672
  "docs": {
2607
2673
  "stability": "stable",
2608
- "summary": "Application load balancer."
2674
+ "summary": "Network load balancer."
2609
2675
  },
2610
- "name": "APPLICATION"
2676
+ "name": "NETWORK"
2611
2677
  },
2612
2678
  {
2613
2679
  "docs": {
2614
2680
  "stability": "stable",
2615
- "summary": "Network load balancer."
2681
+ "summary": "Application load balancer."
2616
2682
  },
2617
- "name": "NETWORK"
2683
+ "name": "APPLICATION"
2618
2684
  }
2619
2685
  ],
2620
2686
  "name": "LoadBalancerType",
@@ -2833,7 +2899,10 @@
2833
2899
  "docs": {
2834
2900
  "stability": "stable",
2835
2901
  "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};"
2902
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst metadataEntry: cloud_assembly_schema.MetadataEntry = {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};",
2903
+ "custom": {
2904
+ "exampleMetadata": "fixture=_generated"
2905
+ }
2837
2906
  },
2838
2907
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
2839
2908
  "kind": "interface",
@@ -2843,6 +2912,22 @@
2843
2912
  },
2844
2913
  "name": "MetadataEntry",
2845
2914
  "properties": [
2915
+ {
2916
+ "abstract": true,
2917
+ "docs": {
2918
+ "stability": "stable",
2919
+ "summary": "The type of the metadata entry."
2920
+ },
2921
+ "immutable": true,
2922
+ "locationInModule": {
2923
+ "filename": "lib/cloud-assembly/metadata-schema.ts",
2924
+ "line": 208
2925
+ },
2926
+ "name": "type",
2927
+ "type": {
2928
+ "primitive": "string"
2929
+ }
2930
+ },
2846
2931
  {
2847
2932
  "abstract": true,
2848
2933
  "docs": {
@@ -2903,22 +2988,6 @@
2903
2988
  "kind": "array"
2904
2989
  }
2905
2990
  }
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
- }
2922
2991
  }
2923
2992
  ],
2924
2993
  "symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
@@ -2929,7 +2998,10 @@
2929
2998
  "docs": {
2930
2999
  "stability": "stable",
2931
3000
  "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};"
3001
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst missingContext: cloud_assembly_schema.MissingContext = {\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n};",
3002
+ "custom": {
3003
+ "exampleMetadata": "fixture=_generated"
3004
+ }
2933
3005
  },
2934
3006
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
2935
3007
  "kind": "interface",
@@ -3029,7 +3101,10 @@
3029
3101
  "docs": {
3030
3102
  "stability": "stable",
3031
3103
  "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};"
3104
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst nestedCloudAssemblyProperties: cloud_assembly_schema.NestedCloudAssemblyProperties = {\n directoryName: 'directoryName',\n\n // the properties below are optional\n displayName: 'displayName',\n};",
3105
+ "custom": {
3106
+ "exampleMetadata": "fixture=_generated"
3107
+ }
3033
3108
  },
3034
3109
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
3035
3110
  "kind": "interface",
@@ -3082,7 +3157,10 @@
3082
3157
  "docs": {
3083
3158
  "stability": "stable",
3084
3159
  "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};"
3160
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst runtimeInfo: cloud_assembly_schema.RuntimeInfo = {\n libraries: {\n librariesKey: 'libraries',\n },\n};",
3161
+ "custom": {
3162
+ "exampleMetadata": "fixture=_generated"
3163
+ }
3086
3164
  },
3087
3165
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
3088
3166
  "kind": "interface",
@@ -3122,7 +3200,10 @@
3122
3200
  "docs": {
3123
3201
  "stability": "stable",
3124
3202
  "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};"
3203
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst sSMParameterContextQuery: cloud_assembly_schema.SSMParameterContextQuery = {\n account: 'account',\n parameterName: 'parameterName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
3204
+ "custom": {
3205
+ "exampleMetadata": "fixture=_generated"
3206
+ }
3126
3207
  },
3127
3208
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
3128
3209
  "kind": "interface",
@@ -3151,17 +3232,15 @@
3151
3232
  {
3152
3233
  "abstract": true,
3153
3234
  "docs": {
3154
- "default": "- None",
3155
3235
  "stability": "stable",
3156
- "summary": "The ARN of the role that should be used to look up the missing values."
3236
+ "summary": "Parameter name to query."
3157
3237
  },
3158
3238
  "immutable": true,
3159
3239
  "locationInModule": {
3160
3240
  "filename": "lib/cloud-assembly/context-queries.ts",
3161
- "line": 178
3241
+ "line": 183
3162
3242
  },
3163
- "name": "lookupRoleArn",
3164
- "optional": true,
3243
+ "name": "parameterName",
3165
3244
  "type": {
3166
3245
  "primitive": "string"
3167
3246
  }
@@ -3170,14 +3249,14 @@
3170
3249
  "abstract": true,
3171
3250
  "docs": {
3172
3251
  "stability": "stable",
3173
- "summary": "Parameter name to query."
3252
+ "summary": "Query region."
3174
3253
  },
3175
3254
  "immutable": true,
3176
3255
  "locationInModule": {
3177
3256
  "filename": "lib/cloud-assembly/context-queries.ts",
3178
- "line": 183
3257
+ "line": 171
3179
3258
  },
3180
- "name": "parameterName",
3259
+ "name": "region",
3181
3260
  "type": {
3182
3261
  "primitive": "string"
3183
3262
  }
@@ -3185,15 +3264,17 @@
3185
3264
  {
3186
3265
  "abstract": true,
3187
3266
  "docs": {
3267
+ "default": "- None",
3188
3268
  "stability": "stable",
3189
- "summary": "Query region."
3269
+ "summary": "The ARN of the role that should be used to look up the missing values."
3190
3270
  },
3191
3271
  "immutable": true,
3192
3272
  "locationInModule": {
3193
3273
  "filename": "lib/cloud-assembly/context-queries.ts",
3194
- "line": 171
3274
+ "line": 178
3195
3275
  },
3196
- "name": "region",
3276
+ "name": "lookupRoleArn",
3277
+ "optional": true,
3197
3278
  "type": {
3198
3279
  "primitive": "string"
3199
3280
  }
@@ -3207,7 +3288,10 @@
3207
3288
  "docs": {
3208
3289
  "stability": "stable",
3209
3290
  "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};"
3291
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n securityGroupId: 'securityGroupId',\n securityGroupName: 'securityGroupName',\n vpcId: 'vpcId',\n};",
3292
+ "custom": {
3293
+ "exampleMetadata": "fixture=_generated"
3294
+ }
3211
3295
  },
3212
3296
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
3213
3297
  "kind": "interface",
@@ -3236,17 +3320,15 @@
3236
3320
  {
3237
3321
  "abstract": true,
3238
3322
  "docs": {
3239
- "default": "- None",
3240
3323
  "stability": "stable",
3241
- "summary": "The ARN of the role that should be used to look up the missing values."
3324
+ "summary": "Query region."
3242
3325
  },
3243
3326
  "immutable": true,
3244
3327
  "locationInModule": {
3245
3328
  "filename": "lib/cloud-assembly/context-queries.ts",
3246
- "line": 415
3329
+ "line": 408
3247
3330
  },
3248
- "name": "lookupRoleArn",
3249
- "optional": true,
3331
+ "name": "region",
3250
3332
  "type": {
3251
3333
  "primitive": "string"
3252
3334
  }
@@ -3254,15 +3336,17 @@
3254
3336
  {
3255
3337
  "abstract": true,
3256
3338
  "docs": {
3339
+ "default": "- None",
3257
3340
  "stability": "stable",
3258
- "summary": "Query region."
3341
+ "summary": "The ARN of the role that should be used to look up the missing values."
3259
3342
  },
3260
3343
  "immutable": true,
3261
3344
  "locationInModule": {
3262
3345
  "filename": "lib/cloud-assembly/context-queries.ts",
3263
- "line": 408
3346
+ "line": 415
3264
3347
  },
3265
- "name": "region",
3348
+ "name": "lookupRoleArn",
3349
+ "optional": true,
3266
3350
  "type": {
3267
3351
  "primitive": "string"
3268
3352
  }
@@ -3330,7 +3414,10 @@
3330
3414
  "docs": {
3331
3415
  "stability": "stable",
3332
3416
  "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};"
3417
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst tag: cloud_assembly_schema.Tag = {\n key: 'key',\n value: 'value',\n};",
3418
+ "custom": {
3419
+ "exampleMetadata": "fixture=_generated"
3420
+ }
3334
3421
  },
3335
3422
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
3336
3423
  "kind": "interface",
@@ -3383,7 +3470,10 @@
3383
3470
  "docs": {
3384
3471
  "stability": "stable",
3385
3472
  "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};"
3473
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst treeArtifactProperties: cloud_assembly_schema.TreeArtifactProperties = {\n file: 'file',\n};",
3474
+ "custom": {
3475
+ "exampleMetadata": "fixture=_generated"
3476
+ }
3387
3477
  },
3388
3478
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
3389
3479
  "kind": "interface",
@@ -3418,7 +3508,10 @@
3418
3508
  "docs": {
3419
3509
  "stability": "stable",
3420
3510
  "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};"
3511
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {\n account: 'account',\n filter: {\n filterKey: 'filter',\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n returnAsymmetricSubnets: false,\n subnetGroupNameTag: 'subnetGroupNameTag',\n};",
3512
+ "custom": {
3513
+ "exampleMetadata": "fixture=_generated"
3514
+ }
3422
3515
  },
3423
3516
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
3424
3517
  "kind": "interface",
@@ -3470,17 +3563,15 @@
3470
3563
  {
3471
3564
  "abstract": true,
3472
3565
  "docs": {
3473
- "default": "- None",
3474
3566
  "stability": "stable",
3475
- "summary": "The ARN of the role that should be used to look up the missing values."
3567
+ "summary": "Query region."
3476
3568
  },
3477
3569
  "immutable": true,
3478
3570
  "locationInModule": {
3479
3571
  "filename": "lib/cloud-assembly/context-queries.ts",
3480
- "line": 205
3572
+ "line": 198
3481
3573
  },
3482
- "name": "lookupRoleArn",
3483
- "optional": true,
3574
+ "name": "region",
3484
3575
  "type": {
3485
3576
  "primitive": "string"
3486
3577
  }
@@ -3488,15 +3579,17 @@
3488
3579
  {
3489
3580
  "abstract": true,
3490
3581
  "docs": {
3582
+ "default": "- None",
3491
3583
  "stability": "stable",
3492
- "summary": "Query region."
3584
+ "summary": "The ARN of the role that should be used to look up the missing values."
3493
3585
  },
3494
3586
  "immutable": true,
3495
3587
  "locationInModule": {
3496
3588
  "filename": "lib/cloud-assembly/context-queries.ts",
3497
- "line": 198
3589
+ "line": 205
3498
3590
  },
3499
- "name": "region",
3591
+ "name": "lookupRoleArn",
3592
+ "optional": true,
3500
3593
  "type": {
3501
3594
  "primitive": "string"
3502
3595
  }
@@ -3542,6 +3635,6 @@
3542
3635
  "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
3543
3636
  }
3544
3637
  },
3545
- "version": "2.0.0",
3638
+ "version": "2.4.0",
3546
3639
  "fingerprint": "**********"
3547
3640
  }