All Classes and Interfaces
Class
Description
(experimental) Options for the Route with Integration resource.
A builder for
AddRoutesOptionsAn implementation for
AddRoutesOptions(experimental) Create a new API mapping for API Gateway API endpoint.
(experimental) A fluent builder for
ApiMapping.(experimental) The attributes used to import existing ApiMapping.
A builder for
ApiMappingAttributesAn implementation for
ApiMappingAttributes(experimental) Properties used to create the ApiMapping resource.
A builder for
ApiMappingPropsAn implementation for
ApiMappingProps(experimental) Payload format version for lambda authorizers.
(experimental) Options used when configuring multiple routes, at once.
A builder for
BatchHttpRouteOptionsAn implementation for
BatchHttpRouteOptions(experimental) Supported CORS HTTP methods.
(experimental) Options for the CORS Configuration.
A builder for
CorsPreflightOptionsAn implementation for
CorsPreflightOptions(experimental) Options for DomainMapping.
A builder for
DomainMappingOptionsAn implementation for
DomainMappingOptions(experimental) Custom domain resource for the API.
(experimental) A fluent builder for
DomainName.(experimental) custom domain name attributes.
A builder for
DomainNameAttributesAn implementation for
DomainNameAttributes(experimental) properties used for creating the DomainName.
A builder for
DomainNamePropsAn implementation for
DomainNameProps(experimental) properties for creating a domain name endpoint.
A builder for
EndpointOptionsAn implementation for
EndpointOptions(experimental) Endpoint type for a domain name.
(experimental) Options for granting invoke access.
A builder for
GrantInvokeOptionsAn implementation for
GrantInvokeOptions(experimental) Create a new API Gateway HTTP API endpoint.
(experimental) A fluent builder for
HttpApi.(experimental) Attributes for importing an HttpApi into the CDK.
A builder for
HttpApiAttributesAn implementation for
HttpApiAttributes(experimental) Properties to initialize an instance of
HttpApi.A builder for
HttpApiPropsAn implementation for
HttpApiProps(experimental) An authorizer for Http Apis.
(experimental) A fluent builder for
HttpAuthorizer.(experimental) Reference to an http authorizer.
A builder for
HttpAuthorizerAttributesAn implementation for
HttpAuthorizerAttributes(experimental) Properties to initialize an instance of
HttpAuthorizer.A builder for
HttpAuthorizerPropsAn implementation for
HttpAuthorizerProps(experimental) Supported Authorizer types.
(experimental) Supported connection types.
(experimental) The integration for an API route.
(experimental) A fluent builder for
HttpIntegration.(experimental) The integration properties.
A builder for
HttpIntegrationPropsAn implementation for
HttpIntegrationProps(experimental) Supported integration subtypes.
(experimental) Supported integration types.
(experimental) Supported HTTP methods.
(experimental) Explicitly configure no authorizers on specific HTTP API routes.
(experimental) Route class that creates the Route for API Gateway HTTP API.
(experimental) A fluent builder for
HttpRoute.(experimental) Input to the bind() operation, that binds an authorizer to a route.
A builder for
HttpRouteAuthorizerBindOptionsAn implementation for
HttpRouteAuthorizerBindOptions(experimental) Results of binding an authorizer to an http route.
A builder for
HttpRouteAuthorizerConfigAn implementation for
HttpRouteAuthorizerConfig(experimental) The interface that various route integration classes will inherit.
(experimental) Options to the HttpRouteIntegration during its bind operation.
A builder for
HttpRouteIntegrationBindOptionsAn implementation for
HttpRouteIntegrationBindOptions(experimental) Config returned back as a result of the bind.
A builder for
HttpRouteIntegrationConfigAn implementation for
HttpRouteIntegrationConfig(experimental) HTTP route in APIGateway is a combination of the HTTP method and the path component.
(experimental) Properties to initialize a new Route.
A builder for
HttpRoutePropsAn implementation for
HttpRouteProps(experimental) Represents a stage where an instance of the API is deployed.
(experimental) A fluent builder for
HttpStage.(experimental) The attributes used to import existing HttpStage.
A builder for
HttpStageAttributesAn implementation for
HttpStageAttributes(experimental) The options to create a new Stage for an HTTP API.
A builder for
HttpStageOptionsAn implementation for
HttpStageOptions(experimental) Properties to initialize an instance of
HttpStage.A builder for
HttpStagePropsAn implementation for
HttpStageProps(experimental) Represents a API Gateway HTTP/WebSocket API.
Internal default implementation for
IApi.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an ApiGatewayV2 ApiMapping resource.
Internal default implementation for
IApiMapping.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an Authorizer.
Internal default implementation for
IAuthorizer.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an APIGatewayV2 DomainName.
Internal default implementation for
IDomainName.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an HTTP API.
Internal default implementation for
IHttpApi.A proxy class which represents a concrete javascript instance of this type.
(experimental) An authorizer for HTTP APIs.
Internal default implementation for
IHttpAuthorizer.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an Integration for an HTTP API.
Internal default implementation for
IHttpIntegration.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a Route for an HTTP API.
Internal default implementation for
IHttpRoute.A proxy class which represents a concrete javascript instance of this type.
(experimental) An authorizer that can attach to an Http Route.
Internal default implementation for
IHttpRouteAuthorizer.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents the HttpStage.
Internal default implementation for
IHttpStage.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an integration to an API Route.
Internal default implementation for
IIntegration.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a Mapping Value.
Internal default implementation for
IMappingValue.A proxy class which represents a concrete javascript instance of this type.
(experimental) Credentials used for AWS Service integrations.
(experimental) Represents a route.
Internal default implementation for
IRoute.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a Stage.
Internal default implementation for
IStage.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an API Gateway VpcLink.
Internal default implementation for
IVpcLink.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a WebSocket API.
Internal default implementation for
IWebSocketApi.A proxy class which represents a concrete javascript instance of this type.
(experimental) An authorizer for WebSocket APIs.
Internal default implementation for
IWebSocketAuthorizer.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents an Integration for an WebSocket API.
Internal default implementation for
IWebSocketIntegration.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a Route for an WebSocket API.
Internal default implementation for
IWebSocketRoute.A proxy class which represents a concrete javascript instance of this type.
(experimental) An authorizer that can attach to an WebSocket Route.
Internal default implementation for
IWebSocketRouteAuthorizer.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents the WebSocketStage.
Internal default implementation for
IWebSocketStage.A proxy class which represents a concrete javascript instance of this type.
(experimental) Represents a Mapping Value.
(experimental) The mTLS authentication configuration for a custom domain name.
A builder for
MTLSConfigAn implementation for
MTLSConfig(experimental) Represents a Parameter Mapping.
(experimental) Payload format version for lambda proxy integration.
(experimental) The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
(experimental) The attributes used to import existing Stage.
A builder for
StageAttributesAn implementation for
StageAttributes(experimental) Options required to create a new stage.
A builder for
StageOptionsAn implementation for
StageOptions(experimental) Container for defining throttling parameters to API stages.
A builder for
ThrottleSettingsAn implementation for
ThrottleSettings(experimental) Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).
(experimental) A fluent builder for
VpcLink.(experimental) Attributes when importing a new VpcLink.
A builder for
VpcLinkAttributesAn implementation for
VpcLinkAttributes(experimental) Properties for a VpcLink.
A builder for
VpcLinkPropsAn implementation for
VpcLinkProps(experimental) Create a new API Gateway WebSocket API endpoint.
(experimental) A fluent builder for
WebSocketApi.(experimental) Attributes for importing a WebSocketApi into the CDK.
A builder for
WebSocketApiAttributesAn implementation for
WebSocketApiAttributes(experimental) Represents the currently available API Key Selection Expressions.
(experimental) Props for WebSocket API.
A builder for
WebSocketApiPropsAn implementation for
WebSocketApiProps(experimental) An authorizer for WebSocket Apis.
(experimental) A fluent builder for
WebSocketAuthorizer.(experimental) Reference to an WebSocket authorizer.
A builder for
WebSocketAuthorizerAttributesAn implementation for
WebSocketAuthorizerAttributes(experimental) Properties to initialize an instance of
WebSocketAuthorizer.A builder for
WebSocketAuthorizerPropsAn implementation for
WebSocketAuthorizerProps(experimental) Supported Authorizer types.
(experimental) The integration for an API route.
(experimental) A fluent builder for
WebSocketIntegration.(experimental) The integration properties.
A builder for
WebSocketIntegrationPropsAn implementation for
WebSocketIntegrationProps(experimental) WebSocket Integration Types.
(experimental) Explicitly configure no authorizers on specific WebSocket API routes.
(experimental) Route class that creates the Route for API Gateway WebSocket API.
(experimental) A fluent builder for
WebSocketRoute.(experimental) Input to the bind() operation, that binds an authorizer to a route.
A builder for
WebSocketRouteAuthorizerBindOptionsAn implementation for
WebSocketRouteAuthorizerBindOptions(experimental) Results of binding an authorizer to an WebSocket route.
A builder for
WebSocketRouteAuthorizerConfigAn implementation for
WebSocketRouteAuthorizerConfig(experimental) The interface that various route integration classes will inherit.
(experimental) Options to the WebSocketRouteIntegration during its bind operation.
A builder for
WebSocketRouteIntegrationBindOptionsAn implementation for
WebSocketRouteIntegrationBindOptions(experimental) Config returned back as a result of the bind.
A builder for
WebSocketRouteIntegrationConfigAn implementation for
WebSocketRouteIntegrationConfig(experimental) Options used to add route to the API.
A builder for
WebSocketRouteOptionsAn implementation for
WebSocketRouteOptions(experimental) Properties to initialize a new Route.
A builder for
WebSocketRoutePropsAn implementation for
WebSocketRouteProps(experimental) Represents a stage where an instance of the API is deployed.
(experimental) A fluent builder for
WebSocketStage.(experimental) The attributes used to import existing WebSocketStage.
A builder for
WebSocketStageAttributesAn implementation for
WebSocketStageAttributes(experimental) Properties to initialize an instance of
WebSocketStage.A builder for
WebSocketStagePropsAn implementation for
WebSocketStageProps