43 CDK constructs available in aws-cdk-lib/aws-apigateway
import * as apigateway from 'aws-cdk-lib/aws-apigateway';Higher-level abstractions with sensible defaults and convenience methods.
An API Gateway ApiKey. An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.
This resource creates a base path that clients who call your API must use in the invocation URL. Unless you're importing a domain with `DomainName.fromDomainNameAttributes()`, you can use `DomainName.addBasePathMapping()` to define mappings.
Cognito user pools based custom authorizer.
A Deployment of a REST API. An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. Normally, you don't need to define deployments manually. The RestApi construct manages a Deployment resource that represents the latest model. It can be accessed through `restApi.latestDeployment` (unless `deploy: false` is set when defining the `RestApi`). If you manually define this resource, you will need to know that since deployments are immutable, as long as the resource's logical ID doesn't change, the deployment will represent the snapshot in time in which the resource was created. This means that if you modify the RestApi model (i.e. add methods or resources), these changes will not be reflected unless a new deployment resource is created. To achieve this behavior, the method `addToLogicalId(data)` can be used to augment the logical ID generated for the deployment resource such that it will include arbitrary data. This is done automatically for the `restApi.latestDeployment` deployment. Furthermore, since a deployment does not reference any of the REST API resources and methods, CloudFormation will likely provision it before these resources are created, which means that it will represent a "half-baked" model. Use the `node.addDependency(dep)` method to circumvent that. This is done automatically for the `restApi.latestDeployment` deployment.
Configure the response received by clients, produced from the API Gateway backend.
Defines an API Gateway REST API with AWS Lambda proxy integration. Use the `proxy` property to define a greedy proxy ("{proxy+}") and "ANY" method from the specified path. If not defined, you will need to explicity add resources and methods to the API.
Defines a {proxy+} greedy resource and an ANY method on a route.
An API Gateway ApiKey, for which a rate limiting configuration can be specified.
Request-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables. Based on the request, authorization is performed by a lambda function.
Represents a REST API in Amazon API Gateway. Use `addResource` and `addMethod` to configure the API model. By default, the API will automatically be deployed and accessible from a public endpoint.
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification. Some properties normally accessible on
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
Token based lambda authorizer that recognizes the caller's identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token. Based on the token, authorization is performed by a lambda function.
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Direct CloudFormation resource mappings. One-to-one with CloudFormation resource types.
AWS::ApiGateway::AccountAWS::ApiGateway::ApiKeyAWS::ApiGateway::AuthorizerAWS::ApiGateway::BasePathMappingAWS::ApiGateway::BasePathMappingV2AWS::ApiGateway::ClientCertificateAWS::ApiGateway::DeploymentAWS::ApiGateway::DocumentationPartAWS::ApiGateway::DocumentationVersionAWS::ApiGateway::DomainNameAWS::ApiGateway::DomainNameAccessAssociationAWS::ApiGateway::DomainNameV2AWS::ApiGateway::GatewayResponseAWS::ApiGateway::MethodAWS::ApiGateway::ModelAWS::ApiGateway::RequestValidatorAWS::ApiGateway::ResourceAWS::ApiGateway::RestApiAWS::ApiGateway::StageAWS::ApiGateway::UsagePlanAWS::ApiGateway::UsagePlanKeyAWS::ApiGateway::VpcLinkEverything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.
Download Free Infographicaws-cdk-lib/aws-apigateway