interface CfnRestApiProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.CfnRestApiProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnRestApiProps |
 Java | software.amazon.awscdk.services.apigateway.CfnRestApiProps |
 Python | aws_cdk.aws_apigateway.CfnRestApiProps |
 TypeScript | aws-cdk-lib » aws_apigateway » CfnRestApiProps |
Properties for defining a CfnRestApi.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const body: any;
declare const policy: any;
const cfnRestApiProps: apigateway.CfnRestApiProps = {
apiKeySourceType: 'apiKeySourceType',
binaryMediaTypes: ['binaryMediaTypes'],
body: body,
bodyS3Location: {
bucket: 'bucket',
eTag: 'eTag',
key: 'key',
version: 'version',
},
cloneFrom: 'cloneFrom',
description: 'description',
disableExecuteApiEndpoint: false,
endpointConfiguration: {
types: ['types'],
vpcEndpointIds: ['vpcEndpointIds'],
},
failOnWarnings: false,
minimumCompressionSize: 123,
mode: 'mode',
name: 'name',
parameters: {
parametersKey: 'parameters',
},
policy: policy,
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The source of the API key for metering requests according to a usage plan. |
| binary | string[] | The list of binary media types supported by the RestApi. |
| body? | any | An OpenAPI specification that defines a set of RESTful APIs in JSON format. |
| body | IResolvable | S3 | 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. |
| clone | string | The ID of the RestApi that you want to clone from. |
| description? | string | The description of the RestApi. |
| disable | boolean | IResolvable | Specifies whether clients can invoke your API by using the default execute-api endpoint. |
| endpoint | IResolvable | Endpoint | A list of the endpoint types of the API. |
| fail | boolean | IResolvable | A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered. |
| minimum | number | 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. |
| mode? | string | This property applies only when you use OpenAPI to define your REST API. |
| name? | string | The name of the RestApi. |
| parameters? | IResolvable | { [string]: string } | Custom header parameters as part of the request. |
| policy? | any | A policy document that contains the permissions for the RestApi resource. |
| tags? | Cfn[] | The key-value map of strings. |
apiKeySourceType?
Type:
string
(optional)
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.
binaryMediaTypes?
Type:
string[]
(optional)
The list of binary media types supported by the RestApi.
By default, the RestApi supports only UTF-8-encoded text payloads.
body?
Type:
any
(optional)
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.
bodyS3Location?
Type:
IResolvable | S3
(optional)
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.
cloneFrom?
Type:
string
(optional)
The ID of the RestApi that you want to clone from.
description?
Type:
string
(optional)
The description of the RestApi.
disableExecuteApiEndpoint?
Type:
boolean | IResolvable
(optional)
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
endpointConfiguration?
Type:
IResolvable | Endpoint
(optional)
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.
failOnWarnings?
Type:
boolean | IResolvable
(optional)
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 .
minimumCompressionSize?
Type:
number
(optional)
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.
mode?
Type:
string
(optional)
This property applies only when you use OpenAPI to define your REST API.
The Mode determines how API Gateway handles resource updates.
Valid values are overwrite or merge .
For overwrite , the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge , the new API definition is merged with the existing API.
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.
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.
name?
Type:
string
(optional)
The name of the RestApi.
A name is required if the REST API is not based on an OpenAPI specification.
parameters?
Type:
IResolvable | { [string]: string }
(optional)
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' .
policy?
Type:
any
(optional)
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 "*" .
tags?
Type:
Cfn[]
(optional)
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.