interface SpecRestApiProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.SpecRestApiProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#SpecRestApiProps |
 Java | software.amazon.awscdk.services.apigateway.SpecRestApiProps |
 Python | aws_cdk.aws_apigateway.SpecRestApiProps |
 TypeScript (source) | aws-cdk-lib » aws_apigateway » SpecRestApiProps |
Props to instantiate a new SpecRestApi.
Example
declare const integration: apigateway.Integration;
const api = new apigateway.SpecRestApi(this, 'books-api', {
apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')
});
const booksResource = api.root.addResource('books')
booksResource.addMethod('GET', integration);
Properties
| Name | Type | Description |
|---|---|---|
| api | Api | An OpenAPI definition compatible with API Gateway. |
| cloud | boolean | Automatically configure an AWS CloudWatch role for API Gateway. |
| cloud | Removal | The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. |
| deploy? | boolean | Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. |
| deploy | Stage | Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled. |
| description? | string | A description of the RestApi construct. |
| disable | boolean | Specifies whether clients can invoke the API using the default execute-api endpoint. |
| domain | Domain | Configure a custom domain name and map it to this API. |
| endpoint | string | Export name for the CfnOutput containing the API endpoint. |
| endpoint | Endpoint[] | A list of the endpoint types of the API. |
| fail | boolean | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. |
| min | Size | A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. |
| parameters? | { [string]: string } | Custom header parameters for the request. |
| policy? | Policy | A policy document that contains the permissions for this RestApi. |
| rest | string | A name for the API Gateway RestApi resource. |
| retain | boolean | Retains old deployment resources when the API changes. |
apiDefinition
Type:
Api
An OpenAPI definition compatible with API Gateway.
See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
cloudWatchRole?
Type:
boolean
(optional, default: false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise)
Automatically configure an AWS CloudWatch role for API Gateway.
cloudWatchRoleRemovalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.RETAIN)
The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
Requires cloudWatchRole to be enabled.
deploy?
Type:
boolean
(optional, default: true)
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.
If this is set, latestDeployment will refer to the Deployment object
and deploymentStage will refer to a Stage that points to this
deployment. To customize the stage options, use the deployOptions
property.
A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
deployOptions?
Type:
Stage
(optional, default: Based on defaults of StageOptions.)
Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
If deploy is disabled,
this value cannot be set.
description?
Type:
string
(optional, default: 'Automatically created by the RestApi construct')
A description of the RestApi construct.
disableExecuteApiEndpoint?
Type:
boolean
(optional, default: false)
Specifies whether clients can invoke the API using the default execute-api endpoint.
To require that clients use a custom domain name to invoke the API, disable the default endpoint.
See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
domainName?
Type:
Domain
(optional, default: no domain name is defined, use addDomainName or directly define a DomainName.)
Configure a custom domain name and map it to this API.
endpointExportName?
Type:
string
(optional, default: when no export name is given, output will be created without export)
Export name for the CfnOutput containing the API endpoint.
endpointTypes?
Type:
Endpoint[]
(optional, default: EndpointType.EDGE)
A list of the endpoint types of the API.
Use this property when creating an API.
failOnWarnings?
Type:
boolean
(optional, default: false)
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
minCompressionSize?
Type:
Size
(optional, default: Compression is disabled.)
A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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.
parameters?
Type:
{ [string]: string }
(optional, default: No parameters.)
Custom header parameters for the request.
See also: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
policy?
Type:
Policy
(optional, default: No policy.)
A policy document that contains the permissions for this RestApi.
restApiName?
Type:
string
(optional, default: ID of the RestApi construct.)
A name for the API Gateway RestApi resource.
retainDeployments?
Type:
boolean
(optional, default: false)
Retains old deployment resources when the API changes.
This allows manually reverting stages to point to old deployments via the AWS Console.