forked from aws/aws-cdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcloud-assembly.schema.json
788 lines (788 loc) · 32.1 KB
/
cloud-assembly.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
{
"$ref": "#/definitions/AssemblyManifest",
"definitions": {
"AssemblyManifest": {
"description": "A manifest which describes the cloud assembly.",
"type": "object",
"properties": {
"version": {
"description": "Protocol version",
"type": "string"
},
"artifacts": {
"description": "The set of artifacts in this assembly. (Default - no artifacts.)",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArtifactManifest"
}
},
"missing": {
"description": "Missing context information. If this field has values, it means that the\ncloud assembly is not complete and should not be deployed. (Default - no missing context.)",
"type": "array",
"items": {
"$ref": "#/definitions/MissingContext"
}
},
"runtime": {
"description": "Runtime information. (Default - no info.)",
"$ref": "#/definitions/RuntimeInfo"
}
},
"required": [
"version"
]
},
"ArtifactManifest": {
"description": "A manifest for a single artifact within the cloud assembly.",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ArtifactType",
"description": "The type of artifact."
},
"environment": {
"description": "The environment into which this artifact is deployed. (Default - no envrionment.)",
"type": "string"
},
"metadata": {
"description": "Associated metadata. (Default - no metadata.)",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/MetadataEntry"
}
}
},
"dependencies": {
"description": "IDs of artifacts that must be deployed before this artifact. (Default - no dependencies.)",
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"description": "The set of properties for this artifact (depends on type) (Default - no properties.)",
"anyOf": [
{
"$ref": "#/definitions/AwsCloudFormationStackProperties"
},
{
"$ref": "#/definitions/AssetManifestProperties"
},
{
"$ref": "#/definitions/TreeArtifactProperties"
},
{
"$ref": "#/definitions/NestedCloudAssemblyProperties"
}
]
},
"displayName": {
"description": "A string that represents this artifact. Should only be used in user interfaces. (Default - no display name)",
"type": "string"
}
},
"required": [
"type"
]
},
"ArtifactType": {
"description": "Type of cloud artifact.",
"enum": [
"aws:cloudformation:stack",
"cdk:asset-manifest",
"cdk:cloud-assembly",
"cdk:tree",
"none"
],
"type": "string"
},
"MetadataEntry": {
"description": "A metadata entry in a cloud assembly artifact.",
"type": "object",
"properties": {
"type": {
"description": "The type of the metadata entry.",
"type": "string"
},
"data": {
"description": "The data. (Default - no data.)",
"anyOf": [
{
"$ref": "#/definitions/FileAssetMetadataEntry"
},
{
"$ref": "#/definitions/ContainerImageAssetMetadataEntry"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
{
"type": "string"
},
{
"description": "Free form data."
}
]
},
"trace": {
"description": "A stack trace for when the entry was created. (Default - no trace.)",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"FileAssetMetadataEntry": {
"description": "Metadata Entry spec for files.",
"type": "object",
"properties": {
"packaging": {
"description": "Requested packaging style",
"enum": [
"file",
"zip"
],
"type": "string"
},
"s3BucketParameter": {
"description": "Name of parameter where S3 bucket should be passed in",
"type": "string"
},
"s3KeyParameter": {
"description": "Name of parameter where S3 key should be passed in",
"type": "string"
},
"artifactHashParameter": {
"description": "The name of the parameter where the hash of the bundled asset should be passed in.",
"type": "string"
},
"id": {
"description": "Logical identifier for the asset",
"type": "string"
},
"sourceHash": {
"description": "The hash of the asset source.",
"type": "string"
},
"path": {
"description": "Path on disk to the asset",
"type": "string"
}
},
"required": [
"artifactHashParameter",
"id",
"packaging",
"path",
"s3BucketParameter",
"s3KeyParameter",
"sourceHash"
]
},
"ContainerImageAssetMetadataEntry": {
"description": "Metadata Entry spec for container images.",
"type": "object",
"properties": {
"packaging": {
"description": "Type of asset",
"type": "string",
"enum": [
"container-image"
]
},
"imageNameParameter": {
"description": "ECR Repository name and repo digest (separated by \"@sha256:\") where this\nimage is stored. (Default undefined If not specified, `repositoryName` and `imageTag` are\nrequired because otherwise how will the stack know where to find the asset,\nha?)",
"type": "string"
},
"repositoryName": {
"description": "ECR repository name, if omitted a default name based on the asset's ID is\nused instead. 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. (Default - this parameter is REQUIRED after 1.21.0)",
"type": "string"
},
"imageTag": {
"description": "The docker image tag to use for tagging pushed images. This field is\nrequired if `imageParameterName` is ommited (otherwise, the app won't be\nable to find the image). (Default - this parameter is REQUIRED after 1.21.0)",
"type": "string"
},
"buildArgs": {
"description": "Build args to pass to the `docker build` command (Default no build args are passed)",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"target": {
"description": "Docker target to build to (Default no build target)",
"type": "string"
},
"file": {
"description": "Path to the Dockerfile (relative to the directory). (Default - no file is passed)",
"type": "string"
},
"id": {
"description": "Logical identifier for the asset",
"type": "string"
},
"sourceHash": {
"description": "The hash of the asset source.",
"type": "string"
},
"path": {
"description": "Path on disk to the asset",
"type": "string"
}
},
"required": [
"id",
"packaging",
"path",
"sourceHash"
]
},
"Tag": {
"description": "Metadata Entry spec for stack tag.",
"type": "object",
"properties": {
"key": {
"description": "Tag key.\n\n(In the actual file on disk this will be cased as \"Key\", and the structure is\npatched to match this structure upon loading:\nhttps://github.com/aws/aws-cdk/blob/4aadaa779b48f35838cccd4e25107b2338f05547/packages/%40aws-cdk/cloud-assembly-schema/lib/manifest.ts#L137)",
"type": "string"
},
"value": {
"description": "Tag value.\n\n(In the actual file on disk this will be cased as \"Value\", and the structure is\npatched to match this structure upon loading:\nhttps://github.com/aws/aws-cdk/blob/4aadaa779b48f35838cccd4e25107b2338f05547/packages/%40aws-cdk/cloud-assembly-schema/lib/manifest.ts#L137)",
"type": "string"
}
},
"required": [
"key",
"value"
]
},
"AwsCloudFormationStackProperties": {
"description": "Artifact properties for CloudFormation stacks.",
"type": "object",
"properties": {
"templateFile": {
"description": "A file relative to the assembly root which contains the CloudFormation template for this stack.",
"type": "string"
},
"parameters": {
"description": "Values for CloudFormation stack parameters that should be passed when the stack is deployed. (Default - No parameters)",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tags": {
"description": "Values for CloudFormation stack tags that should be passed when the stack is deployed. (Default - No tags)",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stackName": {
"description": "The name to use for the CloudFormation stack. (Default - name derived from artifact ID)",
"type": "string"
},
"terminationProtection": {
"description": "Whether to enable termination protection for this stack.",
"default": false,
"type": "boolean"
},
"assumeRoleArn": {
"description": "The role that needs to be assumed to deploy the stack (Default - No role is assumed (current credentials are used))",
"type": "string"
},
"assumeRoleExternalId": {
"description": "External ID to use when assuming role for cloudformation deployments (Default - No external ID)",
"type": "string"
},
"cloudFormationExecutionRoleArn": {
"description": "The role that is passed to CloudFormation to execute the change set (Default - No role is passed (currently assumed role/credentials are used))",
"type": "string"
},
"stackTemplateAssetObjectUrl": {
"description": "If the stack template has already been included in the asset manifest, its asset URL (Default - Not uploaded yet, upload just before deploying)",
"type": "string"
},
"requiresBootstrapStackVersion": {
"description": "Version of bootstrap stack required to deploy this stack (Default - No bootstrap stack required)",
"type": "number"
},
"bootstrapStackVersionSsmParameter": {
"description": "SSM parameter where the bootstrap stack version number can be found\n\nOnly used if `requiresBootstrapStackVersion` is set.\n\n- 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. (Default - Bootstrap stack version number looked up)",
"type": "string"
},
"validateOnSynth": {
"description": "Whether this stack should be validated by the CLI after synthesis (Default - false)",
"type": "boolean"
}
},
"required": [
"templateFile"
]
},
"AssetManifestProperties": {
"description": "Artifact properties for the Asset Manifest",
"type": "object",
"properties": {
"file": {
"description": "Filename of the asset manifest",
"type": "string"
},
"requiresBootstrapStackVersion": {
"description": "Version of bootstrap stack required to deploy this stack (Default - Version 1 (basic modern bootstrap stack))",
"type": "number"
},
"bootstrapStackVersionSsmParameter": {
"description": "SSM parameter where the bootstrap stack version number can be found\n\n- 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. (Default - Bootstrap stack version number looked up)",
"type": "string"
}
},
"required": [
"file"
]
},
"TreeArtifactProperties": {
"description": "Artifact properties for the Construct Tree Artifact",
"type": "object",
"properties": {
"file": {
"description": "Filename of the tree artifact",
"type": "string"
}
},
"required": [
"file"
]
},
"NestedCloudAssemblyProperties": {
"description": "Artifact properties for nested cloud assemblies",
"type": "object",
"properties": {
"directoryName": {
"description": "Relative path to the nested cloud assembly",
"type": "string"
},
"displayName": {
"description": "Display name for the cloud assembly (Default - The artifact ID)",
"type": "string"
}
},
"required": [
"directoryName"
]
},
"MissingContext": {
"description": "Represents a missing piece of context.",
"type": "object",
"properties": {
"key": {
"description": "The missing context key.",
"type": "string"
},
"provider": {
"$ref": "#/definitions/ContextProvider",
"description": "The provider from which we expect this context key to be obtained."
},
"props": {
"description": "A set of provider-specific options.",
"anyOf": [
{
"$ref": "#/definitions/AmiContextQuery"
},
{
"$ref": "#/definitions/AvailabilityZonesContextQuery"
},
{
"$ref": "#/definitions/HostedZoneContextQuery"
},
{
"$ref": "#/definitions/SSMParameterContextQuery"
},
{
"$ref": "#/definitions/VpcContextQuery"
},
{
"$ref": "#/definitions/EndpointServiceAvailabilityZonesContextQuery"
},
{
"$ref": "#/definitions/LoadBalancerContextQuery"
},
{
"$ref": "#/definitions/LoadBalancerListenerContextQuery"
},
{
"$ref": "#/definitions/SecurityGroupContextQuery"
}
]
}
},
"required": [
"key",
"props",
"provider"
]
},
"ContextProvider": {
"description": "Identifier for the context provider",
"enum": [
"ami",
"availability-zones",
"endpoint-service-availability-zones",
"hosted-zone",
"load-balancer",
"load-balancer-listener",
"security-group",
"ssm",
"vpc-provider"
],
"type": "string"
},
"AmiContextQuery": {
"description": "Query to AMI context provider",
"type": "object",
"properties": {
"account": {
"description": "Account to query",
"type": "string"
},
"region": {
"description": "Region to query",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"owners": {
"description": "Owners to DescribeImages call (Default - All owners)",
"type": "array",
"items": {
"type": "string"
}
},
"filters": {
"description": "Filters to DescribeImages call",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"account",
"filters",
"region"
]
},
"AvailabilityZonesContextQuery": {
"description": "Query to availability zone context provider",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
}
},
"required": [
"account",
"region"
]
},
"HostedZoneContextQuery": {
"description": "Query to hosted zone context provider",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"domainName": {
"description": "The domain name e.g. example.com to lookup",
"type": "string"
},
"privateZone": {
"description": "True if the zone you want to find is a private hosted zone",
"default": false,
"type": "boolean"
},
"vpcId": {
"description": "The VPC ID to that the private zone must be associated with\n\nIf you provide VPC ID and privateZone is false, this will return no results\nand raise an error. (Default - Required if privateZone=true)",
"type": "string"
}
},
"required": [
"account",
"domainName",
"region"
]
},
"SSMParameterContextQuery": {
"description": "Query to SSM Parameter Context Provider",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"parameterName": {
"description": "Parameter name to query",
"type": "string"
}
},
"required": [
"account",
"parameterName",
"region"
]
},
"VpcContextQuery": {
"description": "Query input for looking up a VPC",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"filter": {
"description": "Filters to apply to the VPC\n\nFilter parameters are the same as passed to DescribeVpcs.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"returnAsymmetricSubnets": {
"description": "Whether to populate the subnetGroups field of the {@link VpcContextResponse},\nwhich contains potentially asymmetric subnet groups.",
"default": false,
"type": "boolean"
},
"subnetGroupNameTag": {
"description": "Optional tag for subnet group name.\nIf not provided, we'll look at the aws-cdk:subnet-name tag.\nIf the subnet does not have the specified tag,\nwe'll use its type as the name. (Default 'aws-cdk:subnet-name')",
"type": "string"
}
},
"required": [
"account",
"filter",
"region"
]
},
"EndpointServiceAvailabilityZonesContextQuery": {
"description": "Query to endpoint service context provider",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"serviceName": {
"description": "Query service name",
"type": "string"
}
},
"required": [
"account",
"region",
"serviceName"
]
},
"LoadBalancerContextQuery": {
"description": "Query input for looking up a load balancer",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"loadBalancerType": {
"$ref": "#/definitions/LoadBalancerType",
"description": "Filter load balancers by their type"
},
"loadBalancerArn": {
"description": "Find by load balancer's ARN (Default - does not search by load balancer arn)",
"type": "string"
},
"loadBalancerTags": {
"description": "Match load balancer tags (Default - does not match load balancers by tags)",
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"required": [
"account",
"loadBalancerType",
"region"
]
},
"LoadBalancerType": {
"description": "Type of load balancer",
"enum": [
"application",
"network"
],
"type": "string"
},
"LoadBalancerListenerContextQuery": {
"description": "Query input for looking up a load balancer listener",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"listenerArn": {
"description": "Find by listener's arn (Default - does not find by listener arn)",
"type": "string"
},
"listenerProtocol": {
"description": "Filter by listener protocol (Default - does not filter by listener protocol)",
"enum": [
"HTTP",
"HTTPS",
"TCP",
"TCP_UDP",
"TLS",
"UDP"
],
"type": "string"
},
"listenerPort": {
"description": "Filter listeners by listener port (Default - does not filter by a listener port)",
"type": "number"
},
"loadBalancerType": {
"$ref": "#/definitions/LoadBalancerType",
"description": "Filter load balancers by their type"
},
"loadBalancerArn": {
"description": "Find by load balancer's ARN (Default - does not search by load balancer arn)",
"type": "string"
},
"loadBalancerTags": {
"description": "Match load balancer tags (Default - does not match load balancers by tags)",
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"required": [
"account",
"loadBalancerType",
"region"
]
},
"SecurityGroupContextQuery": {
"description": "Query input for looking up a security group",
"type": "object",
"properties": {
"account": {
"description": "Query account",
"type": "string"
},
"region": {
"description": "Query region",
"type": "string"
},
"lookupRoleArn": {
"description": "The ARN of the role that should be used to look up the missing values (Default - None)",
"type": "string"
},
"securityGroupId": {
"description": "Security group id",
"type": "string"
}
},
"required": [
"account",
"region",
"securityGroupId"
]
},
"RuntimeInfo": {
"description": "Information about the application's runtime components.",
"type": "object",
"properties": {
"libraries": {
"description": "The list of libraries loaded in the application, associated with their versions.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"libraries"
]
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}