forked from aws/aws-cdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
assets.schema.json
192 lines (192 loc) · 7.83 KB
/
assets.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
{
"$ref": "#/definitions/AssetManifest",
"definitions": {
"AssetManifest": {
"description": "Definitions for the asset manifest",
"type": "object",
"properties": {
"version": {
"description": "Version of the manifest",
"type": "string"
},
"files": {
"description": "The file assets in this manifest (Default - No files)",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileAsset"
}
},
"dockerImages": {
"description": "The Docker image assets in this manifest (Default - No Docker images)",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DockerImageAsset"
}
}
},
"required": [
"version"
]
},
"FileAsset": {
"description": "A file asset",
"type": "object",
"properties": {
"source": {
"$ref": "#/definitions/FileSource",
"description": "Source description for file assets"
},
"destinations": {
"description": "Destinations for this file asset",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileDestination"
}
}
},
"required": [
"destinations",
"source"
]
},
"FileSource": {
"description": "Describe the source of a file asset",
"type": "object",
"properties": {
"executable": {
"description": "External command which will produce the file asset to upload. (Default - Exactly one of `executable` and `path` is required.)",
"type": "array",
"items": {
"type": "string"
}
},
"path": {
"description": "The filesystem object to upload\n\nThis path is relative to the asset manifest location. (Default - Exactly one of `executable` and `path` is required.)",
"type": "string"
},
"packaging": {
"description": "Packaging method\n\nOnly allowed when `path` is specified. (Default FILE)",
"enum": [
"file",
"zip"
],
"type": "string"
}
}
},
"FileDestination": {
"description": "Where in S3 a file asset needs to be published",
"type": "object",
"properties": {
"bucketName": {
"description": "The name of the bucket",
"type": "string"
},
"objectKey": {
"description": "The destination object key",
"type": "string"
},
"region": {
"description": "The region where this asset will need to be published (Default - Current region)",
"type": "string"
},
"assumeRoleArn": {
"description": "The role that needs to be assumed while publishing this asset (Default - No role will be assumed)",
"type": "string"
},
"assumeRoleExternalId": {
"description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
"type": "string"
}
},
"required": [
"bucketName",
"objectKey"
]
},
"DockerImageAsset": {
"description": "A file asset",
"type": "object",
"properties": {
"source": {
"$ref": "#/definitions/DockerImageSource",
"description": "Source description for file assets"
},
"destinations": {
"description": "Destinations for this file asset",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DockerImageDestination"
}
}
},
"required": [
"destinations",
"source"
]
},
"DockerImageSource": {
"description": "Properties for how to produce a Docker image from a source",
"type": "object",
"properties": {
"directory": {
"description": "The directory containing the Docker image build instructions.\n\nThis path is relative to the asset manifest location. (Default - Exactly one of `directory` and `executable` is required)",
"type": "string"
},
"executable": {
"description": "A command-line executable that returns the name of a local\nDocker image on stdout after being run. (Default - Exactly one of `directory` and `executable` is required)",
"type": "array",
"items": {
"type": "string"
}
},
"dockerFile": {
"description": "The name of the file with build instructions\n\nOnly allowed when `directory` is set. (Default Dockerfile)",
"type": "string"
},
"dockerBuildTarget": {
"description": "Target build stage in a Dockerfile with multiple build stages\n\nOnly allowed when `directory` is set. (Default - The last stage in the Dockerfile)",
"type": "string"
},
"dockerBuildArgs": {
"description": "Additional build arguments\n\nOnly allowed when `directory` is set. (Default - No additional build arguments)",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"DockerImageDestination": {
"description": "Where to publish docker images",
"type": "object",
"properties": {
"repositoryName": {
"description": "Name of the ECR repository to publish to",
"type": "string"
},
"imageTag": {
"description": "Tag of the image to publish",
"type": "string"
},
"region": {
"description": "The region where this asset will need to be published (Default - Current region)",
"type": "string"
},
"assumeRoleArn": {
"description": "The role that needs to be assumed while publishing this asset (Default - No role will be assumed)",
"type": "string"
},
"assumeRoleExternalId": {
"description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
"type": "string"
}
},
"required": [
"imageTag",
"repositoryName"
]
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}