@aws-cdk/cloud-assembly-schema 2.3.0 → 2.7.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 +460 -350
- package/.jsii.tabl.json +1676 -0
- package/.warnings.jsii.js +20 -12
- package/LICENSE +1 -1
- package/NOTICE +1 -1
- package/lib/cloud-assembly/artifact-schema.d.ts +41 -0
- package/lib/cloud-assembly/artifact-schema.js +1 -1
- package/lib/manifest.js +1 -1
- package/package.json +5 -5
- package/schema/cloud-assembly.schema.json +30 -1
- package/schema/cloud-assembly.version.json +1 -1
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.
|
|
19
|
+
"jsiiVersion": "1.50.0 (build d1830a4)",
|
|
20
20
|
"keywords": [
|
|
21
21
|
"aws",
|
|
22
22
|
"cdk"
|
|
@@ -75,7 +75,7 @@
|
|
|
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';\
|
|
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
79
|
"custom": {
|
|
80
80
|
"exampleMetadata": "fixture=_generated"
|
|
81
81
|
}
|
|
@@ -130,6 +130,22 @@
|
|
|
130
130
|
}
|
|
131
131
|
}
|
|
132
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
|
+
},
|
|
133
149
|
{
|
|
134
150
|
"abstract": true,
|
|
135
151
|
"docs": {
|
|
@@ -170,22 +186,6 @@
|
|
|
170
186
|
"kind": "array"
|
|
171
187
|
}
|
|
172
188
|
}
|
|
173
|
-
},
|
|
174
|
-
{
|
|
175
|
-
"abstract": true,
|
|
176
|
-
"docs": {
|
|
177
|
-
"stability": "stable",
|
|
178
|
-
"summary": "Region to query."
|
|
179
|
-
},
|
|
180
|
-
"immutable": true,
|
|
181
|
-
"locationInModule": {
|
|
182
|
-
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
183
|
-
"line": 70
|
|
184
|
-
},
|
|
185
|
-
"name": "region",
|
|
186
|
-
"type": {
|
|
187
|
-
"primitive": "string"
|
|
188
|
-
}
|
|
189
189
|
}
|
|
190
190
|
],
|
|
191
191
|
"symbolId": "lib/cloud-assembly/context-queries:AmiContextQuery"
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
"docs": {
|
|
197
197
|
"stability": "stable",
|
|
198
198
|
"summary": "A manifest for a single artifact within the cloud assembly.",
|
|
199
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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 lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\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
200
|
"custom": {
|
|
201
201
|
"exampleMetadata": "fixture=_generated"
|
|
202
202
|
}
|
|
@@ -209,6 +209,22 @@
|
|
|
209
209
|
},
|
|
210
210
|
"name": "ArtifactManifest",
|
|
211
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
|
+
},
|
|
212
228
|
{
|
|
213
229
|
"abstract": true,
|
|
214
230
|
"docs": {
|
|
@@ -329,22 +345,6 @@
|
|
|
329
345
|
]
|
|
330
346
|
}
|
|
331
347
|
}
|
|
332
|
-
},
|
|
333
|
-
{
|
|
334
|
-
"abstract": true,
|
|
335
|
-
"docs": {
|
|
336
|
-
"stability": "stable",
|
|
337
|
-
"summary": "The type of artifact."
|
|
338
|
-
},
|
|
339
|
-
"immutable": true,
|
|
340
|
-
"locationInModule": {
|
|
341
|
-
"filename": "lib/cloud-assembly/schema.ts",
|
|
342
|
-
"line": 72
|
|
343
|
-
},
|
|
344
|
-
"name": "type",
|
|
345
|
-
"type": {
|
|
346
|
-
"fqn": "@aws-cdk/cloud-assembly-schema.ArtifactType"
|
|
347
|
-
}
|
|
348
348
|
}
|
|
349
349
|
],
|
|
350
350
|
"symbolId": "lib/cloud-assembly/schema:ArtifactManifest"
|
|
@@ -424,9 +424,9 @@
|
|
|
424
424
|
{
|
|
425
425
|
"docs": {
|
|
426
426
|
"stability": "stable",
|
|
427
|
-
"summary": "
|
|
427
|
+
"summary": "Stub required because of JSII."
|
|
428
428
|
},
|
|
429
|
-
"name": "
|
|
429
|
+
"name": "NONE"
|
|
430
430
|
},
|
|
431
431
|
{
|
|
432
432
|
"docs": {
|
|
@@ -445,16 +445,16 @@
|
|
|
445
445
|
{
|
|
446
446
|
"docs": {
|
|
447
447
|
"stability": "stable",
|
|
448
|
-
"summary": "
|
|
448
|
+
"summary": "Manifest for all assets in the Cloud Assembly."
|
|
449
449
|
},
|
|
450
|
-
"name": "
|
|
450
|
+
"name": "ASSET_MANIFEST"
|
|
451
451
|
},
|
|
452
452
|
{
|
|
453
453
|
"docs": {
|
|
454
454
|
"stability": "stable",
|
|
455
|
-
"summary": "
|
|
455
|
+
"summary": "Nested Cloud Assembly."
|
|
456
456
|
},
|
|
457
|
-
"name": "
|
|
457
|
+
"name": "NESTED_CLOUD_ASSEMBLY"
|
|
458
458
|
}
|
|
459
459
|
],
|
|
460
460
|
"name": "ArtifactType",
|
|
@@ -466,7 +466,7 @@
|
|
|
466
466
|
"docs": {
|
|
467
467
|
"stability": "stable",
|
|
468
468
|
"summary": "A manifest which describes the cloud assembly.",
|
|
469
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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 lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\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
470
|
"custom": {
|
|
471
471
|
"exampleMetadata": "fixture=_generated"
|
|
472
472
|
}
|
|
@@ -479,6 +479,22 @@
|
|
|
479
479
|
},
|
|
480
480
|
"name": "AssemblyManifest",
|
|
481
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
|
+
},
|
|
482
498
|
{
|
|
483
499
|
"abstract": true,
|
|
484
500
|
"docs": {
|
|
@@ -543,22 +559,6 @@
|
|
|
543
559
|
"type": {
|
|
544
560
|
"fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo"
|
|
545
561
|
}
|
|
546
|
-
},
|
|
547
|
-
{
|
|
548
|
-
"abstract": true,
|
|
549
|
-
"docs": {
|
|
550
|
-
"stability": "stable",
|
|
551
|
-
"summary": "Protocol version."
|
|
552
|
-
},
|
|
553
|
-
"immutable": true,
|
|
554
|
-
"locationInModule": {
|
|
555
|
-
"filename": "lib/cloud-assembly/schema.ts",
|
|
556
|
-
"line": 117
|
|
557
|
-
},
|
|
558
|
-
"name": "version",
|
|
559
|
-
"type": {
|
|
560
|
-
"primitive": "string"
|
|
561
|
-
}
|
|
562
562
|
}
|
|
563
563
|
],
|
|
564
564
|
"symbolId": "lib/cloud-assembly/schema:AssemblyManifest"
|
|
@@ -569,7 +569,7 @@
|
|
|
569
569
|
"docs": {
|
|
570
570
|
"stability": "stable",
|
|
571
571
|
"summary": "Definitions for the asset manifest.",
|
|
572
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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
573
|
"custom": {
|
|
574
574
|
"exampleMetadata": "fixture=_generated"
|
|
575
575
|
}
|
|
@@ -582,6 +582,22 @@
|
|
|
582
582
|
},
|
|
583
583
|
"name": "AssetManifest",
|
|
584
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
|
+
},
|
|
585
601
|
{
|
|
586
602
|
"abstract": true,
|
|
587
603
|
"docs": {
|
|
@@ -627,22 +643,6 @@
|
|
|
627
643
|
"kind": "map"
|
|
628
644
|
}
|
|
629
645
|
}
|
|
630
|
-
},
|
|
631
|
-
{
|
|
632
|
-
"abstract": true,
|
|
633
|
-
"docs": {
|
|
634
|
-
"stability": "stable",
|
|
635
|
-
"summary": "Version of the manifest."
|
|
636
|
-
},
|
|
637
|
-
"immutable": true,
|
|
638
|
-
"locationInModule": {
|
|
639
|
-
"filename": "lib/assets/schema.ts",
|
|
640
|
-
"line": 11
|
|
641
|
-
},
|
|
642
|
-
"name": "version",
|
|
643
|
-
"type": {
|
|
644
|
-
"primitive": "string"
|
|
645
|
-
}
|
|
646
646
|
}
|
|
647
647
|
],
|
|
648
648
|
"symbolId": "lib/assets/schema:AssetManifest"
|
|
@@ -653,7 +653,7 @@
|
|
|
653
653
|
"docs": {
|
|
654
654
|
"stability": "stable",
|
|
655
655
|
"summary": "Artifact properties for the Asset Manifest.",
|
|
656
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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
657
|
"custom": {
|
|
658
658
|
"exampleMetadata": "fixture=_generated"
|
|
659
659
|
}
|
|
@@ -662,25 +662,22 @@
|
|
|
662
662
|
"kind": "interface",
|
|
663
663
|
"locationInModule": {
|
|
664
664
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
665
|
-
"line":
|
|
665
|
+
"line": 139
|
|
666
666
|
},
|
|
667
667
|
"name": "AssetManifestProperties",
|
|
668
668
|
"properties": [
|
|
669
669
|
{
|
|
670
670
|
"abstract": true,
|
|
671
671
|
"docs": {
|
|
672
|
-
"default": "- Bootstrap stack version number looked up",
|
|
673
|
-
"remarks": "- If this value is not set, the bootstrap stack name must be known at\n deployment time so the stack version can be looked up from the stack\n outputs.\n- If this value is set, the bootstrap stack can have any name because\n we won't need to look it up.",
|
|
674
672
|
"stability": "stable",
|
|
675
|
-
"summary": "
|
|
673
|
+
"summary": "Filename of the asset manifest."
|
|
676
674
|
},
|
|
677
675
|
"immutable": true,
|
|
678
676
|
"locationInModule": {
|
|
679
677
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
680
|
-
"line":
|
|
678
|
+
"line": 143
|
|
681
679
|
},
|
|
682
|
-
"name": "
|
|
683
|
-
"optional": true,
|
|
680
|
+
"name": "file",
|
|
684
681
|
"type": {
|
|
685
682
|
"primitive": "string"
|
|
686
683
|
}
|
|
@@ -688,15 +685,18 @@
|
|
|
688
685
|
{
|
|
689
686
|
"abstract": true,
|
|
690
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.",
|
|
691
690
|
"stability": "stable",
|
|
692
|
-
"summary": "
|
|
691
|
+
"summary": "SSM parameter where the bootstrap stack version number can be found."
|
|
693
692
|
},
|
|
694
693
|
"immutable": true,
|
|
695
694
|
"locationInModule": {
|
|
696
695
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
697
|
-
"line":
|
|
696
|
+
"line": 163
|
|
698
697
|
},
|
|
699
|
-
"name": "
|
|
698
|
+
"name": "bootstrapStackVersionSsmParameter",
|
|
699
|
+
"optional": true,
|
|
700
700
|
"type": {
|
|
701
701
|
"primitive": "string"
|
|
702
702
|
}
|
|
@@ -711,7 +711,7 @@
|
|
|
711
711
|
"immutable": true,
|
|
712
712
|
"locationInModule": {
|
|
713
713
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
714
|
-
"line":
|
|
714
|
+
"line": 150
|
|
715
715
|
},
|
|
716
716
|
"name": "requiresBootstrapStackVersion",
|
|
717
717
|
"optional": true,
|
|
@@ -728,7 +728,7 @@
|
|
|
728
728
|
"docs": {
|
|
729
729
|
"stability": "stable",
|
|
730
730
|
"summary": "Query to availability zone context provider.",
|
|
731
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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
732
|
"custom": {
|
|
733
733
|
"exampleMetadata": "fixture=_generated"
|
|
734
734
|
}
|
|
@@ -760,17 +760,15 @@
|
|
|
760
760
|
{
|
|
761
761
|
"abstract": true,
|
|
762
762
|
"docs": {
|
|
763
|
-
"default": "- None",
|
|
764
763
|
"stability": "stable",
|
|
765
|
-
"summary": "
|
|
764
|
+
"summary": "Query region."
|
|
766
765
|
},
|
|
767
766
|
"immutable": true,
|
|
768
767
|
"locationInModule": {
|
|
769
768
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
770
|
-
"line":
|
|
769
|
+
"line": 104
|
|
771
770
|
},
|
|
772
|
-
"name": "
|
|
773
|
-
"optional": true,
|
|
771
|
+
"name": "region",
|
|
774
772
|
"type": {
|
|
775
773
|
"primitive": "string"
|
|
776
774
|
}
|
|
@@ -778,15 +776,17 @@
|
|
|
778
776
|
{
|
|
779
777
|
"abstract": true,
|
|
780
778
|
"docs": {
|
|
779
|
+
"default": "- None",
|
|
781
780
|
"stability": "stable",
|
|
782
|
-
"summary": "
|
|
781
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
783
782
|
},
|
|
784
783
|
"immutable": true,
|
|
785
784
|
"locationInModule": {
|
|
786
785
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
787
|
-
"line":
|
|
786
|
+
"line": 111
|
|
788
787
|
},
|
|
789
|
-
"name": "
|
|
788
|
+
"name": "lookupRoleArn",
|
|
789
|
+
"optional": true,
|
|
790
790
|
"type": {
|
|
791
791
|
"primitive": "string"
|
|
792
792
|
}
|
|
@@ -800,7 +800,7 @@
|
|
|
800
800
|
"docs": {
|
|
801
801
|
"stability": "stable",
|
|
802
802
|
"summary": "Artifact properties for CloudFormation stacks.",
|
|
803
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
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 lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\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
804
|
"custom": {
|
|
805
805
|
"exampleMetadata": "fixture=_generated"
|
|
806
806
|
}
|
|
@@ -809,10 +809,26 @@
|
|
|
809
809
|
"kind": "interface",
|
|
810
810
|
"locationInModule": {
|
|
811
811
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
812
|
-
"line":
|
|
812
|
+
"line": 38
|
|
813
813
|
},
|
|
814
814
|
"name": "AwsCloudFormationStackProperties",
|
|
815
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": 42
|
|
826
|
+
},
|
|
827
|
+
"name": "templateFile",
|
|
828
|
+
"type": {
|
|
829
|
+
"primitive": "string"
|
|
830
|
+
}
|
|
831
|
+
},
|
|
816
832
|
{
|
|
817
833
|
"abstract": true,
|
|
818
834
|
"docs": {
|
|
@@ -823,7 +839,7 @@
|
|
|
823
839
|
"immutable": true,
|
|
824
840
|
"locationInModule": {
|
|
825
841
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
826
|
-
"line":
|
|
842
|
+
"line": 76
|
|
827
843
|
},
|
|
828
844
|
"name": "assumeRoleArn",
|
|
829
845
|
"optional": true,
|
|
@@ -841,7 +857,7 @@
|
|
|
841
857
|
"immutable": true,
|
|
842
858
|
"locationInModule": {
|
|
843
859
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
844
|
-
"line":
|
|
860
|
+
"line": 83
|
|
845
861
|
},
|
|
846
862
|
"name": "assumeRoleExternalId",
|
|
847
863
|
"optional": true,
|
|
@@ -860,7 +876,7 @@
|
|
|
860
876
|
"immutable": true,
|
|
861
877
|
"locationInModule": {
|
|
862
878
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
863
|
-
"line":
|
|
879
|
+
"line": 126
|
|
864
880
|
},
|
|
865
881
|
"name": "bootstrapStackVersionSsmParameter",
|
|
866
882
|
"optional": true,
|
|
@@ -878,7 +894,7 @@
|
|
|
878
894
|
"immutable": true,
|
|
879
895
|
"locationInModule": {
|
|
880
896
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
881
|
-
"line":
|
|
897
|
+
"line": 90
|
|
882
898
|
},
|
|
883
899
|
"name": "cloudFormationExecutionRoleArn",
|
|
884
900
|
"optional": true,
|
|
@@ -886,6 +902,24 @@
|
|
|
886
902
|
"primitive": "string"
|
|
887
903
|
}
|
|
888
904
|
},
|
|
905
|
+
{
|
|
906
|
+
"abstract": true,
|
|
907
|
+
"docs": {
|
|
908
|
+
"default": "- No role is assumed (current credentials are used)",
|
|
909
|
+
"stability": "stable",
|
|
910
|
+
"summary": "The role to use to look up values from the target AWS account."
|
|
911
|
+
},
|
|
912
|
+
"immutable": true,
|
|
913
|
+
"locationInModule": {
|
|
914
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
915
|
+
"line": 97
|
|
916
|
+
},
|
|
917
|
+
"name": "lookupRole",
|
|
918
|
+
"optional": true,
|
|
919
|
+
"type": {
|
|
920
|
+
"fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole"
|
|
921
|
+
}
|
|
922
|
+
},
|
|
889
923
|
{
|
|
890
924
|
"abstract": true,
|
|
891
925
|
"docs": {
|
|
@@ -896,7 +930,7 @@
|
|
|
896
930
|
"immutable": true,
|
|
897
931
|
"locationInModule": {
|
|
898
932
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
899
|
-
"line":
|
|
933
|
+
"line": 49
|
|
900
934
|
},
|
|
901
935
|
"name": "parameters",
|
|
902
936
|
"optional": true,
|
|
@@ -919,7 +953,7 @@
|
|
|
919
953
|
"immutable": true,
|
|
920
954
|
"locationInModule": {
|
|
921
955
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
922
|
-
"line":
|
|
956
|
+
"line": 111
|
|
923
957
|
},
|
|
924
958
|
"name": "requiresBootstrapStackVersion",
|
|
925
959
|
"optional": true,
|
|
@@ -937,7 +971,7 @@
|
|
|
937
971
|
"immutable": true,
|
|
938
972
|
"locationInModule": {
|
|
939
973
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
940
|
-
"line":
|
|
974
|
+
"line": 62
|
|
941
975
|
},
|
|
942
976
|
"name": "stackName",
|
|
943
977
|
"optional": true,
|
|
@@ -955,7 +989,7 @@
|
|
|
955
989
|
"immutable": true,
|
|
956
990
|
"locationInModule": {
|
|
957
991
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
958
|
-
"line":
|
|
992
|
+
"line": 104
|
|
959
993
|
},
|
|
960
994
|
"name": "stackTemplateAssetObjectUrl",
|
|
961
995
|
"optional": true,
|
|
@@ -973,7 +1007,7 @@
|
|
|
973
1007
|
"immutable": true,
|
|
974
1008
|
"locationInModule": {
|
|
975
1009
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
976
|
-
"line":
|
|
1010
|
+
"line": 56
|
|
977
1011
|
},
|
|
978
1012
|
"name": "tags",
|
|
979
1013
|
"optional": true,
|
|
@@ -986,22 +1020,6 @@
|
|
|
986
1020
|
}
|
|
987
1021
|
}
|
|
988
1022
|
},
|
|
989
|
-
{
|
|
990
|
-
"abstract": true,
|
|
991
|
-
"docs": {
|
|
992
|
-
"stability": "stable",
|
|
993
|
-
"summary": "A file relative to the assembly root which contains the CloudFormation template for this stack."
|
|
994
|
-
},
|
|
995
|
-
"immutable": true,
|
|
996
|
-
"locationInModule": {
|
|
997
|
-
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
998
|
-
"line": 9
|
|
999
|
-
},
|
|
1000
|
-
"name": "templateFile",
|
|
1001
|
-
"type": {
|
|
1002
|
-
"primitive": "string"
|
|
1003
|
-
}
|
|
1004
|
-
},
|
|
1005
1023
|
{
|
|
1006
1024
|
"abstract": true,
|
|
1007
1025
|
"docs": {
|
|
@@ -1012,7 +1030,7 @@
|
|
|
1012
1030
|
"immutable": true,
|
|
1013
1031
|
"locationInModule": {
|
|
1014
1032
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1015
|
-
"line":
|
|
1033
|
+
"line": 69
|
|
1016
1034
|
},
|
|
1017
1035
|
"name": "terminationProtection",
|
|
1018
1036
|
"optional": true,
|
|
@@ -1030,7 +1048,7 @@
|
|
|
1030
1048
|
"immutable": true,
|
|
1031
1049
|
"locationInModule": {
|
|
1032
1050
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1033
|
-
"line":
|
|
1051
|
+
"line": 133
|
|
1034
1052
|
},
|
|
1035
1053
|
"name": "validateOnSynth",
|
|
1036
1054
|
"optional": true,
|
|
@@ -1047,7 +1065,7 @@
|
|
|
1047
1065
|
"docs": {
|
|
1048
1066
|
"stability": "stable",
|
|
1049
1067
|
"summary": "Destination for assets that need to be uploaded to AWS.",
|
|
1050
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1068
|
+
"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
1069
|
"custom": {
|
|
1052
1070
|
"exampleMetadata": "fixture=_generated"
|
|
1053
1071
|
}
|
|
@@ -1117,13 +1135,105 @@
|
|
|
1117
1135
|
],
|
|
1118
1136
|
"symbolId": "lib/assets/aws-destination:AwsDestination"
|
|
1119
1137
|
},
|
|
1138
|
+
"@aws-cdk/cloud-assembly-schema.BootstrapRole": {
|
|
1139
|
+
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
1140
|
+
"datatype": true,
|
|
1141
|
+
"docs": {
|
|
1142
|
+
"stability": "stable",
|
|
1143
|
+
"summary": "Information needed to access an IAM role created as part of the bootstrap process.",
|
|
1144
|
+
"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 bootstrapRole: cloud_assembly_schema.BootstrapRole = {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
|
|
1145
|
+
"custom": {
|
|
1146
|
+
"exampleMetadata": "fixture=_generated"
|
|
1147
|
+
}
|
|
1148
|
+
},
|
|
1149
|
+
"fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole",
|
|
1150
|
+
"kind": "interface",
|
|
1151
|
+
"locationInModule": {
|
|
1152
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1153
|
+
"line": 6
|
|
1154
|
+
},
|
|
1155
|
+
"name": "BootstrapRole",
|
|
1156
|
+
"properties": [
|
|
1157
|
+
{
|
|
1158
|
+
"abstract": true,
|
|
1159
|
+
"docs": {
|
|
1160
|
+
"stability": "stable",
|
|
1161
|
+
"summary": "The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn."
|
|
1162
|
+
},
|
|
1163
|
+
"immutable": true,
|
|
1164
|
+
"locationInModule": {
|
|
1165
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1166
|
+
"line": 11
|
|
1167
|
+
},
|
|
1168
|
+
"name": "arn",
|
|
1169
|
+
"type": {
|
|
1170
|
+
"primitive": "string"
|
|
1171
|
+
}
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
"abstract": true,
|
|
1175
|
+
"docs": {
|
|
1176
|
+
"default": "- No external ID",
|
|
1177
|
+
"stability": "stable",
|
|
1178
|
+
"summary": "External ID to use when assuming the bootstrap role."
|
|
1179
|
+
},
|
|
1180
|
+
"immutable": true,
|
|
1181
|
+
"locationInModule": {
|
|
1182
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1183
|
+
"line": 18
|
|
1184
|
+
},
|
|
1185
|
+
"name": "assumeRoleExternalId",
|
|
1186
|
+
"optional": true,
|
|
1187
|
+
"type": {
|
|
1188
|
+
"primitive": "string"
|
|
1189
|
+
}
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
"abstract": true,
|
|
1193
|
+
"docs": {
|
|
1194
|
+
"default": "- Discover SSM parameter by reading stack",
|
|
1195
|
+
"stability": "stable",
|
|
1196
|
+
"summary": "Name of SSM parameter with bootstrap stack version."
|
|
1197
|
+
},
|
|
1198
|
+
"immutable": true,
|
|
1199
|
+
"locationInModule": {
|
|
1200
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1201
|
+
"line": 32
|
|
1202
|
+
},
|
|
1203
|
+
"name": "bootstrapStackVersionSsmParameter",
|
|
1204
|
+
"optional": true,
|
|
1205
|
+
"type": {
|
|
1206
|
+
"primitive": "string"
|
|
1207
|
+
}
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
"abstract": true,
|
|
1211
|
+
"docs": {
|
|
1212
|
+
"default": "- No bootstrap stack required",
|
|
1213
|
+
"stability": "stable",
|
|
1214
|
+
"summary": "Version of bootstrap stack required to use this role."
|
|
1215
|
+
},
|
|
1216
|
+
"immutable": true,
|
|
1217
|
+
"locationInModule": {
|
|
1218
|
+
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
1219
|
+
"line": 25
|
|
1220
|
+
},
|
|
1221
|
+
"name": "requiresBootstrapStackVersion",
|
|
1222
|
+
"optional": true,
|
|
1223
|
+
"type": {
|
|
1224
|
+
"primitive": "number"
|
|
1225
|
+
}
|
|
1226
|
+
}
|
|
1227
|
+
],
|
|
1228
|
+
"symbolId": "lib/cloud-assembly/artifact-schema:BootstrapRole"
|
|
1229
|
+
},
|
|
1120
1230
|
"@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry": {
|
|
1121
1231
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
1122
1232
|
"datatype": true,
|
|
1123
1233
|
"docs": {
|
|
1124
1234
|
"stability": "stable",
|
|
1125
1235
|
"summary": "Metadata Entry spec for container images.",
|
|
1126
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1236
|
+
"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
1237
|
"custom": {
|
|
1128
1238
|
"exampleMetadata": "fixture=_generated"
|
|
1129
1239
|
}
|
|
@@ -1139,40 +1249,31 @@
|
|
|
1139
1249
|
{
|
|
1140
1250
|
"abstract": true,
|
|
1141
1251
|
"docs": {
|
|
1142
|
-
"default": "no build args are passed",
|
|
1143
1252
|
"stability": "stable",
|
|
1144
|
-
"summary": "
|
|
1253
|
+
"summary": "Logical identifier for the asset."
|
|
1145
1254
|
},
|
|
1146
1255
|
"immutable": true,
|
|
1147
1256
|
"locationInModule": {
|
|
1148
1257
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1149
|
-
"line":
|
|
1258
|
+
"line": 13
|
|
1150
1259
|
},
|
|
1151
|
-
"name": "
|
|
1152
|
-
"optional": true,
|
|
1260
|
+
"name": "id",
|
|
1153
1261
|
"type": {
|
|
1154
|
-
"
|
|
1155
|
-
"elementtype": {
|
|
1156
|
-
"primitive": "string"
|
|
1157
|
-
},
|
|
1158
|
-
"kind": "map"
|
|
1159
|
-
}
|
|
1262
|
+
"primitive": "string"
|
|
1160
1263
|
}
|
|
1161
1264
|
},
|
|
1162
1265
|
{
|
|
1163
1266
|
"abstract": true,
|
|
1164
1267
|
"docs": {
|
|
1165
|
-
"default": "- no file is passed",
|
|
1166
1268
|
"stability": "stable",
|
|
1167
|
-
"summary": "
|
|
1269
|
+
"summary": "Type of asset."
|
|
1168
1270
|
},
|
|
1169
1271
|
"immutable": true,
|
|
1170
1272
|
"locationInModule": {
|
|
1171
1273
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1172
|
-
"line":
|
|
1274
|
+
"line": 81
|
|
1173
1275
|
},
|
|
1174
|
-
"name": "
|
|
1175
|
-
"optional": true,
|
|
1276
|
+
"name": "packaging",
|
|
1176
1277
|
"type": {
|
|
1177
1278
|
"primitive": "string"
|
|
1178
1279
|
}
|
|
@@ -1181,14 +1282,14 @@
|
|
|
1181
1282
|
"abstract": true,
|
|
1182
1283
|
"docs": {
|
|
1183
1284
|
"stability": "stable",
|
|
1184
|
-
"summary": "
|
|
1285
|
+
"summary": "Path on disk to the asset."
|
|
1185
1286
|
},
|
|
1186
1287
|
"immutable": true,
|
|
1187
1288
|
"locationInModule": {
|
|
1188
1289
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1189
|
-
"line":
|
|
1290
|
+
"line": 23
|
|
1190
1291
|
},
|
|
1191
|
-
"name": "
|
|
1292
|
+
"name": "path",
|
|
1192
1293
|
"type": {
|
|
1193
1294
|
"primitive": "string"
|
|
1194
1295
|
}
|
|
@@ -1196,18 +1297,15 @@
|
|
|
1196
1297
|
{
|
|
1197
1298
|
"abstract": true,
|
|
1198
1299
|
"docs": {
|
|
1199
|
-
"
|
|
1200
|
-
"
|
|
1201
|
-
"stability": "deprecated",
|
|
1202
|
-
"summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
|
|
1300
|
+
"stability": "stable",
|
|
1301
|
+
"summary": "The hash of the asset source."
|
|
1203
1302
|
},
|
|
1204
1303
|
"immutable": true,
|
|
1205
1304
|
"locationInModule": {
|
|
1206
1305
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1207
|
-
"line":
|
|
1306
|
+
"line": 18
|
|
1208
1307
|
},
|
|
1209
|
-
"name": "
|
|
1210
|
-
"optional": true,
|
|
1308
|
+
"name": "sourceHash",
|
|
1211
1309
|
"type": {
|
|
1212
1310
|
"primitive": "string"
|
|
1213
1311
|
}
|
|
@@ -1215,34 +1313,40 @@
|
|
|
1215
1313
|
{
|
|
1216
1314
|
"abstract": true,
|
|
1217
1315
|
"docs": {
|
|
1218
|
-
"default": "
|
|
1219
|
-
"remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
|
|
1316
|
+
"default": "no build args are passed",
|
|
1220
1317
|
"stability": "stable",
|
|
1221
|
-
"summary": "
|
|
1318
|
+
"summary": "Build args to pass to the `docker build` command."
|
|
1222
1319
|
},
|
|
1223
1320
|
"immutable": true,
|
|
1224
1321
|
"locationInModule": {
|
|
1225
1322
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1226
|
-
"line":
|
|
1323
|
+
"line": 119
|
|
1227
1324
|
},
|
|
1228
|
-
"name": "
|
|
1325
|
+
"name": "buildArgs",
|
|
1229
1326
|
"optional": true,
|
|
1230
1327
|
"type": {
|
|
1231
|
-
"
|
|
1328
|
+
"collection": {
|
|
1329
|
+
"elementtype": {
|
|
1330
|
+
"primitive": "string"
|
|
1331
|
+
},
|
|
1332
|
+
"kind": "map"
|
|
1333
|
+
}
|
|
1232
1334
|
}
|
|
1233
1335
|
},
|
|
1234
1336
|
{
|
|
1235
1337
|
"abstract": true,
|
|
1236
1338
|
"docs": {
|
|
1339
|
+
"default": "- no file is passed",
|
|
1237
1340
|
"stability": "stable",
|
|
1238
|
-
"summary": "
|
|
1341
|
+
"summary": "Path to the Dockerfile (relative to the directory)."
|
|
1239
1342
|
},
|
|
1240
1343
|
"immutable": true,
|
|
1241
1344
|
"locationInModule": {
|
|
1242
1345
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1243
|
-
"line":
|
|
1346
|
+
"line": 133
|
|
1244
1347
|
},
|
|
1245
|
-
"name": "
|
|
1348
|
+
"name": "file",
|
|
1349
|
+
"optional": true,
|
|
1246
1350
|
"type": {
|
|
1247
1351
|
"primitive": "string"
|
|
1248
1352
|
}
|
|
@@ -1250,15 +1354,18 @@
|
|
|
1250
1354
|
{
|
|
1251
1355
|
"abstract": true,
|
|
1252
1356
|
"docs": {
|
|
1253
|
-
"
|
|
1254
|
-
"
|
|
1357
|
+
"default": "undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?",
|
|
1358
|
+
"deprecated": "specify `repositoryName` and `imageTag` instead, and then you\nknow where the image will go.",
|
|
1359
|
+
"stability": "deprecated",
|
|
1360
|
+
"summary": "ECR Repository name and repo digest (separated by \"@sha256:\") where this image is stored."
|
|
1255
1361
|
},
|
|
1256
1362
|
"immutable": true,
|
|
1257
1363
|
"locationInModule": {
|
|
1258
1364
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1259
|
-
"line":
|
|
1365
|
+
"line": 93
|
|
1260
1366
|
},
|
|
1261
|
-
"name": "
|
|
1367
|
+
"name": "imageNameParameter",
|
|
1368
|
+
"optional": true,
|
|
1262
1369
|
"type": {
|
|
1263
1370
|
"primitive": "string"
|
|
1264
1371
|
}
|
|
@@ -1267,16 +1374,16 @@
|
|
|
1267
1374
|
"abstract": true,
|
|
1268
1375
|
"docs": {
|
|
1269
1376
|
"default": "- this parameter is REQUIRED after 1.21.0",
|
|
1270
|
-
"remarks": "
|
|
1377
|
+
"remarks": "This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image).",
|
|
1271
1378
|
"stability": "stable",
|
|
1272
|
-
"summary": "
|
|
1379
|
+
"summary": "The docker image tag to use for tagging pushed images."
|
|
1273
1380
|
},
|
|
1274
1381
|
"immutable": true,
|
|
1275
1382
|
"locationInModule": {
|
|
1276
1383
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1277
|
-
"line":
|
|
1384
|
+
"line": 112
|
|
1278
1385
|
},
|
|
1279
|
-
"name": "
|
|
1386
|
+
"name": "imageTag",
|
|
1280
1387
|
"optional": true,
|
|
1281
1388
|
"type": {
|
|
1282
1389
|
"primitive": "string"
|
|
@@ -1285,15 +1392,18 @@
|
|
|
1285
1392
|
{
|
|
1286
1393
|
"abstract": true,
|
|
1287
1394
|
"docs": {
|
|
1395
|
+
"default": "- this parameter is REQUIRED after 1.21.0",
|
|
1396
|
+
"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.",
|
|
1288
1397
|
"stability": "stable",
|
|
1289
|
-
"summary": "
|
|
1398
|
+
"summary": "ECR repository name, if omitted a default name based on the asset's ID is used instead."
|
|
1290
1399
|
},
|
|
1291
1400
|
"immutable": true,
|
|
1292
1401
|
"locationInModule": {
|
|
1293
1402
|
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
1294
|
-
"line":
|
|
1403
|
+
"line": 103
|
|
1295
1404
|
},
|
|
1296
|
-
"name": "
|
|
1405
|
+
"name": "repositoryName",
|
|
1406
|
+
"optional": true,
|
|
1297
1407
|
"type": {
|
|
1298
1408
|
"primitive": "string"
|
|
1299
1409
|
}
|
|
@@ -1349,30 +1459,30 @@
|
|
|
1349
1459
|
{
|
|
1350
1460
|
"docs": {
|
|
1351
1461
|
"stability": "stable",
|
|
1352
|
-
"summary": "
|
|
1462
|
+
"summary": "Route53 Hosted Zone provider."
|
|
1353
1463
|
},
|
|
1354
|
-
"name": "
|
|
1464
|
+
"name": "HOSTED_ZONE_PROVIDER"
|
|
1355
1465
|
},
|
|
1356
1466
|
{
|
|
1357
1467
|
"docs": {
|
|
1358
1468
|
"stability": "stable",
|
|
1359
|
-
"summary": "
|
|
1469
|
+
"summary": "SSM Parameter Provider."
|
|
1360
1470
|
},
|
|
1361
|
-
"name": "
|
|
1471
|
+
"name": "SSM_PARAMETER_PROVIDER"
|
|
1362
1472
|
},
|
|
1363
1473
|
{
|
|
1364
1474
|
"docs": {
|
|
1365
1475
|
"stability": "stable",
|
|
1366
|
-
"summary": "
|
|
1476
|
+
"summary": "VPC Provider."
|
|
1367
1477
|
},
|
|
1368
|
-
"name": "
|
|
1478
|
+
"name": "VPC_PROVIDER"
|
|
1369
1479
|
},
|
|
1370
1480
|
{
|
|
1371
1481
|
"docs": {
|
|
1372
1482
|
"stability": "stable",
|
|
1373
|
-
"summary": "
|
|
1483
|
+
"summary": "VPC Endpoint Service AZ Provider."
|
|
1374
1484
|
},
|
|
1375
|
-
"name": "
|
|
1485
|
+
"name": "ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER"
|
|
1376
1486
|
},
|
|
1377
1487
|
{
|
|
1378
1488
|
"docs": {
|
|
@@ -1384,23 +1494,23 @@
|
|
|
1384
1494
|
{
|
|
1385
1495
|
"docs": {
|
|
1386
1496
|
"stability": "stable",
|
|
1387
|
-
"summary": "
|
|
1497
|
+
"summary": "Load balancer listener provider."
|
|
1388
1498
|
},
|
|
1389
|
-
"name": "
|
|
1499
|
+
"name": "LOAD_BALANCER_LISTENER_PROVIDER"
|
|
1390
1500
|
},
|
|
1391
1501
|
{
|
|
1392
1502
|
"docs": {
|
|
1393
1503
|
"stability": "stable",
|
|
1394
|
-
"summary": "
|
|
1504
|
+
"summary": "Security group provider."
|
|
1395
1505
|
},
|
|
1396
|
-
"name": "
|
|
1506
|
+
"name": "SECURITY_GROUP_PROVIDER"
|
|
1397
1507
|
},
|
|
1398
1508
|
{
|
|
1399
1509
|
"docs": {
|
|
1400
1510
|
"stability": "stable",
|
|
1401
|
-
"summary": "
|
|
1511
|
+
"summary": "KMS Key Provider."
|
|
1402
1512
|
},
|
|
1403
|
-
"name": "
|
|
1513
|
+
"name": "KEY_PROVIDER"
|
|
1404
1514
|
}
|
|
1405
1515
|
],
|
|
1406
1516
|
"name": "ContextProvider",
|
|
@@ -1412,7 +1522,7 @@
|
|
|
1412
1522
|
"docs": {
|
|
1413
1523
|
"stability": "stable",
|
|
1414
1524
|
"summary": "A file asset.",
|
|
1415
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1525
|
+
"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
1526
|
"custom": {
|
|
1417
1527
|
"exampleMetadata": "fixture=_generated"
|
|
1418
1528
|
}
|
|
@@ -1471,7 +1581,7 @@
|
|
|
1471
1581
|
"docs": {
|
|
1472
1582
|
"stability": "stable",
|
|
1473
1583
|
"summary": "Where to publish docker images.",
|
|
1474
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1584
|
+
"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
1585
|
"custom": {
|
|
1476
1586
|
"exampleMetadata": "fixture=_generated"
|
|
1477
1587
|
}
|
|
@@ -1528,7 +1638,7 @@
|
|
|
1528
1638
|
"docs": {
|
|
1529
1639
|
"stability": "stable",
|
|
1530
1640
|
"summary": "Properties for how to produce a Docker image from a source.",
|
|
1531
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1641
|
+
"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
1642
|
"custom": {
|
|
1533
1643
|
"exampleMetadata": "fixture=_generated"
|
|
1534
1644
|
}
|
|
@@ -1654,7 +1764,7 @@
|
|
|
1654
1764
|
"docs": {
|
|
1655
1765
|
"stability": "stable",
|
|
1656
1766
|
"summary": "Query to endpoint service context provider.",
|
|
1657
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1767
|
+
"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
1768
|
"custom": {
|
|
1659
1769
|
"exampleMetadata": "fixture=_generated"
|
|
1660
1770
|
}
|
|
@@ -1677,26 +1787,8 @@
|
|
|
1677
1787
|
"locationInModule": {
|
|
1678
1788
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
1679
1789
|
"line": 242
|
|
1680
|
-
},
|
|
1681
|
-
"name": "account",
|
|
1682
|
-
"type": {
|
|
1683
|
-
"primitive": "string"
|
|
1684
|
-
}
|
|
1685
|
-
},
|
|
1686
|
-
{
|
|
1687
|
-
"abstract": true,
|
|
1688
|
-
"docs": {
|
|
1689
|
-
"default": "- None",
|
|
1690
|
-
"stability": "stable",
|
|
1691
|
-
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
1692
|
-
},
|
|
1693
|
-
"immutable": true,
|
|
1694
|
-
"locationInModule": {
|
|
1695
|
-
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
1696
|
-
"line": 254
|
|
1697
|
-
},
|
|
1698
|
-
"name": "lookupRoleArn",
|
|
1699
|
-
"optional": true,
|
|
1790
|
+
},
|
|
1791
|
+
"name": "account",
|
|
1700
1792
|
"type": {
|
|
1701
1793
|
"primitive": "string"
|
|
1702
1794
|
}
|
|
@@ -1732,6 +1824,24 @@
|
|
|
1732
1824
|
"type": {
|
|
1733
1825
|
"primitive": "string"
|
|
1734
1826
|
}
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"abstract": true,
|
|
1830
|
+
"docs": {
|
|
1831
|
+
"default": "- None",
|
|
1832
|
+
"stability": "stable",
|
|
1833
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
1834
|
+
},
|
|
1835
|
+
"immutable": true,
|
|
1836
|
+
"locationInModule": {
|
|
1837
|
+
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
1838
|
+
"line": 254
|
|
1839
|
+
},
|
|
1840
|
+
"name": "lookupRoleArn",
|
|
1841
|
+
"optional": true,
|
|
1842
|
+
"type": {
|
|
1843
|
+
"primitive": "string"
|
|
1844
|
+
}
|
|
1735
1845
|
}
|
|
1736
1846
|
],
|
|
1737
1847
|
"symbolId": "lib/cloud-assembly/context-queries:EndpointServiceAvailabilityZonesContextQuery"
|
|
@@ -1742,7 +1852,7 @@
|
|
|
1742
1852
|
"docs": {
|
|
1743
1853
|
"stability": "stable",
|
|
1744
1854
|
"summary": "A file asset.",
|
|
1745
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1855
|
+
"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
1856
|
"custom": {
|
|
1747
1857
|
"exampleMetadata": "fixture=_generated"
|
|
1748
1858
|
}
|
|
@@ -1801,7 +1911,7 @@
|
|
|
1801
1911
|
"docs": {
|
|
1802
1912
|
"stability": "stable",
|
|
1803
1913
|
"summary": "Metadata Entry spec for files.",
|
|
1804
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
1914
|
+
"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
1915
|
"custom": {
|
|
1806
1916
|
"exampleMetadata": "fixture=_generated"
|
|
1807
1917
|
}
|
|
@@ -1966,7 +2076,7 @@
|
|
|
1966
2076
|
"docs": {
|
|
1967
2077
|
"stability": "stable",
|
|
1968
2078
|
"summary": "Where in S3 a file asset needs to be published.",
|
|
1969
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2079
|
+
"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
2080
|
"custom": {
|
|
1971
2081
|
"exampleMetadata": "fixture=_generated"
|
|
1972
2082
|
}
|
|
@@ -2023,7 +2133,7 @@
|
|
|
2023
2133
|
"docs": {
|
|
2024
2134
|
"stability": "stable",
|
|
2025
2135
|
"summary": "Describe the source of a file asset.",
|
|
2026
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2136
|
+
"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
2137
|
"custom": {
|
|
2028
2138
|
"exampleMetadata": "fixture=_generated"
|
|
2029
2139
|
}
|
|
@@ -2106,7 +2216,7 @@
|
|
|
2106
2216
|
"docs": {
|
|
2107
2217
|
"stability": "stable",
|
|
2108
2218
|
"summary": "Query to hosted zone context provider.",
|
|
2109
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2219
|
+
"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
2220
|
"custom": {
|
|
2111
2221
|
"exampleMetadata": "fixture=_generated"
|
|
2112
2222
|
}
|
|
@@ -2154,17 +2264,15 @@
|
|
|
2154
2264
|
{
|
|
2155
2265
|
"abstract": true,
|
|
2156
2266
|
"docs": {
|
|
2157
|
-
"default": "- None",
|
|
2158
2267
|
"stability": "stable",
|
|
2159
|
-
"summary": "
|
|
2268
|
+
"summary": "Query region."
|
|
2160
2269
|
},
|
|
2161
2270
|
"immutable": true,
|
|
2162
2271
|
"locationInModule": {
|
|
2163
2272
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2164
|
-
"line":
|
|
2273
|
+
"line": 127
|
|
2165
2274
|
},
|
|
2166
|
-
"name": "
|
|
2167
|
-
"optional": true,
|
|
2275
|
+
"name": "region",
|
|
2168
2276
|
"type": {
|
|
2169
2277
|
"primitive": "string"
|
|
2170
2278
|
}
|
|
@@ -2172,35 +2280,37 @@
|
|
|
2172
2280
|
{
|
|
2173
2281
|
"abstract": true,
|
|
2174
2282
|
"docs": {
|
|
2175
|
-
"default": "
|
|
2283
|
+
"default": "- None",
|
|
2176
2284
|
"stability": "stable",
|
|
2177
|
-
"summary": "
|
|
2285
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
2178
2286
|
},
|
|
2179
2287
|
"immutable": true,
|
|
2180
2288
|
"locationInModule": {
|
|
2181
2289
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2182
|
-
"line":
|
|
2290
|
+
"line": 134
|
|
2183
2291
|
},
|
|
2184
|
-
"name": "
|
|
2292
|
+
"name": "lookupRoleArn",
|
|
2185
2293
|
"optional": true,
|
|
2186
2294
|
"type": {
|
|
2187
|
-
"primitive": "
|
|
2295
|
+
"primitive": "string"
|
|
2188
2296
|
}
|
|
2189
2297
|
},
|
|
2190
2298
|
{
|
|
2191
2299
|
"abstract": true,
|
|
2192
2300
|
"docs": {
|
|
2301
|
+
"default": "false",
|
|
2193
2302
|
"stability": "stable",
|
|
2194
|
-
"summary": "
|
|
2303
|
+
"summary": "True if the zone you want to find is a private hosted zone."
|
|
2195
2304
|
},
|
|
2196
2305
|
"immutable": true,
|
|
2197
2306
|
"locationInModule": {
|
|
2198
2307
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2199
|
-
"line":
|
|
2308
|
+
"line": 146
|
|
2200
2309
|
},
|
|
2201
|
-
"name": "
|
|
2310
|
+
"name": "privateZone",
|
|
2311
|
+
"optional": true,
|
|
2202
2312
|
"type": {
|
|
2203
|
-
"primitive": "
|
|
2313
|
+
"primitive": "boolean"
|
|
2204
2314
|
}
|
|
2205
2315
|
},
|
|
2206
2316
|
{
|
|
@@ -2231,7 +2341,7 @@
|
|
|
2231
2341
|
"docs": {
|
|
2232
2342
|
"stability": "stable",
|
|
2233
2343
|
"summary": "Query input for looking up a KMS Key.",
|
|
2234
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2344
|
+
"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
2345
|
"custom": {
|
|
2236
2346
|
"exampleMetadata": "fixture=_generated"
|
|
2237
2347
|
}
|
|
@@ -2279,17 +2389,15 @@
|
|
|
2279
2389
|
{
|
|
2280
2390
|
"abstract": true,
|
|
2281
2391
|
"docs": {
|
|
2282
|
-
"default": "- None",
|
|
2283
2392
|
"stability": "stable",
|
|
2284
|
-
"summary": "
|
|
2393
|
+
"summary": "Query region."
|
|
2285
2394
|
},
|
|
2286
2395
|
"immutable": true,
|
|
2287
2396
|
"locationInModule": {
|
|
2288
2397
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2289
|
-
"line":
|
|
2398
|
+
"line": 451
|
|
2290
2399
|
},
|
|
2291
|
-
"name": "
|
|
2292
|
-
"optional": true,
|
|
2400
|
+
"name": "region",
|
|
2293
2401
|
"type": {
|
|
2294
2402
|
"primitive": "string"
|
|
2295
2403
|
}
|
|
@@ -2297,15 +2405,17 @@
|
|
|
2297
2405
|
{
|
|
2298
2406
|
"abstract": true,
|
|
2299
2407
|
"docs": {
|
|
2408
|
+
"default": "- None",
|
|
2300
2409
|
"stability": "stable",
|
|
2301
|
-
"summary": "
|
|
2410
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
2302
2411
|
},
|
|
2303
2412
|
"immutable": true,
|
|
2304
2413
|
"locationInModule": {
|
|
2305
2414
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2306
|
-
"line":
|
|
2415
|
+
"line": 458
|
|
2307
2416
|
},
|
|
2308
|
-
"name": "
|
|
2417
|
+
"name": "lookupRoleArn",
|
|
2418
|
+
"optional": true,
|
|
2309
2419
|
"type": {
|
|
2310
2420
|
"primitive": "string"
|
|
2311
2421
|
}
|
|
@@ -2319,7 +2429,7 @@
|
|
|
2319
2429
|
"docs": {
|
|
2320
2430
|
"stability": "stable",
|
|
2321
2431
|
"summary": "Query input for looking up a load balancer.",
|
|
2322
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2432
|
+
"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
2433
|
"custom": {
|
|
2324
2434
|
"exampleMetadata": "fixture=_generated"
|
|
2325
2435
|
}
|
|
@@ -2354,17 +2464,15 @@
|
|
|
2354
2464
|
{
|
|
2355
2465
|
"abstract": true,
|
|
2356
2466
|
"docs": {
|
|
2357
|
-
"default": "- None",
|
|
2358
2467
|
"stability": "stable",
|
|
2359
|
-
"summary": "
|
|
2468
|
+
"summary": "Query region."
|
|
2360
2469
|
},
|
|
2361
2470
|
"immutable": true,
|
|
2362
2471
|
"locationInModule": {
|
|
2363
2472
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2364
|
-
"line":
|
|
2473
|
+
"line": 311
|
|
2365
2474
|
},
|
|
2366
|
-
"name": "
|
|
2367
|
-
"optional": true,
|
|
2475
|
+
"name": "region",
|
|
2368
2476
|
"type": {
|
|
2369
2477
|
"primitive": "string"
|
|
2370
2478
|
}
|
|
@@ -2372,15 +2480,17 @@
|
|
|
2372
2480
|
{
|
|
2373
2481
|
"abstract": true,
|
|
2374
2482
|
"docs": {
|
|
2483
|
+
"default": "- None",
|
|
2375
2484
|
"stability": "stable",
|
|
2376
|
-
"summary": "
|
|
2485
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
2377
2486
|
},
|
|
2378
2487
|
"immutable": true,
|
|
2379
2488
|
"locationInModule": {
|
|
2380
2489
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2381
|
-
"line":
|
|
2490
|
+
"line": 318
|
|
2382
2491
|
},
|
|
2383
|
-
"name": "
|
|
2492
|
+
"name": "lookupRoleArn",
|
|
2493
|
+
"optional": true,
|
|
2384
2494
|
"type": {
|
|
2385
2495
|
"primitive": "string"
|
|
2386
2496
|
}
|
|
@@ -2394,7 +2504,7 @@
|
|
|
2394
2504
|
"docs": {
|
|
2395
2505
|
"stability": "stable",
|
|
2396
2506
|
"summary": "Filters for selecting load balancers.",
|
|
2397
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2507
|
+
"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
2508
|
"custom": {
|
|
2399
2509
|
"exampleMetadata": "fixture=_generated"
|
|
2400
2510
|
}
|
|
@@ -2407,6 +2517,22 @@
|
|
|
2407
2517
|
},
|
|
2408
2518
|
"name": "LoadBalancerFilter",
|
|
2409
2519
|
"properties": [
|
|
2520
|
+
{
|
|
2521
|
+
"abstract": true,
|
|
2522
|
+
"docs": {
|
|
2523
|
+
"stability": "stable",
|
|
2524
|
+
"summary": "Filter load balancers by their type."
|
|
2525
|
+
},
|
|
2526
|
+
"immutable": true,
|
|
2527
|
+
"locationInModule": {
|
|
2528
|
+
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2529
|
+
"line": 284
|
|
2530
|
+
},
|
|
2531
|
+
"name": "loadBalancerType",
|
|
2532
|
+
"type": {
|
|
2533
|
+
"fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
|
|
2534
|
+
}
|
|
2535
|
+
},
|
|
2410
2536
|
{
|
|
2411
2537
|
"abstract": true,
|
|
2412
2538
|
"docs": {
|
|
@@ -2447,22 +2573,6 @@
|
|
|
2447
2573
|
"kind": "array"
|
|
2448
2574
|
}
|
|
2449
2575
|
}
|
|
2450
|
-
},
|
|
2451
|
-
{
|
|
2452
|
-
"abstract": true,
|
|
2453
|
-
"docs": {
|
|
2454
|
-
"stability": "stable",
|
|
2455
|
-
"summary": "Filter load balancers by their type."
|
|
2456
|
-
},
|
|
2457
|
-
"immutable": true,
|
|
2458
|
-
"locationInModule": {
|
|
2459
|
-
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2460
|
-
"line": 284
|
|
2461
|
-
},
|
|
2462
|
-
"name": "loadBalancerType",
|
|
2463
|
-
"type": {
|
|
2464
|
-
"fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerType"
|
|
2465
|
-
}
|
|
2466
2576
|
}
|
|
2467
2577
|
],
|
|
2468
2578
|
"symbolId": "lib/cloud-assembly/context-queries:LoadBalancerFilter"
|
|
@@ -2473,7 +2583,7 @@
|
|
|
2473
2583
|
"docs": {
|
|
2474
2584
|
"stability": "stable",
|
|
2475
2585
|
"summary": "Query input for looking up a load balancer listener.",
|
|
2476
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
2586
|
+
"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
2587
|
"custom": {
|
|
2478
2588
|
"exampleMetadata": "fixture=_generated"
|
|
2479
2589
|
}
|
|
@@ -2505,6 +2615,22 @@
|
|
|
2505
2615
|
"primitive": "string"
|
|
2506
2616
|
}
|
|
2507
2617
|
},
|
|
2618
|
+
{
|
|
2619
|
+
"abstract": true,
|
|
2620
|
+
"docs": {
|
|
2621
|
+
"stability": "stable",
|
|
2622
|
+
"summary": "Query region."
|
|
2623
|
+
},
|
|
2624
|
+
"immutable": true,
|
|
2625
|
+
"locationInModule": {
|
|
2626
|
+
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2627
|
+
"line": 368
|
|
2628
|
+
},
|
|
2629
|
+
"name": "region",
|
|
2630
|
+
"type": {
|
|
2631
|
+
"primitive": "string"
|
|
2632
|
+
}
|
|
2633
|
+
},
|
|
2508
2634
|
{
|
|
2509
2635
|
"abstract": true,
|
|
2510
2636
|
"docs": {
|
|
@@ -2576,22 +2702,6 @@
|
|
|
2576
2702
|
"type": {
|
|
2577
2703
|
"primitive": "string"
|
|
2578
2704
|
}
|
|
2579
|
-
},
|
|
2580
|
-
{
|
|
2581
|
-
"abstract": true,
|
|
2582
|
-
"docs": {
|
|
2583
|
-
"stability": "stable",
|
|
2584
|
-
"summary": "Query region."
|
|
2585
|
-
},
|
|
2586
|
-
"immutable": true,
|
|
2587
|
-
"locationInModule": {
|
|
2588
|
-
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
2589
|
-
"line": 368
|
|
2590
|
-
},
|
|
2591
|
-
"name": "region",
|
|
2592
|
-
"type": {
|
|
2593
|
-
"primitive": "string"
|
|
2594
|
-
}
|
|
2595
2705
|
}
|
|
2596
2706
|
],
|
|
2597
2707
|
"symbolId": "lib/cloud-assembly/context-queries:LoadBalancerListenerContextQuery"
|
|
@@ -2633,23 +2743,23 @@
|
|
|
2633
2743
|
{
|
|
2634
2744
|
"docs": {
|
|
2635
2745
|
"stability": "stable",
|
|
2636
|
-
"summary": "
|
|
2746
|
+
"summary": "TLS protocol."
|
|
2637
2747
|
},
|
|
2638
|
-
"name": "
|
|
2748
|
+
"name": "TLS"
|
|
2639
2749
|
},
|
|
2640
2750
|
{
|
|
2641
2751
|
"docs": {
|
|
2642
2752
|
"stability": "stable",
|
|
2643
|
-
"summary": "
|
|
2753
|
+
"summary": "UDP protocol."
|
|
2644
2754
|
},
|
|
2645
|
-
"name": "
|
|
2755
|
+
"name": "UDP"
|
|
2646
2756
|
},
|
|
2647
2757
|
{
|
|
2648
2758
|
"docs": {
|
|
2649
2759
|
"stability": "stable",
|
|
2650
|
-
"summary": "UDP protocol."
|
|
2760
|
+
"summary": "TCP and UDP protocol."
|
|
2651
2761
|
},
|
|
2652
|
-
"name": "
|
|
2762
|
+
"name": "TCP_UDP"
|
|
2653
2763
|
}
|
|
2654
2764
|
],
|
|
2655
2765
|
"name": "LoadBalancerListenerProtocol",
|
|
@@ -2671,16 +2781,16 @@
|
|
|
2671
2781
|
{
|
|
2672
2782
|
"docs": {
|
|
2673
2783
|
"stability": "stable",
|
|
2674
|
-
"summary": "
|
|
2784
|
+
"summary": "Network load balancer."
|
|
2675
2785
|
},
|
|
2676
|
-
"name": "
|
|
2786
|
+
"name": "NETWORK"
|
|
2677
2787
|
},
|
|
2678
2788
|
{
|
|
2679
2789
|
"docs": {
|
|
2680
2790
|
"stability": "stable",
|
|
2681
|
-
"summary": "
|
|
2791
|
+
"summary": "Application load balancer."
|
|
2682
2792
|
},
|
|
2683
|
-
"name": "
|
|
2793
|
+
"name": "APPLICATION"
|
|
2684
2794
|
}
|
|
2685
2795
|
],
|
|
2686
2796
|
"name": "LoadBalancerType",
|
|
@@ -2899,7 +3009,7 @@
|
|
|
2899
3009
|
"docs": {
|
|
2900
3010
|
"stability": "stable",
|
|
2901
3011
|
"summary": "A metadata entry in a cloud assembly artifact.",
|
|
2902
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3012
|
+
"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
3013
|
"custom": {
|
|
2904
3014
|
"exampleMetadata": "fixture=_generated"
|
|
2905
3015
|
}
|
|
@@ -2912,6 +3022,22 @@
|
|
|
2912
3022
|
},
|
|
2913
3023
|
"name": "MetadataEntry",
|
|
2914
3024
|
"properties": [
|
|
3025
|
+
{
|
|
3026
|
+
"abstract": true,
|
|
3027
|
+
"docs": {
|
|
3028
|
+
"stability": "stable",
|
|
3029
|
+
"summary": "The type of the metadata entry."
|
|
3030
|
+
},
|
|
3031
|
+
"immutable": true,
|
|
3032
|
+
"locationInModule": {
|
|
3033
|
+
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
3034
|
+
"line": 208
|
|
3035
|
+
},
|
|
3036
|
+
"name": "type",
|
|
3037
|
+
"type": {
|
|
3038
|
+
"primitive": "string"
|
|
3039
|
+
}
|
|
3040
|
+
},
|
|
2915
3041
|
{
|
|
2916
3042
|
"abstract": true,
|
|
2917
3043
|
"docs": {
|
|
@@ -2972,22 +3098,6 @@
|
|
|
2972
3098
|
"kind": "array"
|
|
2973
3099
|
}
|
|
2974
3100
|
}
|
|
2975
|
-
},
|
|
2976
|
-
{
|
|
2977
|
-
"abstract": true,
|
|
2978
|
-
"docs": {
|
|
2979
|
-
"stability": "stable",
|
|
2980
|
-
"summary": "The type of the metadata entry."
|
|
2981
|
-
},
|
|
2982
|
-
"immutable": true,
|
|
2983
|
-
"locationInModule": {
|
|
2984
|
-
"filename": "lib/cloud-assembly/metadata-schema.ts",
|
|
2985
|
-
"line": 208
|
|
2986
|
-
},
|
|
2987
|
-
"name": "type",
|
|
2988
|
-
"type": {
|
|
2989
|
-
"primitive": "string"
|
|
2990
|
-
}
|
|
2991
3101
|
}
|
|
2992
3102
|
],
|
|
2993
3103
|
"symbolId": "lib/cloud-assembly/metadata-schema:MetadataEntry"
|
|
@@ -2998,7 +3108,7 @@
|
|
|
2998
3108
|
"docs": {
|
|
2999
3109
|
"stability": "stable",
|
|
3000
3110
|
"summary": "Represents a missing piece of context.",
|
|
3001
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3111
|
+
"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
3112
|
"custom": {
|
|
3003
3113
|
"exampleMetadata": "fixture=_generated"
|
|
3004
3114
|
}
|
|
@@ -3101,7 +3211,7 @@
|
|
|
3101
3211
|
"docs": {
|
|
3102
3212
|
"stability": "stable",
|
|
3103
3213
|
"summary": "Artifact properties for nested cloud assemblies.",
|
|
3104
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3214
|
+
"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
3215
|
"custom": {
|
|
3106
3216
|
"exampleMetadata": "fixture=_generated"
|
|
3107
3217
|
}
|
|
@@ -3110,7 +3220,7 @@
|
|
|
3110
3220
|
"kind": "interface",
|
|
3111
3221
|
"locationInModule": {
|
|
3112
3222
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
3113
|
-
"line":
|
|
3223
|
+
"line": 179
|
|
3114
3224
|
},
|
|
3115
3225
|
"name": "NestedCloudAssemblyProperties",
|
|
3116
3226
|
"properties": [
|
|
@@ -3123,7 +3233,7 @@
|
|
|
3123
3233
|
"immutable": true,
|
|
3124
3234
|
"locationInModule": {
|
|
3125
3235
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
3126
|
-
"line":
|
|
3236
|
+
"line": 183
|
|
3127
3237
|
},
|
|
3128
3238
|
"name": "directoryName",
|
|
3129
3239
|
"type": {
|
|
@@ -3140,7 +3250,7 @@
|
|
|
3140
3250
|
"immutable": true,
|
|
3141
3251
|
"locationInModule": {
|
|
3142
3252
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
3143
|
-
"line":
|
|
3253
|
+
"line": 190
|
|
3144
3254
|
},
|
|
3145
3255
|
"name": "displayName",
|
|
3146
3256
|
"optional": true,
|
|
@@ -3157,7 +3267,7 @@
|
|
|
3157
3267
|
"docs": {
|
|
3158
3268
|
"stability": "stable",
|
|
3159
3269
|
"summary": "Information about the application's runtime components.",
|
|
3160
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3270
|
+
"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
3271
|
"custom": {
|
|
3162
3272
|
"exampleMetadata": "fixture=_generated"
|
|
3163
3273
|
}
|
|
@@ -3200,7 +3310,7 @@
|
|
|
3200
3310
|
"docs": {
|
|
3201
3311
|
"stability": "stable",
|
|
3202
3312
|
"summary": "Query to SSM Parameter Context Provider.",
|
|
3203
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3313
|
+
"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
3314
|
"custom": {
|
|
3205
3315
|
"exampleMetadata": "fixture=_generated"
|
|
3206
3316
|
}
|
|
@@ -3232,17 +3342,15 @@
|
|
|
3232
3342
|
{
|
|
3233
3343
|
"abstract": true,
|
|
3234
3344
|
"docs": {
|
|
3235
|
-
"default": "- None",
|
|
3236
3345
|
"stability": "stable",
|
|
3237
|
-
"summary": "
|
|
3346
|
+
"summary": "Parameter name to query."
|
|
3238
3347
|
},
|
|
3239
3348
|
"immutable": true,
|
|
3240
3349
|
"locationInModule": {
|
|
3241
3350
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3242
|
-
"line":
|
|
3351
|
+
"line": 183
|
|
3243
3352
|
},
|
|
3244
|
-
"name": "
|
|
3245
|
-
"optional": true,
|
|
3353
|
+
"name": "parameterName",
|
|
3246
3354
|
"type": {
|
|
3247
3355
|
"primitive": "string"
|
|
3248
3356
|
}
|
|
@@ -3251,14 +3359,14 @@
|
|
|
3251
3359
|
"abstract": true,
|
|
3252
3360
|
"docs": {
|
|
3253
3361
|
"stability": "stable",
|
|
3254
|
-
"summary": "
|
|
3362
|
+
"summary": "Query region."
|
|
3255
3363
|
},
|
|
3256
3364
|
"immutable": true,
|
|
3257
3365
|
"locationInModule": {
|
|
3258
3366
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3259
|
-
"line":
|
|
3367
|
+
"line": 171
|
|
3260
3368
|
},
|
|
3261
|
-
"name": "
|
|
3369
|
+
"name": "region",
|
|
3262
3370
|
"type": {
|
|
3263
3371
|
"primitive": "string"
|
|
3264
3372
|
}
|
|
@@ -3266,15 +3374,17 @@
|
|
|
3266
3374
|
{
|
|
3267
3375
|
"abstract": true,
|
|
3268
3376
|
"docs": {
|
|
3377
|
+
"default": "- None",
|
|
3269
3378
|
"stability": "stable",
|
|
3270
|
-
"summary": "
|
|
3379
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
3271
3380
|
},
|
|
3272
3381
|
"immutable": true,
|
|
3273
3382
|
"locationInModule": {
|
|
3274
3383
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3275
|
-
"line":
|
|
3384
|
+
"line": 178
|
|
3276
3385
|
},
|
|
3277
|
-
"name": "
|
|
3386
|
+
"name": "lookupRoleArn",
|
|
3387
|
+
"optional": true,
|
|
3278
3388
|
"type": {
|
|
3279
3389
|
"primitive": "string"
|
|
3280
3390
|
}
|
|
@@ -3288,7 +3398,7 @@
|
|
|
3288
3398
|
"docs": {
|
|
3289
3399
|
"stability": "stable",
|
|
3290
3400
|
"summary": "Query input for looking up a security group.",
|
|
3291
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3401
|
+
"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
3402
|
"custom": {
|
|
3293
3403
|
"exampleMetadata": "fixture=_generated"
|
|
3294
3404
|
}
|
|
@@ -3320,17 +3430,15 @@
|
|
|
3320
3430
|
{
|
|
3321
3431
|
"abstract": true,
|
|
3322
3432
|
"docs": {
|
|
3323
|
-
"default": "- None",
|
|
3324
3433
|
"stability": "stable",
|
|
3325
|
-
"summary": "
|
|
3434
|
+
"summary": "Query region."
|
|
3326
3435
|
},
|
|
3327
3436
|
"immutable": true,
|
|
3328
3437
|
"locationInModule": {
|
|
3329
3438
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3330
|
-
"line":
|
|
3439
|
+
"line": 408
|
|
3331
3440
|
},
|
|
3332
|
-
"name": "
|
|
3333
|
-
"optional": true,
|
|
3441
|
+
"name": "region",
|
|
3334
3442
|
"type": {
|
|
3335
3443
|
"primitive": "string"
|
|
3336
3444
|
}
|
|
@@ -3338,15 +3446,17 @@
|
|
|
3338
3446
|
{
|
|
3339
3447
|
"abstract": true,
|
|
3340
3448
|
"docs": {
|
|
3449
|
+
"default": "- None",
|
|
3341
3450
|
"stability": "stable",
|
|
3342
|
-
"summary": "
|
|
3451
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
3343
3452
|
},
|
|
3344
3453
|
"immutable": true,
|
|
3345
3454
|
"locationInModule": {
|
|
3346
3455
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3347
|
-
"line":
|
|
3456
|
+
"line": 415
|
|
3348
3457
|
},
|
|
3349
|
-
"name": "
|
|
3458
|
+
"name": "lookupRoleArn",
|
|
3459
|
+
"optional": true,
|
|
3350
3460
|
"type": {
|
|
3351
3461
|
"primitive": "string"
|
|
3352
3462
|
}
|
|
@@ -3414,7 +3524,7 @@
|
|
|
3414
3524
|
"docs": {
|
|
3415
3525
|
"stability": "stable",
|
|
3416
3526
|
"summary": "Metadata Entry spec for stack tag.",
|
|
3417
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3527
|
+
"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
3528
|
"custom": {
|
|
3419
3529
|
"exampleMetadata": "fixture=_generated"
|
|
3420
3530
|
}
|
|
@@ -3470,7 +3580,7 @@
|
|
|
3470
3580
|
"docs": {
|
|
3471
3581
|
"stability": "stable",
|
|
3472
3582
|
"summary": "Artifact properties for the Construct Tree Artifact.",
|
|
3473
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3583
|
+
"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
3584
|
"custom": {
|
|
3475
3585
|
"exampleMetadata": "fixture=_generated"
|
|
3476
3586
|
}
|
|
@@ -3479,7 +3589,7 @@
|
|
|
3479
3589
|
"kind": "interface",
|
|
3480
3590
|
"locationInModule": {
|
|
3481
3591
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
3482
|
-
"line":
|
|
3592
|
+
"line": 169
|
|
3483
3593
|
},
|
|
3484
3594
|
"name": "TreeArtifactProperties",
|
|
3485
3595
|
"properties": [
|
|
@@ -3492,7 +3602,7 @@
|
|
|
3492
3602
|
"immutable": true,
|
|
3493
3603
|
"locationInModule": {
|
|
3494
3604
|
"filename": "lib/cloud-assembly/artifact-schema.ts",
|
|
3495
|
-
"line":
|
|
3605
|
+
"line": 173
|
|
3496
3606
|
},
|
|
3497
3607
|
"name": "file",
|
|
3498
3608
|
"type": {
|
|
@@ -3508,7 +3618,7 @@
|
|
|
3508
3618
|
"docs": {
|
|
3509
3619
|
"stability": "stable",
|
|
3510
3620
|
"summary": "Query input for looking up a VPC.",
|
|
3511
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\
|
|
3621
|
+
"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
3622
|
"custom": {
|
|
3513
3623
|
"exampleMetadata": "fixture=_generated"
|
|
3514
3624
|
}
|
|
@@ -3563,17 +3673,15 @@
|
|
|
3563
3673
|
{
|
|
3564
3674
|
"abstract": true,
|
|
3565
3675
|
"docs": {
|
|
3566
|
-
"default": "- None",
|
|
3567
3676
|
"stability": "stable",
|
|
3568
|
-
"summary": "
|
|
3677
|
+
"summary": "Query region."
|
|
3569
3678
|
},
|
|
3570
3679
|
"immutable": true,
|
|
3571
3680
|
"locationInModule": {
|
|
3572
3681
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3573
|
-
"line":
|
|
3682
|
+
"line": 198
|
|
3574
3683
|
},
|
|
3575
|
-
"name": "
|
|
3576
|
-
"optional": true,
|
|
3684
|
+
"name": "region",
|
|
3577
3685
|
"type": {
|
|
3578
3686
|
"primitive": "string"
|
|
3579
3687
|
}
|
|
@@ -3581,15 +3689,17 @@
|
|
|
3581
3689
|
{
|
|
3582
3690
|
"abstract": true,
|
|
3583
3691
|
"docs": {
|
|
3692
|
+
"default": "- None",
|
|
3584
3693
|
"stability": "stable",
|
|
3585
|
-
"summary": "
|
|
3694
|
+
"summary": "The ARN of the role that should be used to look up the missing values."
|
|
3586
3695
|
},
|
|
3587
3696
|
"immutable": true,
|
|
3588
3697
|
"locationInModule": {
|
|
3589
3698
|
"filename": "lib/cloud-assembly/context-queries.ts",
|
|
3590
|
-
"line":
|
|
3699
|
+
"line": 205
|
|
3591
3700
|
},
|
|
3592
|
-
"name": "
|
|
3701
|
+
"name": "lookupRoleArn",
|
|
3702
|
+
"optional": true,
|
|
3593
3703
|
"type": {
|
|
3594
3704
|
"primitive": "string"
|
|
3595
3705
|
}
|
|
@@ -3635,6 +3745,6 @@
|
|
|
3635
3745
|
"symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
|
|
3636
3746
|
}
|
|
3637
3747
|
},
|
|
3638
|
-
"version": "2.
|
|
3748
|
+
"version": "2.7.0",
|
|
3639
3749
|
"fingerprint": "**********"
|
|
3640
3750
|
}
|