Categorygithub.com/aws/aws-cdk-go/awscdkawsapigatewayv2
package
1.204.0-devpreview
Repository: https://github.com/aws/aws-cdk-go.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
12
Dependents
6
Files
25.9k SLOC

# README

AWS::APIGatewayv2 Construct Library

Table of Contents

Introduction

Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale. API developers can create APIs that access AWS or other web services, as well as data stored in the AWS Cloud. As an API Gateway API developer, you can create APIs for use in your own client applications. Read the Amazon API Gateway Developer Guide.

This module supports features under API Gateway v2 that lets users set up Websocket and HTTP APIs. REST APIs can be created using the @aws-cdk/aws-apigateway module.

HTTP API

HTTP APIs enable creation of RESTful APIs that integrate with AWS Lambda functions, known as Lambda proxy integration, or to any routable HTTP endpoint, known as HTTP proxy integration.

Defining HTTP APIs

HTTP APIs have two fundamental concepts - Routes and Integrations.

Routes direct incoming API requests to backend resources. Routes consist of two parts: an HTTP method and a resource path, such as, GET /books. Learn more at Working with routes. Use the ANY method to match any methods for a route that are not explicitly defined.

Integrations define how the HTTP API responds when a client reaches a specific Route. HTTP APIs support Lambda proxy integration, HTTP proxy integration and, AWS service integrations, also known as private integrations. Learn more at Configuring integrations.

Integrations are available at the aws-apigatewayv2-integrations module and more information is available in that module. As an early example, the following code snippet configures a route GET /books with an HTTP proxy integration all configures all other HTTP method calls to /books to a lambda proxy.

import "github.com/aws/aws-cdk-go/awscdk"

var booksDefaultFn function


getBooksIntegration := awscdk.NewHttpUrlIntegration(jsii.String("GetBooksIntegration"), jsii.String("https://get-books-proxy.myproxy.internal"))
booksDefaultIntegration := awscdk.NewHttpLambdaIntegration(jsii.String("BooksIntegration"), booksDefaultFn)

httpApi := apigwv2.NewHttpApi(this, jsii.String("HttpApi"))

httpApi.AddRoutes(&AddRoutesOptions{
	Path: jsii.String("/books"),
	Methods: []httpMethod{
		apigwv2.*httpMethod_GET,
	},
	Integration: getBooksIntegration,
})
httpApi.AddRoutes(&AddRoutesOptions{
	Path: jsii.String("/books"),
	Methods: []*httpMethod{
		apigwv2.*httpMethod_ANY,
	},
	Integration: booksDefaultIntegration,
})

The URL to the endpoint can be retrieved via the apiEndpoint attribute. By default this URL is enabled for clients. Use disableExecuteApiEndpoint to disable it.

httpApi := apigwv2.NewHttpApi(this, jsii.String("HttpApi"), &HttpApiProps{
	DisableExecuteApiEndpoint: jsii.Boolean(true),
})

The defaultIntegration option while defining HTTP APIs lets you create a default catch-all integration that is matched when a client reaches a route that is not explicitly defined.

import "github.com/aws/aws-cdk-go/awscdk"


apigwv2.NewHttpApi(this, jsii.String("HttpProxyApi"), &HttpApiProps{
	DefaultIntegration: awscdk.NewHttpUrlIntegration(jsii.String("DefaultIntegration"), jsii.String("https://example.com")),
})

Cross Origin Resource Sharing (CORS)

Cross-origin resource sharing (CORS) is a browser security feature that restricts HTTP requests that are initiated from scripts running in the browser. Enabling CORS will allow requests to your API from a web application hosted in a domain different from your API domain.

When configured CORS for an HTTP API, API Gateway automatically sends a response to preflight OPTIONS requests, even if there isn't an OPTIONS route configured. Note that, when this option is used, API Gateway will ignore CORS headers returned from your backend integration. Learn more about Configuring CORS for an HTTP API.

The corsPreflight option lets you specify a CORS configuration for an API.

apigwv2.NewHttpApi(this, jsii.String("HttpProxyApi"), &HttpApiProps{
	CorsPreflight: &CorsPreflightOptions{
		AllowHeaders: []*string{
			jsii.String("Authorization"),
		},
		AllowMethods: []corsHttpMethod{
			apigwv2.*corsHttpMethod_GET,
			apigwv2.*corsHttpMethod_HEAD,
			apigwv2.*corsHttpMethod_OPTIONS,
			apigwv2.*corsHttpMethod_POST,
		},
		AllowOrigins: []*string{
			jsii.String("*"),
		},
		MaxAge: awscdk.Duration_Days(jsii.Number(10)),
	},
})

