UNPKG

194 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnAccount`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html
10 */
11export interface CfnAccountProps {
12 /**
13 * The ARN of an Amazon CloudWatch role for the current Account.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn
16 */
17 readonly cloudWatchRoleArn?: string;
18}
19/**
20 * A CloudFormation `AWS::ApiGateway::Account`
21 *
22 * The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one `AWS::ApiGateway::Account` resource per region per account.
23 *
24 * @cloudformationResource AWS::ApiGateway::Account
25 * @stability external
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html
28 */
29export declare class CfnAccount extends cdk.CfnResource implements cdk.IInspectable {
30 /**
31 * The CloudFormation resource type name for this resource class.
32 */
33 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Account";
34 /**
35 * A factory method that creates a new instance of this class from an object
36 * containing the CloudFormation properties of this resource.
37 * Used in the @aws-cdk/cloudformation-include module.
38 *
39 * @internal
40 */
41 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccount;
42 /**
43 * The ID for the account. For example: `abc123` .
44 * @cloudformationAttribute Id
45 */
46 readonly attrId: string;
47 /**
48 * The ARN of an Amazon CloudWatch role for the current Account.
49 *
50 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn
51 */
52 cloudWatchRoleArn: string | undefined;
53 /**
54 * Create a new `AWS::ApiGateway::Account`.
55 *
56 * @param scope - scope in which this resource is defined
57 * @param id - scoped id of the resource
58 * @param props - resource properties
59 */
60 constructor(scope: cdk.Construct, id: string, props?: CfnAccountProps);
61 /**
62 * Examines the CloudFormation resource and discloses attributes.
63 *
64 * @param inspector - tree inspector to collect and process attributes
65 *
66 */
67 inspect(inspector: cdk.TreeInspector): void;
68 protected get cfnProperties(): {
69 [key: string]: any;
70 };
71 protected renderProperties(props: {
72 [key: string]: any;
73 }): {
74 [key: string]: any;
75 };
76}
77/**
78 * Properties for defining a `CfnApiKey`
79 *
80 * @struct
81 * @stability external
82 *
83 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html
84 */
85export interface CfnApiKeyProps {
86 /**
87 * An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
88 *
89 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
90 */
91 readonly customerId?: string;
92 /**
93 * The description of the ApiKey.
94 *
95 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
96 */
97 readonly description?: string;
98 /**
99 * Specifies whether the ApiKey can be used by callers.
100 *
101 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
102 */
103 readonly enabled?: boolean | cdk.IResolvable;
104 /**
105 * Specifies whether ( `true` ) or not ( `false` ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
106 *
107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
108 */
109 readonly generateDistinctId?: boolean | cdk.IResolvable;
110 /**
111 * A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
112 *
113 * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
114 *
115 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
116 */
117 readonly name?: string;
118 /**
119 * DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
120 *
121 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys
122 */
123 readonly stageKeys?: Array<CfnApiKey.StageKeyProperty | cdk.IResolvable> | cdk.IResolvable;
124 /**
125 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.
126 *
127 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags
128 */
129 readonly tags?: cdk.CfnTag[];
130 /**
131 * Specifies a value of the API key.
132 *
133 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value
134 */
135 readonly value?: string;
136}
137/**
138 * A CloudFormation `AWS::ApiGateway::ApiKey`
139 *
140 * The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.
141 *
142 * @cloudformationResource AWS::ApiGateway::ApiKey
143 * @stability external
144 *
145 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html
146 */
147export declare class CfnApiKey extends cdk.CfnResource implements cdk.IInspectable {
148 /**
149 * The CloudFormation resource type name for this resource class.
150 */
151 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::ApiKey";
152 /**
153 * A factory method that creates a new instance of this class from an object
154 * containing the CloudFormation properties of this resource.
155 * Used in the @aws-cdk/cloudformation-include module.
156 *
157 * @internal
158 */
159 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApiKey;
160 /**
161 * The ID for the API key. For example: `abc123` .
162 * @cloudformationAttribute APIKeyId
163 */
164 readonly attrApiKeyId: string;
165 /**
166 * An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
167 *
168 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
169 */
170 customerId: string | undefined;
171 /**
172 * The description of the ApiKey.
173 *
174 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
175 */
176 description: string | undefined;
177 /**
178 * Specifies whether the ApiKey can be used by callers.
179 *
180 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
181 */
182 enabled: boolean | cdk.IResolvable | undefined;
183 /**
184 * Specifies whether ( `true` ) or not ( `false` ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
185 *
186 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
187 */
188 generateDistinctId: boolean | cdk.IResolvable | undefined;
189 /**
190 * A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
191 *
192 * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
193 *
194 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
195 */
196 name: string | undefined;
197 /**
198 * DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
199 *
200 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys
201 */
202 stageKeys: Array<CfnApiKey.StageKeyProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
203 /**
204 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.
205 *
206 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags
207 */
208 readonly tags: cdk.TagManager;
209 /**
210 * Specifies a value of the API key.
211 *
212 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value
213 */
214 value: string | undefined;
215 /**
216 * Create a new `AWS::ApiGateway::ApiKey`.
217 *
218 * @param scope - scope in which this resource is defined
219 * @param id - scoped id of the resource
220 * @param props - resource properties
221 */
222 constructor(scope: cdk.Construct, id: string, props?: CfnApiKeyProps);
223 /**
224 * Examines the CloudFormation resource and discloses attributes.
225 *
226 * @param inspector - tree inspector to collect and process attributes
227 *
228 */
229 inspect(inspector: cdk.TreeInspector): void;
230 protected get cfnProperties(): {
231 [key: string]: any;
232 };
233 protected renderProperties(props: {
234 [key: string]: any;
235 }): {
236 [key: string]: any;
237 };
238}
239export declare namespace CfnApiKey {
240 /**
241 * `StageKey` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.
242 *
243 * @struct
244 * @stability external
245 *
246 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html
247 */
248 interface StageKeyProperty {
249 /**
250 * The string identifier of the associated RestApi.
251 *
252 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid
253 */
254 readonly restApiId?: string;
255 /**
256 * The stage name associated with the stage key.
257 *
258 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename
259 */
260 readonly stageName?: string;
261 }
262}
263/**
264 * Properties for defining a `CfnAuthorizer`
265 *
266 * @struct
267 * @stability external
268 *
269 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
270 */
271export interface CfnAuthorizerProps {
272 /**
273 * The name of the authorizer.
274 *
275 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name
276 */
277 readonly name: string;
278 /**
279 * The string identifier of the associated RestApi.
280 *
281 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
282 */
283 readonly restApiId: string;
284 /**
285 * The authorizer type. Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
286 *
287 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
288 */
289 readonly type: string;
290 /**
291 * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
292 *
293 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials
294 */
295 readonly authorizerCredentials?: string;
296 /**
297 * The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
298 *
299 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds
300 */
301 readonly authorizerResultTtlInSeconds?: number;
302 /**
303 * Specifies the authorizer's Uniform Resource Identifier (URI). For `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations` . In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}` , where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/` . For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations` .
304 *
305 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
306 */
307 readonly authorizerUri?: string;
308 /**
309 * Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
310 *
311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype
312 */
313 readonly authType?: string;
314 /**
315 * The identity source for which authorization is requested. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is `Auth` , the header mapping expression is `method.request.header.Auth` . For the `REQUEST` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name` . These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
316 *
317 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
318 */
319 readonly identitySource?: string;
320 /**
321 * A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.
322 *
323 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression
324 */
325 readonly identityValidationExpression?: string;
326 /**
327 * A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}` . For a `TOKEN` or `REQUEST` authorizer, this is not defined.
328 *
329 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
330 */
331 readonly providerArns?: string[];
332}
333/**
334 * A CloudFormation `AWS::ApiGateway::Authorizer`
335 *
336 * The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
337 *
338 * @cloudformationResource AWS::ApiGateway::Authorizer
339 * @stability external
340 *
341 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
342 */
343export declare class CfnAuthorizer extends cdk.CfnResource implements cdk.IInspectable {
344 /**
345 * The CloudFormation resource type name for this resource class.
346 */
347 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Authorizer";
348 /**
349 * A factory method that creates a new instance of this class from an object
350 * containing the CloudFormation properties of this resource.
351 * Used in the @aws-cdk/cloudformation-include module.
352 *
353 * @internal
354 */
355 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAuthorizer;
356 /**
357 * The ID for the authorizer. For example: `abc123` .
358 * @cloudformationAttribute AuthorizerId
359 */
360 readonly attrAuthorizerId: string;
361 /**
362 * The name of the authorizer.
363 *
364 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name
365 */
366 name: string;
367 /**
368 * The string identifier of the associated RestApi.
369 *
370 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
371 */
372 restApiId: string;
373 /**
374 * The authorizer type. Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
375 *
376 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
377 */
378 type: string;
379 /**
380 * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
381 *
382 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials
383 */
384 authorizerCredentials: string | undefined;
385 /**
386 * The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
387 *
388 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds
389 */
390 authorizerResultTtlInSeconds: number | undefined;
391 /**
392 * Specifies the authorizer's Uniform Resource Identifier (URI). For `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations` . In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}` , where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/` . For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations` .
393 *
394 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
395 */
396 authorizerUri: string | undefined;
397 /**
398 * Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
399 *
400 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype
401 */
402 authType: string | undefined;
403 /**
404 * The identity source for which authorization is requested. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is `Auth` , the header mapping expression is `method.request.header.Auth` . For the `REQUEST` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name` . These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
405 *
406 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
407 */
408 identitySource: string | undefined;
409 /**
410 * A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.
411 *
412 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression
413 */
414 identityValidationExpression: string | undefined;
415 /**
416 * A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}` . For a `TOKEN` or `REQUEST` authorizer, this is not defined.
417 *
418 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
419 */
420 providerArns: string[] | undefined;
421 /**
422 * Create a new `AWS::ApiGateway::Authorizer`.
423 *
424 * @param scope - scope in which this resource is defined
425 * @param id - scoped id of the resource
426 * @param props - resource properties
427 */
428 constructor(scope: cdk.Construct, id: string, props: CfnAuthorizerProps);
429 /**
430 * Examines the CloudFormation resource and discloses attributes.
431 *
432 * @param inspector - tree inspector to collect and process attributes
433 *
434 */
435 inspect(inspector: cdk.TreeInspector): void;
436 protected get cfnProperties(): {
437 [key: string]: any;
438 };
439 protected renderProperties(props: {
440 [key: string]: any;
441 }): {
442 [key: string]: any;
443 };
444}
445/**
446 * Properties for defining a `CfnBasePathMapping`
447 *
448 * @struct
449 * @stability external
450 *
451 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
452 */
453export interface CfnBasePathMappingProps {
454 /**
455 * The domain name of the BasePathMapping resource to be described.
456 *
457 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname
458 */
459 readonly domainName: string;
460 /**
461 * The base path name that callers of the API must provide as part of the URL after the domain name.
462 *
463 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath
464 */
465 readonly basePath?: string;
466 /**
467 * `AWS::ApiGateway::BasePathMapping.Id`
468 *
469 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id
470 */
471 readonly id?: string;
472 /**
473 * The string identifier of the associated RestApi.
474 *
475 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid
476 */
477 readonly restApiId?: string;
478 /**
479 * The name of the associated stage.
480 *
481 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage
482 */
483 readonly stage?: string;
484}
485/**
486 * A CloudFormation `AWS::ApiGateway::BasePathMapping`
487 *
488 * The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL.
489 *
490 * @cloudformationResource AWS::ApiGateway::BasePathMapping
491 * @stability external
492 *
493 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
494 */
495export declare class CfnBasePathMapping extends cdk.CfnResource implements cdk.IInspectable {
496 /**
497 * The CloudFormation resource type name for this resource class.
498 */
499 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::BasePathMapping";
500 /**
501 * A factory method that creates a new instance of this class from an object
502 * containing the CloudFormation properties of this resource.
503 * Used in the @aws-cdk/cloudformation-include module.
504 *
505 * @internal
506 */
507 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBasePathMapping;
508 /**
509 * The domain name of the BasePathMapping resource to be described.
510 *
511 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname
512 */
513 domainName: string;
514 /**
515 * The base path name that callers of the API must provide as part of the URL after the domain name.
516 *
517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath
518 */
519 basePath: string | undefined;
520 /**
521 * `AWS::ApiGateway::BasePathMapping.Id`
522 *
523 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id
524 */
525 id: string | undefined;
526 /**
527 * The string identifier of the associated RestApi.
528 *
529 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid
530 */
531 restApiId: string | undefined;
532 /**
533 * The name of the associated stage.
534 *
535 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage
536 */
537 stage: string | undefined;
538 /**
539 * Create a new `AWS::ApiGateway::BasePathMapping`.
540 *
541 * @param scope - scope in which this resource is defined
542 * @param id - scoped id of the resource
543 * @param props - resource properties
544 */
545 constructor(scope: cdk.Construct, id: string, props: CfnBasePathMappingProps);
546 /**
547 * Examines the CloudFormation resource and discloses attributes.
548 *
549 * @param inspector - tree inspector to collect and process attributes
550 *
551 */
552 inspect(inspector: cdk.TreeInspector): void;
553 protected get cfnProperties(): {
554 [key: string]: any;
555 };
556 protected renderProperties(props: {
557 [key: string]: any;
558 }): {
559 [key: string]: any;
560 };
561}
562/**
563 * Properties for defining a `CfnClientCertificate`
564 *
565 * @struct
566 * @stability external
567 *
568 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html
569 */
570export interface CfnClientCertificateProps {
571 /**
572 * The description of the client certificate.
573 *
574 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description
575 */
576 readonly description?: string;
577 /**
578 * The collection of tags. Each tag element is associated with a given resource.
579 *
580 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags
581 */
582 readonly tags?: cdk.CfnTag[];
583}
584/**
585 * A CloudFormation `AWS::ApiGateway::ClientCertificate`
586 *
587 * The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
588 *
589 * @cloudformationResource AWS::ApiGateway::ClientCertificate
590 * @stability external
591 *
592 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html
593 */
594export declare class CfnClientCertificate extends cdk.CfnResource implements cdk.IInspectable {
595 /**
596 * The CloudFormation resource type name for this resource class.
597 */
598 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::ClientCertificate";
599 /**
600 * A factory method that creates a new instance of this class from an object
601 * containing the CloudFormation properties of this resource.
602 * Used in the @aws-cdk/cloudformation-include module.
603 *
604 * @internal
605 */
606 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnClientCertificate;
607 /**
608 * The ID for the client certificate. For example: `abc123` .
609 * @cloudformationAttribute ClientCertificateId
610 */
611 readonly attrClientCertificateId: string;
612 /**
613 * The description of the client certificate.
614 *
615 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description
616 */
617 description: string | undefined;
618 /**
619 * The collection of tags. Each tag element is associated with a given resource.
620 *
621 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags
622 */
623 readonly tags: cdk.TagManager;
624 /**
625 * Create a new `AWS::ApiGateway::ClientCertificate`.
626 *
627 * @param scope - scope in which this resource is defined
628 * @param id - scoped id of the resource
629 * @param props - resource properties
630 */
631 constructor(scope: cdk.Construct, id: string, props?: CfnClientCertificateProps);
632 /**
633 * Examines the CloudFormation resource and discloses attributes.
634 *
635 * @param inspector - tree inspector to collect and process attributes
636 *
637 */
638 inspect(inspector: cdk.TreeInspector): void;
639 protected get cfnProperties(): {
640 [key: string]: any;
641 };
642 protected renderProperties(props: {
643 [key: string]: any;
644 }): {
645 [key: string]: any;
646 };
647}
648/**
649 * Properties for defining a `CfnDeployment`
650 *
651 * @struct
652 * @stability external
653 *
654 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html
655 */
656export interface CfnDeploymentProps {
657 /**
658 * The string identifier of the associated RestApi.
659 *
660 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
661 */
662 readonly restApiId: string;
663 /**
664 * The input configuration for a canary deployment.
665 *
666 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings
667 */
668 readonly deploymentCanarySettings?: CfnDeployment.DeploymentCanarySettingsProperty | cdk.IResolvable;
669 /**
670 * The description for the Deployment resource to create.
671 *
672 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
673 */
674 readonly description?: string;
675 /**
676 * The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
677 *
678 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
679 */
680 readonly stageDescription?: CfnDeployment.StageDescriptionProperty | cdk.IResolvable;
681 /**
682 * The name of the Stage resource for the Deployment resource to create.
683 *
684 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename
685 */
686 readonly stageName?: string;
687}
688/**
689 * A CloudFormation `AWS::ApiGateway::Deployment`
690 *
691 * The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
692 *
693 * @cloudformationResource AWS::ApiGateway::Deployment
694 * @stability external
695 *
696 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html
697 */
698export declare class CfnDeployment extends cdk.CfnResource implements cdk.IInspectable {
699 /**
700 * The CloudFormation resource type name for this resource class.
701 */
702 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Deployment";
703 /**
704 * A factory method that creates a new instance of this class from an object
705 * containing the CloudFormation properties of this resource.
706 * Used in the @aws-cdk/cloudformation-include module.
707 *
708 * @internal
709 */
710 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDeployment;
711 /**
712 * The ID for the deployment. For example: `abc123` .
713 * @cloudformationAttribute DeploymentId
714 */
715 readonly attrDeploymentId: string;
716 /**
717 * The string identifier of the associated RestApi.
718 *
719 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
720 */
721 restApiId: string;
722 /**
723 * The input configuration for a canary deployment.
724 *
725 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings
726 */
727 deploymentCanarySettings: CfnDeployment.DeploymentCanarySettingsProperty | cdk.IResolvable | undefined;
728 /**
729 * The description for the Deployment resource to create.
730 *
731 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
732 */
733 description: string | undefined;
734 /**
735 * The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
736 *
737 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
738 */
739 stageDescription: CfnDeployment.StageDescriptionProperty | cdk.IResolvable | undefined;
740 /**
741 * The name of the Stage resource for the Deployment resource to create.
742 *
743 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename
744 */
745 stageName: string | undefined;
746 /**
747 * Create a new `AWS::ApiGateway::Deployment`.
748 *
749 * @param scope - scope in which this resource is defined
750 * @param id - scoped id of the resource
751 * @param props - resource properties
752 */
753 constructor(scope: cdk.Construct, id: string, props: CfnDeploymentProps);
754 /**
755 * Examines the CloudFormation resource and discloses attributes.
756 *
757 * @param inspector - tree inspector to collect and process attributes
758 *
759 */
760 inspect(inspector: cdk.TreeInspector): void;
761 protected get cfnProperties(): {
762 [key: string]: any;
763 };
764 protected renderProperties(props: {
765 [key: string]: any;
766 }): {
767 [key: string]: any;
768 };
769}
770export declare namespace CfnDeployment {
771 /**
772 * The `AccessLogSetting` property type specifies settings for logging access in this stage.
773 *
774 * `AccessLogSetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.
775 *
776 * @struct
777 * @stability external
778 *
779 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html
780 */
781 interface AccessLogSettingProperty {
782 /**
783 * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` .
784 *
785 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn
786 */
787 readonly destinationArn?: string;
788 /**
789 * A single line format of the access logs of data, as specified by selected $context variables. The format must include at least `$context.requestId` .
790 *
791 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format
792 */
793 readonly format?: string;
794 }
795}
796export declare namespace CfnDeployment {
797 /**
798 * The `CanarySetting` property type specifies settings for the canary deployment in this stage.
799 *
800 * `CanarySetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.
801 *
802 * @struct
803 * @stability external
804 *
805 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html
806 */
807 interface CanarySettingProperty {
808 /**
809 * The percent (0-100) of traffic diverted to a canary deployment.
810 *
811 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic
812 */
813 readonly percentTraffic?: number;
814 /**
815 * Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
816 *
817 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides
818 */
819 readonly stageVariableOverrides?: {
820 [key: string]: (string);
821 } | cdk.IResolvable;
822 /**
823 * A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
824 *
825 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache
826 */
827 readonly useStageCache?: boolean | cdk.IResolvable;
828 }
829}
830export declare namespace CfnDeployment {
831 /**
832 * The `DeploymentCanarySettings` property type specifies settings for the canary deployment.
833 *
834 * @struct
835 * @stability external
836 *
837 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html
838 */
839 interface DeploymentCanarySettingsProperty {
840 /**
841 * The percentage (0.0-100.0) of traffic routed to the canary deployment.
842 *
843 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-percenttraffic
844 */
845 readonly percentTraffic?: number;
846 /**
847 * A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
848 *
849 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides
850 */
851 readonly stageVariableOverrides?: {
852 [key: string]: (string);
853 } | cdk.IResolvable;
854 /**
855 * A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
856 *
857 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-usestagecache
858 */
859 readonly useStageCache?: boolean | cdk.IResolvable;
860 }
861}
862export declare namespace CfnDeployment {
863 /**
864 * The `MethodSetting` property type configures settings for all methods in a stage.
865 *
866 * The `MethodSettings` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of `MethodSetting` property types.
867 *
868 * @struct
869 * @stability external
870 *
871 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html
872 */
873 interface MethodSettingProperty {
874 /**
875 * Specifies whether the cached responses are encrypted.
876 *
877 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachedataencrypted
878 */
879 readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
880 /**
881 * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
882 *
883 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachettlinseconds
884 */
885 readonly cacheTtlInSeconds?: number;
886 /**
887 * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
888 *
889 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachingenabled
890 */
891 readonly cachingEnabled?: boolean | cdk.IResolvable;
892 /**
893 * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
894 *
895 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-datatraceenabled
896 */
897 readonly dataTraceEnabled?: boolean | cdk.IResolvable;
898 /**
899 * The HTTP method.
900 *
901 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-httpmethod
902 */
903 readonly httpMethod?: string;
904 /**
905 * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events.
906 *
907 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-logginglevel
908 */
909 readonly loggingLevel?: string;
910 /**
911 * Specifies whether Amazon CloudWatch metrics are enabled for this method.
912 *
913 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-metricsenabled
914 */
915 readonly metricsEnabled?: boolean | cdk.IResolvable;
916 /**
917 * The resource path for this method. Forward slashes ( `/` ) are encoded as `~1` and the initial slash must include a forward slash. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource` . To specify the root path, use only a slash ( `/` ).
918 *
919 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-resourcepath
920 */
921 readonly resourcePath?: string;
922 /**
923 * Specifies the throttling burst limit.
924 *
925 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingburstlimit
926 */
927 readonly throttlingBurstLimit?: number;
928 /**
929 * Specifies the throttling rate limit.
930 *
931 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingratelimit
932 */
933 readonly throttlingRateLimit?: number;
934 }
935}
936export declare namespace CfnDeployment {
937 /**
938 * `StageDescription` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.
939 *
940 * @struct
941 * @stability external
942 *
943 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html
944 */
945 interface StageDescriptionProperty {
946 /**
947 * Specifies settings for logging access in this stage.
948 *
949 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting
950 */
951 readonly accessLogSetting?: CfnDeployment.AccessLogSettingProperty | cdk.IResolvable;
952 /**
953 * Specifies whether a cache cluster is enabled for the stage.
954 *
955 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled
956 */
957 readonly cacheClusterEnabled?: boolean | cdk.IResolvable;
958 /**
959 * The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference* .
960 *
961 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize
962 */
963 readonly cacheClusterSize?: string;
964 /**
965 * Indicates whether the cached responses are encrypted.
966 *
967 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted
968 */
969 readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
970 /**
971 * The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
972 *
973 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds
974 */
975 readonly cacheTtlInSeconds?: number;
976 /**
977 * Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide* .
978 *
979 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled
980 */
981 readonly cachingEnabled?: boolean | cdk.IResolvable;
982 /**
983 * Specifies settings for the canary deployment in this stage.
984 *
985 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting
986 */
987 readonly canarySetting?: CfnDeployment.CanarySettingProperty | cdk.IResolvable;
988 /**
989 * The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
990 *
991 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid
992 */
993 readonly clientCertificateId?: string;
994 /**
995 * Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
996 *
997 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled
998 */
999 readonly dataTraceEnabled?: boolean | cdk.IResolvable;
1000 /**
1001 * A description of the purpose of the stage.
1002 *
1003 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description
1004 */
1005 readonly description?: string;
1006 /**
1007 * The version identifier of the API documentation snapshot.
1008 *
1009 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion
1010 */
1011 readonly documentationVersion?: string;
1012 /**
1013 * The logging level for this method. For valid values, see the `loggingLevel` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference* .
1014 *
1015 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel
1016 */
1017 readonly loggingLevel?: string;
1018 /**
1019 * Configures settings for all of the stage's methods.
1020 *
1021 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings
1022 */
1023 readonly methodSettings?: Array<CfnDeployment.MethodSettingProperty | cdk.IResolvable> | cdk.IResolvable;
1024 /**
1025 * Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
1026 *
1027 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled
1028 */
1029 readonly metricsEnabled?: boolean | cdk.IResolvable;
1030 /**
1031 * An array of arbitrary tags (key-value pairs) to associate with the stage.
1032 *
1033 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags
1034 */
1035 readonly tags?: cdk.CfnTag[];
1036 /**
1037 * The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .
1038 *
1039 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit
1040 */
1041 readonly throttlingBurstLimit?: number;
1042 /**
1043 * The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .
1044 *
1045 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit
1046 */
1047 readonly throttlingRateLimit?: number;
1048 /**
1049 * Specifies whether active tracing with X-ray is enabled for this stage.
1050 *
1051 * For more information, see [Trace API Gateway API Execution with AWS X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide* .
1052 *
1053 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled
1054 */
1055 readonly tracingEnabled?: boolean | cdk.IResolvable;
1056 /**
1057 * A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .
1058 *
1059 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables
1060 */
1061 readonly variables?: {
1062 [key: string]: (string);
1063 } | cdk.IResolvable;
1064 }
1065}
1066/**
1067 * Properties for defining a `CfnDocumentationPart`
1068 *
1069 * @struct
1070 * @stability external
1071 *
1072 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html
1073 */
1074export interface CfnDocumentationPartProps {
1075 /**
1076 * The location of the targeted API entity of the to-be-created documentation part.
1077 *
1078 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
1079 */
1080 readonly location: CfnDocumentationPart.LocationProperty | cdk.IResolvable;
1081 /**
1082 * The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
1083 *
1084 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
1085 */
1086 readonly properties: string;
1087 /**
1088 * The string identifier of the associated RestApi.
1089 *
1090 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid
1091 */
1092 readonly restApiId: string;
1093}
1094/**
1095 * A CloudFormation `AWS::ApiGateway::DocumentationPart`
1096 *
1097 * The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide* .
1098 *
1099 * @cloudformationResource AWS::ApiGateway::DocumentationPart
1100 * @stability external
1101 *
1102 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html
1103 */
1104export declare class CfnDocumentationPart extends cdk.CfnResource implements cdk.IInspectable {
1105 /**
1106 * The CloudFormation resource type name for this resource class.
1107 */
1108 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::DocumentationPart";
1109 /**
1110 * A factory method that creates a new instance of this class from an object
1111 * containing the CloudFormation properties of this resource.
1112 * Used in the @aws-cdk/cloudformation-include module.
1113 *
1114 * @internal
1115 */
1116 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDocumentationPart;
1117 /**
1118 * The ID for the documentation part.
1119 * @cloudformationAttribute DocumentationPartId
1120 */
1121 readonly attrDocumentationPartId: string;
1122 /**
1123 * The location of the targeted API entity of the to-be-created documentation part.
1124 *
1125 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
1126 */
1127 location: CfnDocumentationPart.LocationProperty | cdk.IResolvable;
1128 /**
1129 * The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
1130 *
1131 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
1132 */
1133 properties: string;
1134 /**
1135 * The string identifier of the associated RestApi.
1136 *
1137 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid
1138 */
1139 restApiId: string;
1140 /**
1141 * Create a new `AWS::ApiGateway::DocumentationPart`.
1142 *
1143 * @param scope - scope in which this resource is defined
1144 * @param id - scoped id of the resource
1145 * @param props - resource properties
1146 */
1147 constructor(scope: cdk.Construct, id: string, props: CfnDocumentationPartProps);
1148 /**
1149 * Examines the CloudFormation resource and discloses attributes.
1150 *
1151 * @param inspector - tree inspector to collect and process attributes
1152 *
1153 */
1154 inspect(inspector: cdk.TreeInspector): void;
1155 protected get cfnProperties(): {
1156 [key: string]: any;
1157 };
1158 protected renderProperties(props: {
1159 [key: string]: any;
1160 }): {
1161 [key: string]: any;
1162 };
1163}
1164export declare namespace CfnDocumentationPart {
1165 /**
1166 * The `Location` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. `Location` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.
1167 *
1168 * > For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference* .
1169 *
1170 * @struct
1171 * @stability external
1172 *
1173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html
1174 */
1175 interface LocationProperty {
1176 /**
1177 * The HTTP verb of a method. It is a valid field for the API entity types of `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly.
1178 *
1179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method
1180 */
1181 readonly method?: string;
1182 /**
1183 * The name of the targeted API entity. It is a valid and required field for the API entity types of `AUTHORIZER` , `MODEL` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` and `RESPONSE_HEADER` . It is an invalid field for any other entity type.
1184 *
1185 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name
1186 */
1187 readonly name?: string;
1188 /**
1189 * The URL path of the target. It is a valid field for the API entity types of `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `/` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix.
1190 *
1191 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path
1192 */
1193 readonly path?: string;
1194 /**
1195 * The HTTP status code of a response. It is a valid field for the API entity types of `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly.
1196 *
1197 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode
1198 */
1199 readonly statusCode?: string;
1200 /**
1201 * The type of API entity to which the documentation content applies. Valid values are `API` , `AUTHORIZER` , `MODEL` , `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . Content inheritance does not apply to any entity of the `API` , `AUTHORIZER` , `METHOD` , `MODEL` , `REQUEST_BODY` , or `RESOURCE` type.
1202 *
1203 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type
1204 */
1205 readonly type?: string;
1206 }
1207}
1208/**
1209 * Properties for defining a `CfnDocumentationVersion`
1210 *
1211 * @struct
1212 * @stability external
1213 *
1214 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html
1215 */
1216export interface CfnDocumentationVersionProps {
1217 /**
1218 * The version identifier of the to-be-updated documentation version.
1219 *
1220 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
1221 */
1222 readonly documentationVersion: string;
1223 /**
1224 * The string identifier of the associated RestApi.
1225 *
1226 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid
1227 */
1228 readonly restApiId: string;
1229 /**
1230 * A description about the new documentation snapshot.
1231 *
1232 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description
1233 */
1234 readonly description?: string;
1235}
1236/**
1237 * A CloudFormation `AWS::ApiGateway::DocumentationVersion`
1238 *
1239 * The `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide* .
1240 *
1241 * @cloudformationResource AWS::ApiGateway::DocumentationVersion
1242 * @stability external
1243 *
1244 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html
1245 */
1246export declare class CfnDocumentationVersion extends cdk.CfnResource implements cdk.IInspectable {
1247 /**
1248 * The CloudFormation resource type name for this resource class.
1249 */
1250 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::DocumentationVersion";
1251 /**
1252 * A factory method that creates a new instance of this class from an object
1253 * containing the CloudFormation properties of this resource.
1254 * Used in the @aws-cdk/cloudformation-include module.
1255 *
1256 * @internal
1257 */
1258 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDocumentationVersion;
1259 /**
1260 * The version identifier of the to-be-updated documentation version.
1261 *
1262 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
1263 */
1264 documentationVersion: string;
1265 /**
1266 * The string identifier of the associated RestApi.
1267 *
1268 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid
1269 */
1270 restApiId: string;
1271 /**
1272 * A description about the new documentation snapshot.
1273 *
1274 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description
1275 */
1276 description: string | undefined;
1277 /**
1278 * Create a new `AWS::ApiGateway::DocumentationVersion`.
1279 *
1280 * @param scope - scope in which this resource is defined
1281 * @param id - scoped id of the resource
1282 * @param props - resource properties
1283 */
1284 constructor(scope: cdk.Construct, id: string, props: CfnDocumentationVersionProps);
1285 /**
1286 * Examines the CloudFormation resource and discloses attributes.
1287 *
1288 * @param inspector - tree inspector to collect and process attributes
1289 *
1290 */
1291 inspect(inspector: cdk.TreeInspector): void;
1292 protected get cfnProperties(): {
1293 [key: string]: any;
1294 };
1295 protected renderProperties(props: {
1296 [key: string]: any;
1297 }): {
1298 [key: string]: any;
1299 };
1300}
1301/**
1302 * Properties for defining a `CfnDomainName`
1303 *
1304 * @struct
1305 * @stability external
1306 *
1307 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
1308 */
1309export interface CfnDomainNameProps {
1310 /**
1311 * The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
1312 *
1313 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn
1314 */
1315 readonly certificateArn?: string;
1316 /**
1317 * The custom domain name as an API host name, for example, `my-api.example.com` .
1318 *
1319 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
1320 */
1321 readonly domainName?: string;
1322 /**
1323 * The endpoint configuration of this DomainName showing the endpoint types of the domain name.
1324 *
1325 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
1326 */
1327 readonly endpointConfiguration?: CfnDomainName.EndpointConfigurationProperty | cdk.IResolvable;
1328 /**
1329 * The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
1330 *
1331 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication
1332 */
1333 readonly mutualTlsAuthentication?: CfnDomainName.MutualTlsAuthenticationProperty | cdk.IResolvable;
1334 /**
1335 * The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
1336 *
1337 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn
1338 */
1339 readonly ownershipVerificationCertificateArn?: string;
1340 /**
1341 * The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
1342 *
1343 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn
1344 */
1345 readonly regionalCertificateArn?: string;
1346 /**
1347 * The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2` .
1348 *
1349 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy
1350 */
1351 readonly securityPolicy?: string;
1352 /**
1353 * The collection of tags. Each tag element is associated with a given resource.
1354 *
1355 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags
1356 */
1357 readonly tags?: cdk.CfnTag[];
1358}
1359/**
1360 * A CloudFormation `AWS::ApiGateway::DomainName`
1361 *
1362 * The `AWS::ApiGateway::DomainName` resource specifies a custom domain name for your API in API Gateway.
1363 *
1364 * You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide* .
1365 *
1366 * @cloudformationResource AWS::ApiGateway::DomainName
1367 * @stability external
1368 *
1369 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
1370 */
1371export declare class CfnDomainName extends cdk.CfnResource implements cdk.IInspectable {
1372 /**
1373 * The CloudFormation resource type name for this resource class.
1374 */
1375 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::DomainName";
1376 /**
1377 * A factory method that creates a new instance of this class from an object
1378 * containing the CloudFormation properties of this resource.
1379 * Used in the @aws-cdk/cloudformation-include module.
1380 *
1381 * @internal
1382 */
1383 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDomainName;
1384 /**
1385 * The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is `EDGE` .
1386 *
1387 * Example: `d111111abcdef8.cloudfront.net`
1388 * @cloudformationAttribute DistributionDomainName
1389 */
1390 readonly attrDistributionDomainName: string;
1391 /**
1392 * The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is `Z2FDTNDATAQYW2` for all regions.
1393 * @cloudformationAttribute DistributionHostedZoneId
1394 */
1395 readonly attrDistributionHostedZoneId: string;
1396 /**
1397 * The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.
1398 * @cloudformationAttribute RegionalDomainName
1399 */
1400 readonly attrRegionalDomainName: string;
1401 /**
1402 * The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
1403 * @cloudformationAttribute RegionalHostedZoneId
1404 */
1405 readonly attrRegionalHostedZoneId: string;
1406 /**
1407 * The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
1408 *
1409 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn
1410 */
1411 certificateArn: string | undefined;
1412 /**
1413 * The custom domain name as an API host name, for example, `my-api.example.com` .
1414 *
1415 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
1416 */
1417 domainName: string | undefined;
1418 /**
1419 * The endpoint configuration of this DomainName showing the endpoint types of the domain name.
1420 *
1421 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
1422 */
1423 endpointConfiguration: CfnDomainName.EndpointConfigurationProperty | cdk.IResolvable | undefined;
1424 /**
1425 * The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
1426 *
1427 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication
1428 */
1429 mutualTlsAuthentication: CfnDomainName.MutualTlsAuthenticationProperty | cdk.IResolvable | undefined;
1430 /**
1431 * The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
1432 *
1433 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn
1434 */
1435 ownershipVerificationCertificateArn: string | undefined;
1436 /**
1437 * The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
1438 *
1439 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn
1440 */
1441 regionalCertificateArn: string | undefined;
1442 /**
1443 * The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2` .
1444 *
1445 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy
1446 */
1447 securityPolicy: string | undefined;
1448 /**
1449 * The collection of tags. Each tag element is associated with a given resource.
1450 *
1451 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags
1452 */
1453 readonly tags: cdk.TagManager;
1454 /**
1455 * Create a new `AWS::ApiGateway::DomainName`.
1456 *
1457 * @param scope - scope in which this resource is defined
1458 * @param id - scoped id of the resource
1459 * @param props - resource properties
1460 */
1461 constructor(scope: cdk.Construct, id: string, props?: CfnDomainNameProps);
1462 /**
1463 * Examines the CloudFormation resource and discloses attributes.
1464 *
1465 * @param inspector - tree inspector to collect and process attributes
1466 *
1467 */
1468 inspect(inspector: cdk.TreeInspector): void;
1469 protected get cfnProperties(): {
1470 [key: string]: any;
1471 };
1472 protected renderProperties(props: {
1473 [key: string]: any;
1474 }): {
1475 [key: string]: any;
1476 };
1477}
1478export declare namespace CfnDomainName {
1479 /**
1480 * The `EndpointConfiguration` property type specifies the endpoint types of an Amazon API Gateway domain name.
1481 *
1482 * `EndpointConfiguration` is a property of the [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.
1483 *
1484 * @struct
1485 * @stability external
1486 *
1487 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html
1488 */
1489 interface EndpointConfigurationProperty {
1490 /**
1491 * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `"EDGE"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` .
1492 *
1493 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types
1494 */
1495 readonly types?: string[];
1496 }
1497}
1498export declare namespace CfnDomainName {
1499 /**
1500 * The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
1501 *
1502 * @struct
1503 * @stability external
1504 *
1505 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html
1506 */
1507 interface MutualTlsAuthenticationProperty {
1508 /**
1509 * An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name` . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
1510 *
1511 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri
1512 */
1513 readonly truststoreUri?: string;
1514 /**
1515 * The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
1516 *
1517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion
1518 */
1519 readonly truststoreVersion?: string;
1520 }
1521}
1522/**
1523 * Properties for defining a `CfnGatewayResponse`
1524 *
1525 * @struct
1526 * @stability external
1527 *
1528 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html
1529 */
1530export interface CfnGatewayResponseProps {
1531 /**
1532 * The response type of the associated GatewayResponse.
1533 *
1534 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
1535 */
1536 readonly responseType: string;
1537 /**
1538 * The string identifier of the associated RestApi.
1539 *
1540 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid
1541 */
1542 readonly restApiId: string;
1543 /**
1544 * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
1545 *
1546 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
1547 */
1548 readonly responseParameters?: {
1549 [key: string]: (string);
1550 } | cdk.IResolvable;
1551 /**
1552 * Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
1553 *
1554 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
1555 */
1556 readonly responseTemplates?: {
1557 [key: string]: (string);
1558 } | cdk.IResolvable;
1559 /**
1560 * The HTTP status code for this GatewayResponse.
1561 *
1562 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode
1563 */
1564 readonly statusCode?: string;
1565}
1566/**
1567 * A CloudFormation `AWS::ApiGateway::GatewayResponse`
1568 *
1569 * The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide* .
1570 *
1571 * @cloudformationResource AWS::ApiGateway::GatewayResponse
1572 * @stability external
1573 *
1574 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html
1575 */
1576export declare class CfnGatewayResponse extends cdk.CfnResource implements cdk.IInspectable {
1577 /**
1578 * The CloudFormation resource type name for this resource class.
1579 */
1580 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::GatewayResponse";
1581 /**
1582 * A factory method that creates a new instance of this class from an object
1583 * containing the CloudFormation properties of this resource.
1584 * Used in the @aws-cdk/cloudformation-include module.
1585 *
1586 * @internal
1587 */
1588 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGatewayResponse;
1589 /**
1590 * The ID for the gateway response. For example: `abc123` .
1591 * @cloudformationAttribute Id
1592 */
1593 readonly attrId: string;
1594 /**
1595 * The response type of the associated GatewayResponse.
1596 *
1597 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
1598 */
1599 responseType: string;
1600 /**
1601 * The string identifier of the associated RestApi.
1602 *
1603 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid
1604 */
1605 restApiId: string;
1606 /**
1607 * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
1608 *
1609 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
1610 */
1611 responseParameters: {
1612 [key: string]: (string);
1613 } | cdk.IResolvable | undefined;
1614 /**
1615 * Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
1616 *
1617 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
1618 */
1619 responseTemplates: {
1620 [key: string]: (string);
1621 } | cdk.IResolvable | undefined;
1622 /**
1623 * The HTTP status code for this GatewayResponse.
1624 *
1625 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode
1626 */
1627 statusCode: string | undefined;
1628 /**
1629 * Create a new `AWS::ApiGateway::GatewayResponse`.
1630 *
1631 * @param scope - scope in which this resource is defined
1632 * @param id - scoped id of the resource
1633 * @param props - resource properties
1634 */
1635 constructor(scope: cdk.Construct, id: string, props: CfnGatewayResponseProps);
1636 /**
1637 * Examines the CloudFormation resource and discloses attributes.
1638 *
1639 * @param inspector - tree inspector to collect and process attributes
1640 *
1641 */
1642 inspect(inspector: cdk.TreeInspector): void;
1643 protected get cfnProperties(): {
1644 [key: string]: any;
1645 };
1646 protected renderProperties(props: {
1647 [key: string]: any;
1648 }): {
1649 [key: string]: any;
1650 };
1651}
1652/**
1653 * Properties for defining a `CfnMethod`
1654 *
1655 * @struct
1656 * @stability external
1657 *
1658 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
1659 */
1660export interface CfnMethodProps {
1661 /**
1662 * The method's HTTP verb.
1663 *
1664 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
1665 */
1666 readonly httpMethod: string;
1667 /**
1668 * The Resource identifier for the MethodResponse resource.
1669 *
1670 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
1671 */
1672 readonly resourceId: string;
1673 /**
1674 * The string identifier of the associated RestApi.
1675 *
1676 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
1677 */
1678 readonly restApiId: string;
1679 /**
1680 * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
1681 *
1682 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
1683 */
1684 readonly apiKeyRequired?: boolean | cdk.IResolvable;
1685 /**
1686 * A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
1687 *
1688 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
1689 */
1690 readonly authorizationScopes?: string[];
1691 /**
1692 * The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference* .
1693 *
1694 * > If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.
1695 *
1696 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
1697 */
1698 readonly authorizationType?: string;
1699 /**
1700 * The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .
1701 *
1702 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
1703 */
1704 readonly authorizerId?: string;
1705 /**
1706 * Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.
1707 *
1708 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
1709 */
1710 readonly integration?: CfnMethod.IntegrationProperty | cdk.IResolvable;
1711 /**
1712 * Gets a method response associated with a given HTTP status code.
1713 *
1714 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
1715 */
1716 readonly methodResponses?: Array<CfnMethod.MethodResponseProperty | cdk.IResolvable> | cdk.IResolvable;
1717 /**
1718 * A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.
1719 *
1720 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
1721 */
1722 readonly operationName?: string;
1723 /**
1724 * A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
1725 *
1726 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
1727 */
1728 readonly requestModels?: {
1729 [key: string]: (string);
1730 } | cdk.IResolvable;
1731 /**
1732 * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( `true` ) or optional ( `false` ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
1733 *
1734 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
1735 */
1736 readonly requestParameters?: {
1737 [key: string]: (boolean | cdk.IResolvable);
1738 } | cdk.IResolvable;
1739 /**
1740 * The identifier of a RequestValidator for request validation.
1741 *
1742 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
1743 */
1744 readonly requestValidatorId?: string;
1745}
1746/**
1747 * A CloudFormation `AWS::ApiGateway::Method`
1748 *
1749 * The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
1750 *
1751 * @cloudformationResource AWS::ApiGateway::Method
1752 * @stability external
1753 *
1754 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
1755 */
1756export declare class CfnMethod extends cdk.CfnResource implements cdk.IInspectable {
1757 /**
1758 * The CloudFormation resource type name for this resource class.
1759 */
1760 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Method";
1761 /**
1762 * A factory method that creates a new instance of this class from an object
1763 * containing the CloudFormation properties of this resource.
1764 * Used in the @aws-cdk/cloudformation-include module.
1765 *
1766 * @internal
1767 */
1768 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMethod;
1769 /**
1770 * The method's HTTP verb.
1771 *
1772 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
1773 */
1774 httpMethod: string;
1775 /**
1776 * The Resource identifier for the MethodResponse resource.
1777 *
1778 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
1779 */
1780 resourceId: string;
1781 /**
1782 * The string identifier of the associated RestApi.
1783 *
1784 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
1785 */
1786 restApiId: string;
1787 /**
1788 * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
1789 *
1790 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
1791 */
1792 apiKeyRequired: boolean | cdk.IResolvable | undefined;
1793 /**
1794 * A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
1795 *
1796 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
1797 */
1798 authorizationScopes: string[] | undefined;
1799 /**
1800 * The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference* .
1801 *
1802 * > If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.
1803 *
1804 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
1805 */
1806 authorizationType: string | undefined;
1807 /**
1808 * The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .
1809 *
1810 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
1811 */
1812 authorizerId: string | undefined;
1813 /**
1814 * Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.
1815 *
1816 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
1817 */
1818 integration: CfnMethod.IntegrationProperty | cdk.IResolvable | undefined;
1819 /**
1820 * Gets a method response associated with a given HTTP status code.
1821 *
1822 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
1823 */
1824 methodResponses: Array<CfnMethod.MethodResponseProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1825 /**
1826 * A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.
1827 *
1828 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
1829 */
1830 operationName: string | undefined;
1831 /**
1832 * A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
1833 *
1834 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
1835 */
1836 requestModels: {
1837 [key: string]: (string);
1838 } | cdk.IResolvable | undefined;
1839 /**
1840 * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( `true` ) or optional ( `false` ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
1841 *
1842 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
1843 */
1844 requestParameters: {
1845 [key: string]: (boolean | cdk.IResolvable);
1846 } | cdk.IResolvable | undefined;
1847 /**
1848 * The identifier of a RequestValidator for request validation.
1849 *
1850 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
1851 */
1852 requestValidatorId: string | undefined;
1853 /**
1854 * Create a new `AWS::ApiGateway::Method`.
1855 *
1856 * @param scope - scope in which this resource is defined
1857 * @param id - scoped id of the resource
1858 * @param props - resource properties
1859 */
1860 constructor(scope: cdk.Construct, id: string, props: CfnMethodProps);
1861 /**
1862 * Examines the CloudFormation resource and discloses attributes.
1863 *
1864 * @param inspector - tree inspector to collect and process attributes
1865 *
1866 */
1867 inspect(inspector: cdk.TreeInspector): void;
1868 protected get cfnProperties(): {
1869 [key: string]: any;
1870 };
1871 protected renderProperties(props: {
1872 [key: string]: any;
1873 }): {
1874 [key: string]: any;
1875 };
1876}
1877export declare namespace CfnMethod {
1878 /**
1879 * `Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.
1880 *
1881 * @struct
1882 * @stability external
1883 *
1884 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html
1885 */
1886 interface IntegrationProperty {
1887 /**
1888 * A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters` , these parameters must also be specified for Method `requestParameters` .
1889 *
1890 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters
1891 */
1892 readonly cacheKeyParameters?: string[];
1893 /**
1894 * Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace` . You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.
1895 *
1896 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace
1897 */
1898 readonly cacheNamespace?: string;
1899 /**
1900 * The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
1901 *
1902 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectionid
1903 */
1904 readonly connectionId?: string;
1905 /**
1906 * The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET` .
1907 *
1908 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectiontype
1909 */
1910 readonly connectionType?: string;
1911 /**
1912 * Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:
1913 *
1914 * If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.
1915 *
1916 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling
1917 */
1918 readonly contentHandling?: string;
1919 /**
1920 * Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*` . To use resource-based permissions on supported AWS services, specify null.
1921 *
1922 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials
1923 */
1924 readonly credentials?: string;
1925 /**
1926 * Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK` , this property is optional. For Lambda integrations, you must set the integration method to `POST` . For all other types, you must specify this property.
1927 *
1928 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod
1929 */
1930 readonly integrationHttpMethod?: string;
1931 /**
1932 * Specifies the integration's responses.
1933 *
1934 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses
1935 */
1936 readonly integrationResponses?: Array<CfnMethod.IntegrationResponseProperty | cdk.IResolvable> | cdk.IResolvable;
1937 /**
1938 * Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates` . The valid value is one of the following: `WHEN_NO_MATCH` : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES` : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER` : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
1939 *
1940 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior
1941 */
1942 readonly passthroughBehavior?: string;
1943 /**
1944 * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` must be a valid and unique method request parameter name.
1945 *
1946 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters
1947 */
1948 readonly requestParameters?: {
1949 [key: string]: (string);
1950 } | cdk.IResolvable;
1951 /**
1952 * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
1953 *
1954 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates
1955 */
1956 readonly requestTemplates?: {
1957 [key: string]: (string);
1958 } | cdk.IResolvable;
1959 /**
1960 * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
1961 *
1962 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis
1963 */
1964 readonly timeoutInMillis?: number;
1965 /**
1966 * Specifies an API method integration type. The valid value is one of the following:
1967 *
1968 * For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( `http/https` ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
1969 *
1970 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type
1971 */
1972 readonly type?: string;
1973 /**
1974 * Specifies Uniform Resource Identifier (URI) of the integration endpoint.
1975 *
1976 * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}` . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
1977 *
1978 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri
1979 */
1980 readonly uri?: string;
1981 }
1982}
1983export declare namespace CfnMethod {
1984 /**
1985 * `IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
1986 *
1987 * @struct
1988 * @stability external
1989 *
1990 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html
1991 */
1992 interface IntegrationResponseProperty {
1993 /**
1994 * Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:
1995 *
1996 * If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
1997 *
1998 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling
1999 */
2000 readonly contentHandling?: string;
2001 /**
2002 * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}` , where `name` is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}` , where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix.
2003 *
2004 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters
2005 */
2006 readonly responseParameters?: {
2007 [key: string]: (string);
2008 } | cdk.IResolvable;
2009 /**
2010 * Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
2011 *
2012 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates
2013 */
2014 readonly responseTemplates?: {
2015 [key: string]: (string);
2016 } | cdk.IResolvable;
2017 /**
2018 * Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response. However, make sure that the error response does not contain any newline ( `\n` ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
2019 *
2020 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern
2021 */
2022 readonly selectionPattern?: string;
2023 /**
2024 * Specifies the status code that is used to map the integration response to an existing MethodResponse.
2025 *
2026 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode
2027 */
2028 readonly statusCode: string;
2029 }
2030}
2031export declare namespace CfnMethod {
2032 /**
2033 * Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
2034 *
2035 * @struct
2036 * @stability external
2037 *
2038 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html
2039 */
2040 interface MethodResponseProperty {
2041 /**
2042 * Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
2043 *
2044 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels
2045 */
2046 readonly responseModels?: {
2047 [key: string]: (string);
2048 } | cdk.IResolvable;
2049 /**
2050 * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern `method.response.header.{name}` , where `name` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}` , a static value enclosed within a pair of single quotes (e.g., `'application/json'` ), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}` , where `JSON-expression` is a valid JSON expression without the `$` prefix.)
2051 *
2052 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters
2053 */
2054 readonly responseParameters?: {
2055 [key: string]: (boolean | cdk.IResolvable);
2056 } | cdk.IResolvable;
2057 /**
2058 * The method response's status code.
2059 *
2060 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode
2061 */
2062 readonly statusCode: string;
2063 }
2064}
2065/**
2066 * Properties for defining a `CfnModel`
2067 *
2068 * @struct
2069 * @stability external
2070 *
2071 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html
2072 */
2073export interface CfnModelProps {
2074 /**
2075 * The string identifier of the associated RestApi.
2076 *
2077 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
2078 */
2079 readonly restApiId: string;
2080 /**
2081 * The content-type for the model.
2082 *
2083 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype
2084 */
2085 readonly contentType?: string;
2086 /**
2087 * The description of the model.
2088 *
2089 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description
2090 */
2091 readonly description?: string;
2092 /**
2093 * A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
2094 *
2095 * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
2096 *
2097 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name
2098 */
2099 readonly name?: string;
2100 /**
2101 * The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
2102 *
2103 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema
2104 */
2105 readonly schema?: any | cdk.IResolvable;
2106}
2107/**
2108 * A CloudFormation `AWS::ApiGateway::Model`
2109 *
2110 * The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.
2111 *
2112 * @cloudformationResource AWS::ApiGateway::Model
2113 * @stability external
2114 *
2115 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html
2116 */
2117export declare class CfnModel extends cdk.CfnResource implements cdk.IInspectable {
2118 /**
2119 * The CloudFormation resource type name for this resource class.
2120 */
2121 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Model";
2122 /**
2123 * A factory method that creates a new instance of this class from an object
2124 * containing the CloudFormation properties of this resource.
2125 * Used in the @aws-cdk/cloudformation-include module.
2126 *
2127 * @internal
2128 */
2129 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnModel;
2130 /**
2131 * The string identifier of the associated RestApi.
2132 *
2133 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
2134 */
2135 restApiId: string;
2136 /**
2137 * The content-type for the model.
2138 *
2139 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype
2140 */
2141 contentType: string | undefined;
2142 /**
2143 * The description of the model.
2144 *
2145 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description
2146 */
2147 description: string | undefined;
2148 /**
2149 * A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
2150 *
2151 * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
2152 *
2153 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name
2154 */
2155 name: string | undefined;
2156 /**
2157 * The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
2158 *
2159 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema
2160 */
2161 schema: any | cdk.IResolvable | undefined;
2162 /**
2163 * Create a new `AWS::ApiGateway::Model`.
2164 *
2165 * @param scope - scope in which this resource is defined
2166 * @param id - scoped id of the resource
2167 * @param props - resource properties
2168 */
2169 constructor(scope: cdk.Construct, id: string, props: CfnModelProps);
2170 /**
2171 * Examines the CloudFormation resource and discloses attributes.
2172 *
2173 * @param inspector - tree inspector to collect and process attributes
2174 *
2175 */
2176 inspect(inspector: cdk.TreeInspector): void;
2177 protected get cfnProperties(): {
2178 [key: string]: any;
2179 };
2180 protected renderProperties(props: {
2181 [key: string]: any;
2182 }): {
2183 [key: string]: any;
2184 };
2185}
2186/**
2187 * Properties for defining a `CfnRequestValidator`
2188 *
2189 * @struct
2190 * @stability external
2191 *
2192 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html
2193 */
2194export interface CfnRequestValidatorProps {
2195 /**
2196 * The string identifier of the associated RestApi.
2197 *
2198 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
2199 */
2200 readonly restApiId: string;
2201 /**
2202 * The name of this RequestValidator
2203 *
2204 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
2205 */
2206 readonly name?: string;
2207 /**
2208 * A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
2209 *
2210 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
2211 */
2212 readonly validateRequestBody?: boolean | cdk.IResolvable;
2213 /**
2214 * A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).
2215 *
2216 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters
2217 */
2218 readonly validateRequestParameters?: boolean | cdk.IResolvable;
2219}
2220/**
2221 * A CloudFormation `AWS::ApiGateway::RequestValidator`
2222 *
2223 * The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide* .
2224 *
2225 * @cloudformationResource AWS::ApiGateway::RequestValidator
2226 * @stability external
2227 *
2228 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html
2229 */
2230export declare class CfnRequestValidator extends cdk.CfnResource implements cdk.IInspectable {
2231 /**
2232 * The CloudFormation resource type name for this resource class.
2233 */
2234 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::RequestValidator";
2235 /**
2236 * A factory method that creates a new instance of this class from an object
2237 * containing the CloudFormation properties of this resource.
2238 * Used in the @aws-cdk/cloudformation-include module.
2239 *
2240 * @internal
2241 */
2242 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRequestValidator;
2243 /**
2244 * The ID for the request validator. For example: `abc123` .
2245 * @cloudformationAttribute RequestValidatorId
2246 */
2247 readonly attrRequestValidatorId: string;
2248 /**
2249 * The string identifier of the associated RestApi.
2250 *
2251 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
2252 */
2253 restApiId: string;
2254 /**
2255 * The name of this RequestValidator
2256 *
2257 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
2258 */
2259 name: string | undefined;
2260 /**
2261 * A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
2262 *
2263 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
2264 */
2265 validateRequestBody: boolean | cdk.IResolvable | undefined;
2266 /**
2267 * A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).
2268 *
2269 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters
2270 */
2271 validateRequestParameters: boolean | cdk.IResolvable | undefined;
2272 /**
2273 * Create a new `AWS::ApiGateway::RequestValidator`.
2274 *
2275 * @param scope - scope in which this resource is defined
2276 * @param id - scoped id of the resource
2277 * @param props - resource properties
2278 */
2279 constructor(scope: cdk.Construct, id: string, props: CfnRequestValidatorProps);
2280 /**
2281 * Examines the CloudFormation resource and discloses attributes.
2282 *
2283 * @param inspector - tree inspector to collect and process attributes
2284 *
2285 */
2286 inspect(inspector: cdk.TreeInspector): void;
2287 protected get cfnProperties(): {
2288 [key: string]: any;
2289 };
2290 protected renderProperties(props: {
2291 [key: string]: any;
2292 }): {
2293 [key: string]: any;
2294 };
2295}
2296/**
2297 * Properties for defining a `CfnResource`
2298 *
2299 * @struct
2300 * @stability external
2301 *
2302 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html
2303 */
2304export interface CfnResourceProps {
2305 /**
2306 * The parent resource's identifier.
2307 *
2308 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
2309 */
2310 readonly parentId: string;
2311 /**
2312 * The last path segment for this resource.
2313 *
2314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
2315 */
2316 readonly pathPart: string;
2317 /**
2318 * The string identifier of the associated RestApi.
2319 *
2320 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid
2321 */
2322 readonly restApiId: string;
2323}
2324/**
2325 * A CloudFormation `AWS::ApiGateway::Resource`
2326 *
2327 * The `AWS::ApiGateway::Resource` resource creates a resource in an API.
2328 *
2329 * @cloudformationResource AWS::ApiGateway::Resource
2330 * @stability external
2331 *
2332 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html
2333 */
2334export declare class CfnResource extends cdk.CfnResource implements cdk.IInspectable {
2335 /**
2336 * The CloudFormation resource type name for this resource class.
2337 */
2338 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Resource";
2339 /**
2340 * A factory method that creates a new instance of this class from an object
2341 * containing the CloudFormation properties of this resource.
2342 * Used in the @aws-cdk/cloudformation-include module.
2343 *
2344 * @internal
2345 */
2346 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnResource;
2347 /**
2348 * The ID for the resource. For example: `abc123` .
2349 * @cloudformationAttribute ResourceId
2350 */
2351 readonly attrResourceId: string;
2352 /**
2353 * The parent resource's identifier.
2354 *
2355 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
2356 */
2357 parentId: string;
2358 /**
2359 * The last path segment for this resource.
2360 *
2361 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
2362 */
2363 pathPart: string;
2364 /**
2365 * The string identifier of the associated RestApi.
2366 *
2367 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid
2368 */
2369 restApiId: string;
2370 /**
2371 * Create a new `AWS::ApiGateway::Resource`.
2372 *
2373 * @param scope - scope in which this resource is defined
2374 * @param id - scoped id of the resource
2375 * @param props - resource properties
2376 */
2377 constructor(scope: cdk.Construct, id: string, props: CfnResourceProps);
2378 /**
2379 * Examines the CloudFormation resource and discloses attributes.
2380 *
2381 * @param inspector - tree inspector to collect and process attributes
2382 *
2383 */
2384 inspect(inspector: cdk.TreeInspector): void;
2385 protected get cfnProperties(): {
2386 [key: string]: any;
2387 };
2388 protected renderProperties(props: {
2389 [key: string]: any;
2390 }): {
2391 [key: string]: any;
2392 };
2393}
2394/**
2395 * Properties for defining a `CfnRestApi`
2396 *
2397 * @struct
2398 * @stability external
2399 *
2400 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
2401 */
2402export interface CfnRestApiProps {
2403 /**
2404 * The source of the API key for metering requests according to a usage plan. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.
2405 *
2406 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
2407 */
2408 readonly apiKeySourceType?: string;
2409 /**
2410 * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
2411 *
2412 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
2413 */
2414 readonly binaryMediaTypes?: string[];
2415 /**
2416 * An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
2417 *
2418 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body
2419 */
2420 readonly body?: any | cdk.IResolvable;
2421 /**
2422 * The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
2423 *
2424 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
2425 */
2426 readonly bodyS3Location?: CfnRestApi.S3LocationProperty | cdk.IResolvable;
2427 /**
2428 * The ID of the RestApi that you want to clone from.
2429 *
2430 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
2431 */
2432 readonly cloneFrom?: string;
2433 /**
2434 * The description of the RestApi.
2435 *
2436 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
2437 */
2438 readonly description?: string;
2439 /**
2440 * Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
2441 *
2442 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint
2443 */
2444 readonly disableExecuteApiEndpoint?: boolean | cdk.IResolvable;
2445 /**
2446 * A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the `Parameters` property.
2447 *
2448 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
2449 */
2450 readonly endpointConfiguration?: CfnRestApi.EndpointConfigurationProperty | cdk.IResolvable;
2451 /**
2452 * A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered. The default value is `false` .
2453 *
2454 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
2455 */
2456 readonly failOnWarnings?: boolean | cdk.IResolvable;
2457 /**
2458 * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
2459 *
2460 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
2461 */
2462 readonly minimumCompressionSize?: number;
2463 /**
2464 * This property applies only when you use OpenAPI to define your REST API. The `Mode` determines how API Gateway handles resource updates.
2465 *
2466 * Valid values are `overwrite` or `merge` .
2467 *
2468 * For `overwrite` , the new API definition replaces the existing one. The existing API identifier remains unchanged.
2469 *
2470 * For `merge` , the new API definition is merged with the existing API.
2471 *
2472 * If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is `overwrite` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
2473 *
2474 * Use the default mode to define top-level `RestApi` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
2475 *
2476 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
2477 */
2478 readonly mode?: string;
2479 /**
2480 * The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
2481 *
2482 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
2483 */
2484 readonly name?: string;
2485 /**
2486 * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'` .
2487 *
2488 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
2489 */
2490 readonly parameters?: {
2491 [key: string]: (string);
2492 } | cdk.IResolvable;
2493 /**
2494 * A policy document that contains the permissions for the `RestApi` resource. To set the ARN for the policy, use the `!Join` intrinsic function with `""` as delimiter and values of `"execute-api:/"` and `"*"` .
2495 *
2496 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy
2497 */
2498 readonly policy?: any | cdk.IResolvable;
2499 /**
2500 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.
2501 *
2502 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags
2503 */
2504 readonly tags?: cdk.CfnTag[];
2505}
2506/**
2507 * A CloudFormation `AWS::ApiGateway::RestApi`
2508 *
2509 * The `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference* .
2510 *
2511 * > On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/) , becoming the foundation of the OpenAPI Specification.
2512 *
2513 * @cloudformationResource AWS::ApiGateway::RestApi
2514 * @stability external
2515 *
2516 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
2517 */
2518export declare class CfnRestApi extends cdk.CfnResource implements cdk.IInspectable {
2519 /**
2520 * The CloudFormation resource type name for this resource class.
2521 */
2522 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::RestApi";
2523 /**
2524 * A factory method that creates a new instance of this class from an object
2525 * containing the CloudFormation properties of this resource.
2526 * Used in the @aws-cdk/cloudformation-include module.
2527 *
2528 * @internal
2529 */
2530 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRestApi;
2531 /**
2532 * The string identifier of the associated RestApi.
2533 * @cloudformationAttribute RestApiId
2534 */
2535 readonly attrRestApiId: string;
2536 /**
2537 * The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
2538 * @cloudformationAttribute RootResourceId
2539 */
2540 readonly attrRootResourceId: string;
2541 /**
2542 * The source of the API key for metering requests according to a usage plan. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.
2543 *
2544 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
2545 */
2546 apiKeySourceType: string | undefined;
2547 /**
2548 * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
2549 *
2550 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
2551 */
2552 binaryMediaTypes: string[] | undefined;
2553 /**
2554 * An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
2555 *
2556 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body
2557 */
2558 body: any | cdk.IResolvable | undefined;
2559 /**
2560 * The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
2561 *
2562 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
2563 */
2564 bodyS3Location: CfnRestApi.S3LocationProperty | cdk.IResolvable | undefined;
2565 /**
2566 * The ID of the RestApi that you want to clone from.
2567 *
2568 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
2569 */
2570 cloneFrom: string | undefined;
2571 /**
2572 * The description of the RestApi.
2573 *
2574 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
2575 */
2576 description: string | undefined;
2577 /**
2578 * Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
2579 *
2580 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint
2581 */
2582 disableExecuteApiEndpoint: boolean | cdk.IResolvable | undefined;
2583 /**
2584 * A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the `Parameters` property.
2585 *
2586 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
2587 */
2588 endpointConfiguration: CfnRestApi.EndpointConfigurationProperty | cdk.IResolvable | undefined;
2589 /**
2590 * A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered. The default value is `false` .
2591 *
2592 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
2593 */
2594 failOnWarnings: boolean | cdk.IResolvable | undefined;
2595 /**
2596 * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
2597 *
2598 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
2599 */
2600 minimumCompressionSize: number | undefined;
2601 /**
2602 * This property applies only when you use OpenAPI to define your REST API. The `Mode` determines how API Gateway handles resource updates.
2603 *
2604 * Valid values are `overwrite` or `merge` .
2605 *
2606 * For `overwrite` , the new API definition replaces the existing one. The existing API identifier remains unchanged.
2607 *
2608 * For `merge` , the new API definition is merged with the existing API.
2609 *
2610 * If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is `overwrite` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
2611 *
2612 * Use the default mode to define top-level `RestApi` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
2613 *
2614 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
2615 */
2616 mode: string | undefined;
2617 /**
2618 * The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
2619 *
2620 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
2621 */
2622 name: string | undefined;
2623 /**
2624 * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'` .
2625 *
2626 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
2627 */
2628 parameters: {
2629 [key: string]: (string);
2630 } | cdk.IResolvable | undefined;
2631 /**
2632 * A policy document that contains the permissions for the `RestApi` resource. To set the ARN for the policy, use the `!Join` intrinsic function with `""` as delimiter and values of `"execute-api:/"` and `"*"` .
2633 *
2634 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy
2635 */
2636 policy: any | cdk.IResolvable | undefined;
2637 /**
2638 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.
2639 *
2640 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags
2641 */
2642 readonly tags: cdk.TagManager;
2643 /**
2644 * Create a new `AWS::ApiGateway::RestApi`.
2645 *
2646 * @param scope - scope in which this resource is defined
2647 * @param id - scoped id of the resource
2648 * @param props - resource properties
2649 */
2650 constructor(scope: cdk.Construct, id: string, props?: CfnRestApiProps);
2651 /**
2652 * Examines the CloudFormation resource and discloses attributes.
2653 *
2654 * @param inspector - tree inspector to collect and process attributes
2655 *
2656 */
2657 inspect(inspector: cdk.TreeInspector): void;
2658 protected get cfnProperties(): {
2659 [key: string]: any;
2660 };
2661 protected renderProperties(props: {
2662 [key: string]: any;
2663 }): {
2664 [key: string]: any;
2665 };
2666}
2667export declare namespace CfnRestApi {
2668 /**
2669 * The `EndpointConfiguration` property type specifies the endpoint types of a REST API.
2670 *
2671 * `EndpointConfiguration` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
2672 *
2673 * @struct
2674 * @stability external
2675 *
2676 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
2677 */
2678 interface EndpointConfigurationProperty {
2679 /**
2680 * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `"EDGE"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` .
2681 *
2682 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types
2683 */
2684 readonly types?: string[];
2685 /**
2686 * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for `PRIVATE` endpoint type.
2687 *
2688 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids
2689 */
2690 readonly vpcEndpointIds?: string[];
2691 }
2692}
2693export declare namespace CfnRestApi {
2694 /**
2695 * `S3Location` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
2696 *
2697 * > On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/) , becoming the foundation of the OpenAPI Specification.
2698 *
2699 * @struct
2700 * @stability external
2701 *
2702 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html
2703 */
2704 interface S3LocationProperty {
2705 /**
2706 * The name of the S3 bucket where the OpenAPI file is stored.
2707 *
2708 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket
2709 */
2710 readonly bucket?: string;
2711 /**
2712 * The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
2713 *
2714 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag
2715 */
2716 readonly eTag?: string;
2717 /**
2718 * The file name of the OpenAPI file (Amazon S3 object name).
2719 *
2720 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key
2721 */
2722 readonly key?: string;
2723 /**
2724 * For versioning-enabled buckets, a specific version of the OpenAPI file.
2725 *
2726 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version
2727 */
2728 readonly version?: string;
2729 }
2730}
2731/**
2732 * Properties for defining a `CfnStage`
2733 *
2734 * @struct
2735 * @stability external
2736 *
2737 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html
2738 */
2739export interface CfnStageProps {
2740 /**
2741 * The string identifier of the associated RestApi.
2742 *
2743 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid
2744 */
2745 readonly restApiId: string;
2746 /**
2747 * Access log settings, including the access log format and access log destination ARN.
2748 *
2749 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting
2750 */
2751 readonly accessLogSetting?: CfnStage.AccessLogSettingProperty | cdk.IResolvable;
2752 /**
2753 * Specifies whether a cache cluster is enabled for the stage.
2754 *
2755 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled
2756 */
2757 readonly cacheClusterEnabled?: boolean | cdk.IResolvable;
2758 /**
2759 * The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) .
2760 *
2761 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize
2762 */
2763 readonly cacheClusterSize?: string;
2764 /**
2765 * Settings for the canary deployment in this stage.
2766 *
2767 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting
2768 */
2769 readonly canarySetting?: CfnStage.CanarySettingProperty | cdk.IResolvable;
2770 /**
2771 * The identifier of a client certificate for an API stage.
2772 *
2773 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid
2774 */
2775 readonly clientCertificateId?: string;
2776 /**
2777 * The identifier of the Deployment that the stage points to.
2778 *
2779 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
2780 */
2781 readonly deploymentId?: string;
2782 /**
2783 * The stage's description.
2784 *
2785 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description
2786 */
2787 readonly description?: string;
2788 /**
2789 * The version of the associated API documentation.
2790 *
2791 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion
2792 */
2793 readonly documentationVersion?: string;
2794 /**
2795 * A map that defines the method settings for a Stage resource. Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\* /\*` for overriding all methods in the stage.
2796 *
2797 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings
2798 */
2799 readonly methodSettings?: Array<CfnStage.MethodSettingProperty | cdk.IResolvable> | cdk.IResolvable;
2800 /**
2801 * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
2802 *
2803 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename
2804 */
2805 readonly stageName?: string;
2806 /**
2807 * The collection of tags. Each tag element is associated with a given resource.
2808 *
2809 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags
2810 */
2811 readonly tags?: cdk.CfnTag[];
2812 /**
2813 * Specifies whether active tracing with X-ray is enabled for the Stage.
2814 *
2815 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled
2816 */
2817 readonly tracingEnabled?: boolean | cdk.IResolvable;
2818 /**
2819 * A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .
2820 *
2821 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
2822 */
2823 readonly variables?: {
2824 [key: string]: (string);
2825 } | cdk.IResolvable;
2826}
2827/**
2828 * A CloudFormation `AWS::ApiGateway::Stage`
2829 *
2830 * The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.
2831 *
2832 * @cloudformationResource AWS::ApiGateway::Stage
2833 * @stability external
2834 *
2835 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html
2836 */
2837export declare class CfnStage extends cdk.CfnResource implements cdk.IInspectable {
2838 /**
2839 * The CloudFormation resource type name for this resource class.
2840 */
2841 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::Stage";
2842 /**
2843 * A factory method that creates a new instance of this class from an object
2844 * containing the CloudFormation properties of this resource.
2845 * Used in the @aws-cdk/cloudformation-include module.
2846 *
2847 * @internal
2848 */
2849 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnStage;
2850 /**
2851 * The string identifier of the associated RestApi.
2852 *
2853 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid
2854 */
2855 restApiId: string;
2856 /**
2857 * Access log settings, including the access log format and access log destination ARN.
2858 *
2859 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting
2860 */
2861 accessLogSetting: CfnStage.AccessLogSettingProperty | cdk.IResolvable | undefined;
2862 /**
2863 * Specifies whether a cache cluster is enabled for the stage.
2864 *
2865 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled
2866 */
2867 cacheClusterEnabled: boolean | cdk.IResolvable | undefined;
2868 /**
2869 * The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) .
2870 *
2871 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize
2872 */
2873 cacheClusterSize: string | undefined;
2874 /**
2875 * Settings for the canary deployment in this stage.
2876 *
2877 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting
2878 */
2879 canarySetting: CfnStage.CanarySettingProperty | cdk.IResolvable | undefined;
2880 /**
2881 * The identifier of a client certificate for an API stage.
2882 *
2883 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid
2884 */
2885 clientCertificateId: string | undefined;
2886 /**
2887 * The identifier of the Deployment that the stage points to.
2888 *
2889 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
2890 */
2891 deploymentId: string | undefined;
2892 /**
2893 * The stage's description.
2894 *
2895 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description
2896 */
2897 description: string | undefined;
2898 /**
2899 * The version of the associated API documentation.
2900 *
2901 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion
2902 */
2903 documentationVersion: string | undefined;
2904 /**
2905 * A map that defines the method settings for a Stage resource. Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\* /\*` for overriding all methods in the stage.
2906 *
2907 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings
2908 */
2909 methodSettings: Array<CfnStage.MethodSettingProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
2910 /**
2911 * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
2912 *
2913 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename
2914 */
2915 stageName: string | undefined;
2916 /**
2917 * The collection of tags. Each tag element is associated with a given resource.
2918 *
2919 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags
2920 */
2921 readonly tags: cdk.TagManager;
2922 /**
2923 * Specifies whether active tracing with X-ray is enabled for the Stage.
2924 *
2925 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled
2926 */
2927 tracingEnabled: boolean | cdk.IResolvable | undefined;
2928 /**
2929 * A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .
2930 *
2931 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
2932 */
2933 variables: {
2934 [key: string]: (string);
2935 } | cdk.IResolvable | undefined;
2936 /**
2937 * Create a new `AWS::ApiGateway::Stage`.
2938 *
2939 * @param scope - scope in which this resource is defined
2940 * @param id - scoped id of the resource
2941 * @param props - resource properties
2942 */
2943 constructor(scope: cdk.Construct, id: string, props: CfnStageProps);
2944 /**
2945 * Examines the CloudFormation resource and discloses attributes.
2946 *
2947 * @param inspector - tree inspector to collect and process attributes
2948 *
2949 */
2950 inspect(inspector: cdk.TreeInspector): void;
2951 protected get cfnProperties(): {
2952 [key: string]: any;
2953 };
2954 protected renderProperties(props: {
2955 [key: string]: any;
2956 }): {
2957 [key: string]: any;
2958 };
2959}
2960export declare namespace CfnStage {
2961 /**
2962 * The `AccessLogSetting` property type specifies settings for logging access in this stage.
2963 *
2964 * `AccessLogSetting` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
2965 *
2966 * @struct
2967 * @stability external
2968 *
2969 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html
2970 */
2971 interface AccessLogSettingProperty {
2972 /**
2973 * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` . This parameter is required to enable access logging.
2974 *
2975 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn
2976 */
2977 readonly destinationArn?: string;
2978 /**
2979 * A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least `$context.requestId` . This parameter is required to enable access logging.
2980 *
2981 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format
2982 */
2983 readonly format?: string;
2984 }
2985}
2986export declare namespace CfnStage {
2987 /**
2988 * Configuration settings of a canary deployment.
2989 *
2990 * @struct
2991 * @stability external
2992 *
2993 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html
2994 */
2995 interface CanarySettingProperty {
2996 /**
2997 * The ID of the canary deployment.
2998 *
2999 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid
3000 */
3001 readonly deploymentId?: string;
3002 /**
3003 * The percent (0-100) of traffic diverted to a canary deployment.
3004 *
3005 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic
3006 */
3007 readonly percentTraffic?: number;
3008 /**
3009 * Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
3010 *
3011 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides
3012 */
3013 readonly stageVariableOverrides?: {
3014 [key: string]: (string);
3015 } | cdk.IResolvable;
3016 /**
3017 * A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
3018 *
3019 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache
3020 */
3021 readonly useStageCache?: boolean | cdk.IResolvable;
3022 }
3023}
3024export declare namespace CfnStage {
3025 /**
3026 * The `MethodSetting` property type configures settings for all methods in a stage.
3027 *
3028 * The `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.
3029 *
3030 * @struct
3031 * @stability external
3032 *
3033 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html
3034 */
3035 interface MethodSettingProperty {
3036 /**
3037 * Specifies whether the cached responses are encrypted.
3038 *
3039 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted
3040 */
3041 readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
3042 /**
3043 * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
3044 *
3045 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds
3046 */
3047 readonly cacheTtlInSeconds?: number;
3048 /**
3049 * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
3050 *
3051 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled
3052 */
3053 readonly cachingEnabled?: boolean | cdk.IResolvable;
3054 /**
3055 * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
3056 *
3057 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled
3058 */
3059 readonly dataTraceEnabled?: boolean | cdk.IResolvable;
3060 /**
3061 * The HTTP method. To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .
3062 *
3063 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod
3064 */
3065 readonly httpMethod?: string;
3066 /**
3067 * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events.
3068 *
3069 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel
3070 */
3071 readonly loggingLevel?: string;
3072 /**
3073 * Specifies whether Amazon CloudWatch metrics are enabled for this method.
3074 *
3075 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled
3076 */
3077 readonly metricsEnabled?: boolean | cdk.IResolvable;
3078 /**
3079 * The resource path for this method. Forward slashes ( `/` ) are encoded as `~1` and the initial slash must include a forward slash. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource` . To specify the root path, use only a slash ( `/` ). To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .
3080 *
3081 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath
3082 */
3083 readonly resourcePath?: string;
3084 /**
3085 * Specifies the throttling burst limit.
3086 *
3087 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit
3088 */
3089 readonly throttlingBurstLimit?: number;
3090 /**
3091 * Specifies the throttling rate limit.
3092 *
3093 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit
3094 */
3095 readonly throttlingRateLimit?: number;
3096 }
3097}
3098/**
3099 * Properties for defining a `CfnUsagePlan`
3100 *
3101 * @struct
3102 * @stability external
3103 *
3104 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
3105 */
3106export interface CfnUsagePlanProps {
3107 /**
3108 * The associated API stages of a usage plan.
3109 *
3110 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages
3111 */
3112 readonly apiStages?: Array<CfnUsagePlan.ApiStageProperty | cdk.IResolvable> | cdk.IResolvable;
3113 /**
3114 * The description of a usage plan.
3115 *
3116 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description
3117 */
3118 readonly description?: string;
3119 /**
3120 * The target maximum number of permitted requests per a given unit time interval.
3121 *
3122 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota
3123 */
3124 readonly quota?: CfnUsagePlan.QuotaSettingsProperty | cdk.IResolvable;
3125 /**
3126 * The collection of tags. Each tag element is associated with a given resource.
3127 *
3128 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags
3129 */
3130 readonly tags?: cdk.CfnTag[];
3131 /**
3132 * A map containing method level throttling information for API stage in a usage plan.
3133 *
3134 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle
3135 */
3136 readonly throttle?: CfnUsagePlan.ThrottleSettingsProperty | cdk.IResolvable;
3137 /**
3138 * The name of a usage plan.
3139 *
3140 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname
3141 */
3142 readonly usagePlanName?: string;
3143}
3144/**
3145 * A CloudFormation `AWS::ApiGateway::UsagePlan`
3146 *
3147 * The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide* .
3148 *
3149 * In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
3150 *
3151 * @cloudformationResource AWS::ApiGateway::UsagePlan
3152 * @stability external
3153 *
3154 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
3155 */
3156export declare class CfnUsagePlan extends cdk.CfnResource implements cdk.IInspectable {
3157 /**
3158 * The CloudFormation resource type name for this resource class.
3159 */
3160 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::UsagePlan";
3161 /**
3162 * A factory method that creates a new instance of this class from an object
3163 * containing the CloudFormation properties of this resource.
3164 * Used in the @aws-cdk/cloudformation-include module.
3165 *
3166 * @internal
3167 */
3168 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnUsagePlan;
3169 /**
3170 * The ID for the usage plan. For example: `abc123` .
3171 * @cloudformationAttribute Id
3172 */
3173 readonly attrId: string;
3174 /**
3175 * The associated API stages of a usage plan.
3176 *
3177 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages
3178 */
3179 apiStages: Array<CfnUsagePlan.ApiStageProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
3180 /**
3181 * The description of a usage plan.
3182 *
3183 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description
3184 */
3185 description: string | undefined;
3186 /**
3187 * The target maximum number of permitted requests per a given unit time interval.
3188 *
3189 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota
3190 */
3191 quota: CfnUsagePlan.QuotaSettingsProperty | cdk.IResolvable | undefined;
3192 /**
3193 * The collection of tags. Each tag element is associated with a given resource.
3194 *
3195 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags
3196 */
3197 readonly tags: cdk.TagManager;
3198 /**
3199 * A map containing method level throttling information for API stage in a usage plan.
3200 *
3201 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle
3202 */
3203 throttle: CfnUsagePlan.ThrottleSettingsProperty | cdk.IResolvable | undefined;
3204 /**
3205 * The name of a usage plan.
3206 *
3207 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname
3208 */
3209 usagePlanName: string | undefined;
3210 /**
3211 * Create a new `AWS::ApiGateway::UsagePlan`.
3212 *
3213 * @param scope - scope in which this resource is defined
3214 * @param id - scoped id of the resource
3215 * @param props - resource properties
3216 */
3217 constructor(scope: cdk.Construct, id: string, props?: CfnUsagePlanProps);
3218 /**
3219 * Examines the CloudFormation resource and discloses attributes.
3220 *
3221 * @param inspector - tree inspector to collect and process attributes
3222 *
3223 */
3224 inspect(inspector: cdk.TreeInspector): void;
3225 protected get cfnProperties(): {
3226 [key: string]: any;
3227 };
3228 protected renderProperties(props: {
3229 [key: string]: any;
3230 }): {
3231 [key: string]: any;
3232 };
3233}
3234export declare namespace CfnUsagePlan {
3235 /**
3236 * API stage name of the associated API stage in a usage plan.
3237 *
3238 * @struct
3239 * @stability external
3240 *
3241 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html
3242 */
3243 interface ApiStageProperty {
3244 /**
3245 * API Id of the associated API stage in a usage plan.
3246 *
3247 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid
3248 */
3249 readonly apiId?: string;
3250 /**
3251 * API stage name of the associated API stage in a usage plan.
3252 *
3253 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage
3254 */
3255 readonly stage?: string;
3256 /**
3257 * Map containing method level throttling information for API stage in a usage plan.
3258 *
3259 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle
3260 */
3261 readonly throttle?: {
3262 [key: string]: (CfnUsagePlan.ThrottleSettingsProperty | cdk.IResolvable);
3263 } | cdk.IResolvable;
3264 }
3265}
3266export declare namespace CfnUsagePlan {
3267 /**
3268 * `QuotaSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
3269 *
3270 * In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
3271 *
3272 * @struct
3273 * @stability external
3274 *
3275 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html
3276 */
3277 interface QuotaSettingsProperty {
3278 /**
3279 * The target maximum number of requests that can be made in a given time period.
3280 *
3281 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit
3282 */
3283 readonly limit?: number;
3284 /**
3285 * The number of requests subtracted from the given limit in the initial time period.
3286 *
3287 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset
3288 */
3289 readonly offset?: number;
3290 /**
3291 * The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
3292 *
3293 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period
3294 */
3295 readonly period?: string;
3296 }
3297}
3298export declare namespace CfnUsagePlan {
3299 /**
3300 * `ThrottleSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
3301 *
3302 * @struct
3303 * @stability external
3304 *
3305 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html
3306 */
3307 interface ThrottleSettingsProperty {
3308 /**
3309 * The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
3310 *
3311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit
3312 */
3313 readonly burstLimit?: number;
3314 /**
3315 * The API target request rate limit.
3316 *
3317 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit
3318 */
3319 readonly rateLimit?: number;
3320 }
3321}
3322/**
3323 * Properties for defining a `CfnUsagePlanKey`
3324 *
3325 * @struct
3326 * @stability external
3327 *
3328 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html
3329 */
3330export interface CfnUsagePlanKeyProps {
3331 /**
3332 * The Id of the UsagePlanKey resource to be deleted.
3333 *
3334 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
3335 */
3336 readonly keyId: string;
3337 /**
3338 * The type of a UsagePlanKey resource for a plan customer.
3339 *
3340 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
3341 */
3342 readonly keyType: string;
3343 /**
3344 * The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
3345 *
3346 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
3347 */
3348 readonly usagePlanId: string;
3349}
3350/**
3351 * A CloudFormation `AWS::ApiGateway::UsagePlanKey`
3352 *
3353 * The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
3354 *
3355 * @cloudformationResource AWS::ApiGateway::UsagePlanKey
3356 * @stability external
3357 *
3358 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html
3359 */
3360export declare class CfnUsagePlanKey extends cdk.CfnResource implements cdk.IInspectable {
3361 /**
3362 * The CloudFormation resource type name for this resource class.
3363 */
3364 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::UsagePlanKey";
3365 /**
3366 * A factory method that creates a new instance of this class from an object
3367 * containing the CloudFormation properties of this resource.
3368 * Used in the @aws-cdk/cloudformation-include module.
3369 *
3370 * @internal
3371 */
3372 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnUsagePlanKey;
3373 /**
3374 * The ID for the usage plan key. For example: `abc123` .
3375 * @cloudformationAttribute Id
3376 */
3377 readonly attrId: string;
3378 /**
3379 * The Id of the UsagePlanKey resource to be deleted.
3380 *
3381 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
3382 */
3383 keyId: string;
3384 /**
3385 * The type of a UsagePlanKey resource for a plan customer.
3386 *
3387 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
3388 */
3389 keyType: string;
3390 /**
3391 * The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
3392 *
3393 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
3394 */
3395 usagePlanId: string;
3396 /**
3397 * Create a new `AWS::ApiGateway::UsagePlanKey`.
3398 *
3399 * @param scope - scope in which this resource is defined
3400 * @param id - scoped id of the resource
3401 * @param props - resource properties
3402 */
3403 constructor(scope: cdk.Construct, id: string, props: CfnUsagePlanKeyProps);
3404 /**
3405 * Examines the CloudFormation resource and discloses attributes.
3406 *
3407 * @param inspector - tree inspector to collect and process attributes
3408 *
3409 */
3410 inspect(inspector: cdk.TreeInspector): void;
3411 protected get cfnProperties(): {
3412 [key: string]: any;
3413 };
3414 protected renderProperties(props: {
3415 [key: string]: any;
3416 }): {
3417 [key: string]: any;
3418 };
3419}
3420/**
3421 * Properties for defining a `CfnVpcLink`
3422 *
3423 * @struct
3424 * @stability external
3425 *
3426 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html
3427 */
3428export interface CfnVpcLinkProps {
3429 /**
3430 * The name used to label and identify the VPC link.
3431 *
3432 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name
3433 */
3434 readonly name: string;
3435 /**
3436 * The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
3437 *
3438 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns
3439 */
3440 readonly targetArns: string[];
3441 /**
3442 * The description of the VPC link.
3443 *
3444 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description
3445 */
3446 readonly description?: string;
3447 /**
3448 * An array of arbitrary tags (key-value pairs) to associate with the VPC link.
3449 *
3450 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags
3451 */
3452 readonly tags?: cdk.CfnTag[];
3453}
3454/**
3455 * A CloudFormation `AWS::ApiGateway::VpcLink`
3456 *
3457 * The `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the `Amazon API Gateway REST API Reference` .
3458 *
3459 * @cloudformationResource AWS::ApiGateway::VpcLink
3460 * @stability external
3461 *
3462 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html
3463 */
3464export declare class CfnVpcLink extends cdk.CfnResource implements cdk.IInspectable {
3465 /**
3466 * The CloudFormation resource type name for this resource class.
3467 */
3468 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::ApiGateway::VpcLink";
3469 /**
3470 * A factory method that creates a new instance of this class from an object
3471 * containing the CloudFormation properties of this resource.
3472 * Used in the @aws-cdk/cloudformation-include module.
3473 *
3474 * @internal
3475 */
3476 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnVpcLink;
3477 /**
3478 *
3479 * @cloudformationAttribute VpcLinkId
3480 */
3481 readonly attrVpcLinkId: string;
3482 /**
3483 * The name used to label and identify the VPC link.
3484 *
3485 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name
3486 */
3487 name: string;
3488 /**
3489 * The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
3490 *
3491 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns
3492 */
3493 targetArns: string[];
3494 /**
3495 * The description of the VPC link.
3496 *
3497 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description
3498 */
3499 description: string | undefined;
3500 /**
3501 * An array of arbitrary tags (key-value pairs) to associate with the VPC link.
3502 *
3503 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags
3504 */
3505 readonly tags: cdk.TagManager;
3506 /**
3507 * Create a new `AWS::ApiGateway::VpcLink`.
3508 *
3509 * @param scope - scope in which this resource is defined
3510 * @param id - scoped id of the resource
3511 * @param props - resource properties
3512 */
3513 constructor(scope: cdk.Construct, id: string, props: CfnVpcLinkProps);
3514 /**
3515 * Examines the CloudFormation resource and discloses attributes.
3516 *
3517 * @param inspector - tree inspector to collect and process attributes
3518 *
3519 */
3520 inspect(inspector: cdk.TreeInspector): void;
3521 protected get cfnProperties(): {
3522 [key: string]: any;
3523 };
3524 protected renderProperties(props: {
3525 [key: string]: any;
3526 }): {
3527 [key: string]: any;
3528 };
3529}