|
1 | 1 | { |
2 | 2 | "typeName": "AWS::ApiGateway::RestApi", |
3 | | - "description": "Resource Type definition for AWS::ApiGateway::RestApi", |
| 3 | + "description": "Resource Type definition for AWS::ApiGateway::RestApi.", |
| 4 | + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", |
4 | 5 | "additionalProperties": false, |
5 | | - "properties": { |
6 | | - "Policy": { |
7 | | - "type": "object", |
8 | | - "markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption" |
9 | | - }, |
10 | | - "BodyS3Location": { |
11 | | - "$ref": "#/definitions/S3Location" |
12 | | - }, |
13 | | - "Description": { |
14 | | - "type": "string", |
15 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
16 | | - }, |
17 | | - "MinimumCompressionSize": { |
18 | | - "type": "integer", |
19 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: Integer \nUpdate requires: No interruption" |
20 | | - }, |
21 | | - "Parameters": { |
22 | | - "type": "object", |
23 | | - "patternProperties": { |
24 | | - "[a-zA-Z0-9]+": { |
25 | | - "type": "string", |
26 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
27 | | - } |
28 | | - }, |
29 | | - "markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption" |
30 | | - }, |
31 | | - "CloneFrom": { |
32 | | - "type": "string", |
33 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
34 | | - }, |
35 | | - "Mode": { |
36 | | - "type": "string", |
37 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
38 | | - }, |
39 | | - "DisableExecuteApiEndpoint": { |
40 | | - "type": "boolean", |
41 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: Boolean \nUpdate requires: No interruption" |
42 | | - }, |
43 | | - "FailOnWarnings": { |
44 | | - "type": "boolean", |
45 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: Boolean \nUpdate requires: No interruption" |
46 | | - }, |
47 | | - "BinaryMediaTypes": { |
48 | | - "type": "array", |
49 | | - "uniqueItems": true, |
50 | | - "items": { |
51 | | - "type": "string", |
52 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
53 | | - }, |
54 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: Array \nUpdate requires: No interruption" |
55 | | - }, |
56 | | - "Name": { |
57 | | - "type": "string", |
58 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
59 | | - }, |
60 | | - "ApiKeySourceType": { |
61 | | - "type": "string", |
62 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
63 | | - }, |
64 | | - "EndpointConfiguration": { |
65 | | - "$ref": "#/definitions/EndpointConfiguration" |
66 | | - }, |
67 | | - "Body": { |
68 | | - "type": "object", |
69 | | - "markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption" |
70 | | - }, |
71 | | - "Tags": { |
72 | | - "type": "array", |
73 | | - "uniqueItems": false, |
74 | | - "items": { |
75 | | - "$ref": "#/definitions/Tag" |
76 | | - }, |
77 | | - "markdownDescription": "\n\n---\n\nRequired: No \nType: Array \nUpdate requires: No interruption" |
78 | | - } |
79 | | - }, |
80 | 6 | "definitions": { |
81 | 7 | "EndpointConfiguration": { |
82 | 8 | "type": "object", |
|
107 | 33 | "type": "object", |
108 | 34 | "additionalProperties": false, |
109 | 35 | "properties": { |
110 | | - "Value": { |
| 36 | + "Key": { |
111 | 37 | "type": "string", |
112 | 38 | "markdownDescription": "\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption" |
113 | 39 | }, |
114 | | - "Key": { |
| 40 | + "Value": { |
115 | 41 | "type": "string", |
116 | 42 | "markdownDescription": "\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption" |
117 | 43 | } |
118 | 44 | }, |
119 | 45 | "required": [ |
120 | | - "Value", |
121 | | - "Key" |
| 46 | + "Key", |
| 47 | + "Value" |
122 | 48 | ], |
123 | 49 | "markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption" |
124 | 50 | }, |
|
146 | 72 | "markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption" |
147 | 73 | } |
148 | 74 | }, |
| 75 | + "properties": { |
| 76 | + "ApiKeySourceType": { |
| 77 | + "type": "string", |
| 78 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 79 | + }, |
| 80 | + "BinaryMediaTypes": { |
| 81 | + "type": "array", |
| 82 | + "uniqueItems": true, |
| 83 | + "items": { |
| 84 | + "type": "string", |
| 85 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 86 | + }, |
| 87 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: Array \nUpdate requires: No interruption" |
| 88 | + }, |
| 89 | + "Body": { |
| 90 | + "type": [ |
| 91 | + "object", |
| 92 | + "string" |
| 93 | + ], |
| 94 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: ['object', 'string'] \nUpdate requires: No interruption" |
| 95 | + }, |
| 96 | + "BodyS3Location": { |
| 97 | + "$ref": "#/definitions/S3Location" |
| 98 | + }, |
| 99 | + "CloneFrom": { |
| 100 | + "type": "string", |
| 101 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 102 | + }, |
| 103 | + "EndpointConfiguration": { |
| 104 | + "$ref": "#/definitions/EndpointConfiguration" |
| 105 | + }, |
| 106 | + "Description": { |
| 107 | + "type": "string", |
| 108 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 109 | + }, |
| 110 | + "DisableExecuteApiEndpoint": { |
| 111 | + "type": "boolean", |
| 112 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: Boolean \nUpdate requires: No interruption" |
| 113 | + }, |
| 114 | + "FailOnWarnings": { |
| 115 | + "type": "boolean", |
| 116 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: Boolean \nUpdate requires: No interruption" |
| 117 | + }, |
| 118 | + "Name": { |
| 119 | + "type": "string", |
| 120 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 121 | + }, |
| 122 | + "MinimumCompressionSize": { |
| 123 | + "type": "integer", |
| 124 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: Integer \nUpdate requires: No interruption" |
| 125 | + }, |
| 126 | + "Mode": { |
| 127 | + "type": "string", |
| 128 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 129 | + }, |
| 130 | + "Policy": { |
| 131 | + "type": [ |
| 132 | + "object", |
| 133 | + "string" |
| 134 | + ], |
| 135 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: ['object', 'string'] \nUpdate requires: No interruption" |
| 136 | + }, |
| 137 | + "Parameters": { |
| 138 | + "type": [ |
| 139 | + "object", |
| 140 | + "string" |
| 141 | + ], |
| 142 | + "additionalProperties": false, |
| 143 | + "patternProperties": { |
| 144 | + "[a-zA-Z0-9]+": { |
| 145 | + "type": "string", |
| 146 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
| 147 | + } |
| 148 | + }, |
| 149 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: ['object', 'string'] \nUpdate requires: No interruption" |
| 150 | + }, |
| 151 | + "Tags": { |
| 152 | + "type": "array", |
| 153 | + "uniqueItems": false, |
| 154 | + "items": { |
| 155 | + "$ref": "#/definitions/Tag" |
| 156 | + }, |
| 157 | + "markdownDescription": "\n\n---\n\nRequired: No \nType: Array \nUpdate requires: No interruption" |
| 158 | + } |
| 159 | + }, |
| 160 | + "tagging": { |
| 161 | + "taggable": true, |
| 162 | + "tagOnCreate": true, |
| 163 | + "tagUpdatable": true, |
| 164 | + "cloudFormationSystemTags": true, |
| 165 | + "tagProperty": "/properties/Tags" |
| 166 | + }, |
149 | 167 | "primaryIdentifier": [ |
150 | | - "/properties/Id" |
| 168 | + "/properties/RestApiId" |
151 | 169 | ], |
152 | 170 | "readOnlyProperties": [ |
153 | | - "/properties/Id", |
| 171 | + "/properties/RestApiId", |
154 | 172 | "/properties/RootResourceId" |
155 | 173 | ], |
| 174 | + "writeOnlyProperties": [ |
| 175 | + "/properties/Body", |
| 176 | + "/properties/BodyS3Location", |
| 177 | + "/properties/CloneFrom", |
| 178 | + "/properties/FailOnWarnings", |
| 179 | + "/properties/Mode", |
| 180 | + "/properties/Parameters" |
| 181 | + ], |
| 182 | + "handlers": { |
| 183 | + "create": { |
| 184 | + "permissions": [ |
| 185 | + "apigateway:GET", |
| 186 | + "apigateway:POST", |
| 187 | + "apigateway:UpdateRestApiPolicy", |
| 188 | + "s3:GetObject", |
| 189 | + "iam:PassRole" |
| 190 | + ] |
| 191 | + }, |
| 192 | + "read": { |
| 193 | + "permissions": [ |
| 194 | + "apigateway:GET" |
| 195 | + ] |
| 196 | + }, |
| 197 | + "update": { |
| 198 | + "permissions": [ |
| 199 | + "apigateway:GET", |
| 200 | + "apigateway:DELETE", |
| 201 | + "apigateway:PATCH", |
| 202 | + "apigateway:PUT", |
| 203 | + "apigateway:UpdateRestApiPolicy", |
| 204 | + "s3:GetObject", |
| 205 | + "iam:PassRole" |
| 206 | + ] |
| 207 | + }, |
| 208 | + "delete": { |
| 209 | + "permissions": [ |
| 210 | + "apigateway:DELETE" |
| 211 | + ] |
| 212 | + }, |
| 213 | + "list": { |
| 214 | + "permissions": [ |
| 215 | + "apigateway:GET" |
| 216 | + ] |
| 217 | + } |
| 218 | + }, |
156 | 219 | "attributes": { |
157 | | - "RootResourceId": { |
| 220 | + "RestApiId": { |
158 | 221 | "type": "string", |
159 | 222 | "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
160 | 223 | }, |
161 | | - "Id": { |
| 224 | + "RootResourceId": { |
162 | 225 | "type": "string", |
163 | 226 | "markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption" |
164 | 227 | } |
|
0 commit comments