Publishing HTTP APIs

A Stage is a logical reference to a lifecycle state of your API (for example, dev, prod, beta, or v2). API stages are identified by their stage name. Each stage is a named reference to a deployment of the API made available for client applications to call.

Use HttpStage to create a Stage resource for HTTP APIs. The following code sets up a Stage, whose URL is available at https://{api_id}.execute-api.{region}.amazonaws.com/beta.

var api httpApi


apigwv2.NewHttpStage(this, jsii.String("Stage"), &HttpStageProps{
	HttpApi: api,
	StageName: jsii.String("beta"),
})

If you omit the stageName will create a $default stage. A $default stage is one that is served from the base of the API's URL - https://{api_id}.execute-api.{region}.amazonaws.com/.

Note that, HttpApi will always creates a $default stage, unless the createDefaultStage property is unset.

Custom Domain

Custom domain names are simpler and more intuitive URLs that you can provide to your API users. Custom domain name are associated to API stages.

The code snippet below creates a custom domain and configures a default domain mapping for your API that maps the custom domain to the $default stage of the API.

import acm "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var handler function


certArn := "arn:aws:acm:us-east-1:111111111111:certificate"
domainName := "example.com"

dn := apigwv2.NewDomainName(this, jsii.String("DN"), &DomainNameProps{
	DomainName: jsii.String(DomainName),
	Certificate: acm.Certificate_FromCertificateArn(this, jsii.String("cert"), certArn),
})
api := apigwv2.NewHttpApi(this, jsii.String("HttpProxyProdApi"), &HttpApiProps{
	DefaultIntegration: awscdk.NewHttpLambdaIntegration(jsii.String("DefaultIntegration"), handler),
	// https://${dn.domainName}/foo goes to prodApi $default stage
	DefaultDomainMapping: &DomainMappingOptions{
		DomainName: dn,
		MappingKey: jsii.String("foo"),
	},
})

To migrate a domain endpoint from one type to another, you can add a new endpoint configuration via addEndpoint() and then configure DNS records to route traffic to the new endpoint. After that, you can remove the previous endpoint configuration. Learn more at Migrating a custom domain name

To associate a specific Stage to a custom domain mapping -

var api httpApi
var dn domainName


api.AddStage(jsii.String("beta"), &HttpStageOptions{
	StageName: jsii.String("beta"),
	AutoDeploy: jsii.Boolean(true),
	// https://${dn.domainName}/bar goes to the beta stage
	DomainMapping: &DomainMappingOptions{
		DomainName: dn,
		MappingKey: jsii.String("bar"),
	},
})

The same domain name can be associated with stages across different HttpApi as so -

import "github.com/aws/aws-cdk-go/awscdk"

var handler function
var dn domainName


apiDemo := apigwv2.NewHttpApi(this, jsii.String("DemoApi"), &HttpApiProps{
	DefaultIntegration: awscdk.NewHttpLambdaIntegration(jsii.String("DefaultIntegration"), handler),
	// https://${dn.domainName}/demo goes to apiDemo $default stage
	DefaultDomainMapping: &DomainMappingOptions{
		DomainName: dn,
		MappingKey: jsii.String("demo"),
	},
})

The mappingKey determines the base path of the URL with the custom domain. Each custom domain is only allowed to have one API mapping with undefined mappingKey. If more than one API mappings are specified, mappingKey will be required for all of them. In the sample above, the custom domain is associated with 3 API mapping resources across different APIs and Stages.

APIStageURL
api$defaulthttps://${domainName}/foo
apibetahttps://${domainName}/bar
apiDemo$defaulthttps://${domainName}/demo

You can retrieve the full domain URL with mapping key using the domainUrl property as so -

var apiDemo httpApi

demoDomainUrl := apiDemo.DefaultStage.DomainUrl

Mutual TLS (mTLS)

Mutual TLS can be configured to limit access to your API based by using client certificates instead of (or as an extension of) using authorization headers.

import s3 "github.com/aws/aws-cdk-go/awscdk"
import acm "github.com/aws/aws-cdk-go/awscdk"
var bucket bucket


certArn := "arn:aws:acm:us-east-1:111111111111:certificate"
domainName := "example.com"

apigwv2.NewDomainName(this, jsii.String("DomainName"), &DomainNameProps{
	DomainName: jsii.String(DomainName),
	Certificate: acm.Certificate_FromCertificateArn(this, jsii.String("cert"), certArn),
	Mtls: &MTLSConfig{
		Bucket: *Bucket,
		Key: jsii.String("someca.pem"),
		Version: jsii.String("version"),
	},
})

Instructions for configuring your trust store can be found here

Managing access to HTTP APIs

API Gateway supports multiple mechanisms for controlling and managing access to your HTTP API through authorizers.

These authorizers can be found in the APIGatewayV2-Authorizers constructs library.

Metrics

The API Gateway v2 service sends metrics around the performance of HTTP APIs to Amazon CloudWatch. These metrics can be referred to using the metric APIs available on the HttpApi construct. The APIs with the metric prefix can be used to get reference to specific metrics for this API. For example, the method below refers to the client side errors metric for this API.

api := apigwv2.NewHttpApi(this, jsii.String("my-api"))
clientErrorMetric := api.metricClientError()

Please note that this will return a metric for all the stages defined in the api. It is also possible to refer to metrics for a specific Stage using the metric methods from the Stage construct.

api := apigwv2.NewHttpApi(this, jsii.String("my-api"))
stage := apigwv2.NewHttpStage(this, jsii.String("Stage"), &HttpStageProps{
	HttpApi: api,
})
clientErrorMetric := stage.metricClientError()

VPC Link

Private integrations let HTTP APIs connect with AWS resources that are placed behind a VPC. These are usually Application Load Balancers, Network Load Balancers or a Cloud Map service. The VpcLink construct enables this integration. The following code creates a VpcLink to a private VPC.

import ec2 "github.com/aws/aws-cdk-go/awscdk"


vpc := ec2.NewVpc(this, jsii.String("VPC"))
vpcLink := apigwv2.NewVpcLink(this, jsii.String("VpcLink"), &VpcLinkProps{
	Vpc: Vpc,
})

Any existing VpcLink resource can be imported into the CDK app via the VpcLink.fromVpcLinkAttributes().

import ec2 "github.com/aws/aws-cdk-go/awscdk"

var vpc vpc

awesomeLink := apigwv2.VpcLink_FromVpcLinkAttributes(this, jsii.String("awesome-vpc-link"), &VpcLinkAttributes{
	VpcLinkId: jsii.String("us-east-1_oiuR12Abd"),
	Vpc: Vpc,
})

Private Integration

Private integrations enable integrating an HTTP API route with private resources in a VPC, such as Application Load Balancers or Amazon ECS container-based applications. Using private integrations, resources in a VPC can be exposed for access by clients outside of the VPC.

These integrations can be found in the aws-apigatewayv2-integrations constructs library.

WebSocket API

A WebSocket API in API Gateway is a collection of WebSocket routes that are integrated with backend HTTP endpoints, Lambda functions, or other AWS services. You can use API Gateway features to help you with all aspects of the API lifecycle, from creation through monitoring your production APIs. Read more

WebSocket APIs have two fundamental concepts - Routes and Integrations.

WebSocket APIs direct JSON messages to backend integrations based on configured routes. (Non-JSON messages are directed to the configured $default route.)

Integrations define how the WebSocket API behaves when a client reaches a specific Route. Learn more at Configuring integrations.

Integrations are available in the aws-apigatewayv2-integrations module and more information is available in that module.

To add the default WebSocket routes supported by API Gateway ($connect, $disconnect and $default), configure them as part of api props:

import "github.com/aws/aws-cdk-go/awscdk"

var connectHandler function
var disconnectHandler function
var defaultHandler function


webSocketApi := apigwv2.NewWebSocketApi(this, jsii.String("mywsapi"), &WebSocketApiProps{
	ConnectRouteOptions: &WebSocketRouteOptions{
		Integration: awscdk.NewWebSocketLambdaIntegration(jsii.String("ConnectIntegration"), connectHandler),
	},
	DisconnectRouteOptions: &WebSocketRouteOptions{
		Integration: awscdk.NewWebSocketLambdaIntegration(jsii.String("DisconnectIntegration"), disconnectHandler),
	},
	DefaultRouteOptions: &WebSocketRouteOptions{
		Integration: awscdk.NewWebSocketLambdaIntegration(jsii.String("DefaultIntegration"), defaultHandler),
	},
})

apigwv2.NewWebSocketStage(this, jsii.String("mystage"), &WebSocketStageProps{
	WebSocketApi: WebSocketApi,
	StageName: jsii.String("dev"),
	AutoDeploy: jsii.Boolean(true),
})

To retrieve a websocket URL and a callback URL:

var webSocketStage webSocketStage


webSocketURL := webSocketStage.url
// wss://${this.api.apiId}.execute-api.${s.region}.${s.urlSuffix}/${urlPath}
callbackURL := webSocketStage.callbackUrl

To add any other route:

import "github.com/aws/aws-cdk-go/awscdk"

var messageHandler function

webSocketApi := apigwv2.NewWebSocketApi(this, jsii.String("mywsapi"))
webSocketApi.AddRoute(jsii.String("sendmessage"), &WebSocketRouteOptions{
	Integration: awscdk.NewWebSocketLambdaIntegration(jsii.String("SendMessageIntegration"), messageHandler),
})

To import an existing WebSocketApi:

webSocketApi := apigwv2.WebSocketApi_FromWebSocketApiAttributes(this, jsii.String("mywsapi"), &WebSocketApiAttributes{
	WebSocketId: jsii.String("api-1234"),
})

Manage Connections Permission

Grant permission to use API Gateway Management API of a WebSocket API by calling the grantManageConnections API. You can use Management API to send a callback message to a connected client, get connection information, or disconnect the client. Learn more at Use @connections commands in your backend service.

var fn function


webSocketApi := apigwv2.NewWebSocketApi(this, jsii.String("mywsapi"))
stage := apigwv2.NewWebSocketStage(this, jsii.String("mystage"), &WebSocketStageProps{
	WebSocketApi: WebSocketApi,
	StageName: jsii.String("dev"),
})
// per stage permission
stage.GrantManagementApiAccess(fn)
// for all the stages permission
webSocketApi.GrantManageConnections(fn)

Managing access to WebSocket APIs

API Gateway supports multiple mechanisms for controlling and managing access to a WebSocket API through authorizers.

These authorizers can be found in the APIGatewayV2-Authorizers constructs library.

API Keys

Websocket APIs also support usage of API Keys. An API Key is a key that is used to grant access to an API. These are useful for controlling and tracking access to an API, when used together with usage plans. These together allow you to configure controls around API access such as quotas and throttling, along with per-API Key metrics on usage.

To require an API Key when accessing the Websocket API:

webSocketApi := apigwv2.NewWebSocketApi(this, jsii.String("mywsapi"), &WebSocketApiProps{
	ApiKeySelectionExpression: apigwv2.WebSocketApiKeySelectionExpression_HEADER_X_API_KEY(),
})

# Functions

import from API ID.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
Import from attributes.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Import an existing HTTP API into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Import an existing HTTP Authorizer into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
No description provided by the author
Create a route key with the combination of the path and the method.
Import an existing stage into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Use the specified role for integration requests.
Use the calling user's identity to call the integration.
Creates a context variable mapping value.
Creates a custom mapping value.
No description provided by the author
Creates a request body mapping value.
Creates a header mapping value.
Creates a request path mapping value.
Creates a request path parameter mapping value.
Creates a query string mapping value.
Creates a stage variable mapping value.
Experimental.
Experimental.
Create a new `AWS::ApiGatewayV2::Api`.
Create a new `AWS::ApiGatewayV2::Api`.
Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.
Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.
Create a new `AWS::ApiGatewayV2::ApiMapping`.
Create a new `AWS::ApiGatewayV2::ApiMapping`.
Create a new `AWS::ApiGatewayV2::Authorizer`.
Create a new `AWS::ApiGatewayV2::Authorizer`.
Create a new `AWS::ApiGatewayV2::Deployment`.
Create a new `AWS::ApiGatewayV2::Deployment`.
Create a new `AWS::ApiGatewayV2::DomainName`.
Create a new `AWS::ApiGatewayV2::DomainName`.
Create a new `AWS::ApiGatewayV2::Integration`.
Create a new `AWS::ApiGatewayV2::Integration`.
Create a new `AWS::ApiGatewayV2::IntegrationResponse`.
Create a new `AWS::ApiGatewayV2::IntegrationResponse`.
Create a new `AWS::ApiGatewayV2::Model`.
Create a new `AWS::ApiGatewayV2::Model`.
Create a new `AWS::ApiGatewayV2::Route`.
Create a new `AWS::ApiGatewayV2::Route`.
Create a new `AWS::ApiGatewayV2::RouteResponse`.
Create a new `AWS::ApiGatewayV2::RouteResponse`.
Create a new `AWS::ApiGatewayV2::Stage`.
Create a new `AWS::ApiGatewayV2::Stage`.
Create a new `AWS::ApiGatewayV2::VpcLink`.
Create a new `AWS::ApiGatewayV2::VpcLink`.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Initialize an integration for a route on http api.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Initialize an integration for a route on websocket api.
Experimental.
Experimental.
Creates a mapping from an object.
A custom payload version.
No description provided by the author
No description provided by the author
Import a VPC Link by specifying its attributes.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Import an existing WebSocket API into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
No description provided by the author
No description provided by the author
Import an existing WebSocket Authorizer into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Import an existing stage into this CDK app.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.

# Constants

Version 1.0.
Version 2.0.
HTTP ANY.
HTTP DELETE.
HTTP GET.
HTTP HEAD.
HTTP OPTIONS.
HTTP PATCH.
CorsHttpMethod_POST
HTTP POST.
HTTP PUT.
For an edge-optimized custom domain name.
For a regional custom domain name.
IAM Authorizer.
JSON Web Tokens.
Lambda Authorizer.
For connections through public routable internet.
For private connections between API Gateway and resources in a VPC.
AppConfig GetConfiguration integration.
EventBridge PutEvents integration.
Kinesis PutRecord integration.
SQS DeleteMessage integration,.
SQS PurgeQueue integration.
SQS ReceiveMessage integration,.
SQS SendMessage integration.
Step Functions StartExecution integration.
Step Functions StartSyncExecution integration.
Step Functions StopExecution integration.
Integration type is an AWS proxy.
Integration type is an HTTP proxy.
HTTP ANY.
HTTP DELETE.
HTTP GET.
HTTP HEAD.
HTTP OPTIONS.
HTTP PATCH.
HttpMethod_POST
HTTP POST.
HTTP PUT.
Cipher suite TLS 1.0.
Cipher suite TLS 1.2.
Lambda Authorizer.
AWS Proxy Integration Type.
Mock Integration Type.

# Structs

Options for the Route with Integration resource.
The attributes used to import existing ApiMapping.
Properties used to create the ApiMapping resource.
Options used when configuring multiple routes, at once.
The `BodyS3Location` property specifies an S3 location from which to import an OpenAPI definition.
The `Cors` property specifies a CORS configuration for an API.
The `AccessLogSettings` property overrides the access log settings for an API Gateway-managed stage.
The `IntegrationOverrides` property overrides the integration settings for an API Gateway-managed integration.
The `RouteOverrides` property overrides the route configuration for an API Gateway-managed route.
The `RouteSettings` property overrides the route settings for an API Gateway-managed route.
The `StageOverrides` property overrides the stage configuration for an API Gateway-managed stage.
Properties for defining a `CfnApiGatewayManagedOverrides`.
Properties for defining a `CfnApiMapping`.
Properties for defining a `CfnApi`.
The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
Properties for defining a `CfnAuthorizer`.
Properties for defining a `CfnDeployment`.
The `DomainNameConfiguration` property type specifies the configuration for a an API's domain name.
If specified, API Gateway performs two-way authentication between the client and the server.
Properties for defining a `CfnDomainName`.
Specifies a list of response parameters for an HTTP API.
Supported only for HTTP APIs.
The `TlsConfig` property specifies the TLS configuration for a private integration.
Properties for defining a `CfnIntegration`.
Properties for defining a `CfnIntegrationResponse`.
Properties for defining a `CfnModel`.
Example: // The code below shows an example of how to instantiate this type.
Properties for defining a `CfnRoute`.
Specifies whether the parameter is required.
Properties for defining a `CfnRouteResponse`.
Settings for logging access in a stage.
Represents a collection of route settings.
Properties for defining a `CfnStage`.
Properties for defining a `CfnVpcLink`.
Options for the CORS Configuration.
Options for DomainMapping.
custom domain name attributes.
properties used for creating the DomainName.
properties for creating a domain name endpoint.
Options for granting invoke access.
Attributes for importing an HttpApi into the CDK.
Properties to initialize an instance of `HttpApi`.
Reference to an http authorizer.
Properties to initialize an instance of `HttpAuthorizer`.
The integration properties.
Input to the bind() operation, that binds an authorizer to a route.
Results of binding an authorizer to an http route.
Options to the HttpRouteIntegration during its bind operation.
Config returned back as a result of the bind.
Properties to initialize a new Route.
The attributes used to import existing HttpStage.
The options to create a new Stage for an HTTP API.
Properties to initialize an instance of `HttpStage`.
The mTLS authentication configuration for a custom domain name.
The attributes used to import existing Stage.
Options required to create a new stage.
Container for defining throttling parameters to API stages.
Attributes when importing a new VpcLink.
Properties for a VpcLink.
Attributes for importing a WebSocketApi into the CDK.
Props for WebSocket API.
Reference to an WebSocket authorizer.
Properties to initialize an instance of `WebSocketAuthorizer`.
The integration properties.
Input to the bind() operation, that binds an authorizer to a route.
Results of binding an authorizer to an WebSocket route.
Options to the WebSocketRouteIntegration during its bind operation.
Config returned back as a result of the bind.
Options used to add route to the API.
Properties to initialize a new Route.
The attributes used to import existing WebSocketStage.
Properties to initialize an instance of `WebSocketStage`.

# Interfaces

Create a new API mapping for API Gateway API endpoint.
A CloudFormation `AWS::ApiGatewayV2::Api`.
A CloudFormation `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.
A CloudFormation `AWS::ApiGatewayV2::ApiMapping`.
A CloudFormation `AWS::ApiGatewayV2::Authorizer`.
A CloudFormation `AWS::ApiGatewayV2::Deployment`.
A CloudFormation `AWS::ApiGatewayV2::DomainName`.
A CloudFormation `AWS::ApiGatewayV2::Integration`.
A CloudFormation `AWS::ApiGatewayV2::IntegrationResponse`.
A CloudFormation `AWS::ApiGatewayV2::Model`.
A CloudFormation `AWS::ApiGatewayV2::Route`.
A CloudFormation `AWS::ApiGatewayV2::RouteResponse`.
A CloudFormation `AWS::ApiGatewayV2::Stage`.
A CloudFormation `AWS::ApiGatewayV2::VpcLink`.
Custom domain resource for the API.
Create a new API Gateway HTTP API endpoint.
An authorizer for Http Apis.
The integration for an API route.
Explicitly configure no authorizers on specific HTTP API routes.
Route class that creates the Route for API Gateway HTTP API.
The interface that various route integration classes will inherit.
HTTP route in APIGateway is a combination of the HTTP method and the path component.
Represents a stage where an instance of the API is deployed.
Represents a API Gateway HTTP/WebSocket API.
Represents an ApiGatewayV2 ApiMapping resource.
Represents an Authorizer.
Represents an APIGatewayV2 DomainName.
Represents an HTTP API.
An authorizer for HTTP APIs.
Represents an Integration for an HTTP API.
Represents a Route for an HTTP API.
An authorizer that can attach to an Http Route.
Represents the HttpStage.
Represents an integration to an API Route.
Represents a Mapping Value.
Credentials used for AWS Service integrations.
Represents a route.
Represents a Stage.
Represents an API Gateway VpcLink.
Represents a WebSocket API.
An authorizer for WebSocket APIs.
Represents an Integration for an WebSocket API.
Represents a Route for an WebSocket API.
An authorizer that can attach to an WebSocket Route.
Represents the WebSocketStage.
Represents a Mapping Value.
Represents a Parameter Mapping.
Payload format version for lambda proxy integration.
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).
Create a new API Gateway WebSocket API endpoint.
Represents the currently available API Key Selection Expressions.
An authorizer for WebSocket Apis.
The integration for an API route.
Explicitly configure no authorizers on specific WebSocket API routes.
Route class that creates the Route for API Gateway WebSocket API.
The interface that various route integration classes will inherit.
Represents a stage where an instance of the API is deployed.

# Type aliases

Payload format version for lambda authorizers.
Supported CORS HTTP methods.
Endpoint type for a domain name.
Supported Authorizer types.
Supported connection types.
Supported integration subtypes.
Supported integration types.
Supported HTTP methods.
The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
Supported Authorizer types.
WebSocket Integration Types.