This release is a pre-release and may not be stable for production use.
AWS APIGatewayv2 Integrations
---
This API may emit warnings. Backward compatibility is not guaranteed.
All constructs moved to aws-cdk-lib/aws-apigatewayv2-integrations.
Table of Contents
HTTP APIs
Integrations connect a route to backend resources. HTTP APIs support Lambda proxy, AWS service, and HTTP proxy integrations. HTTP proxy integrations are also known as private integrations.
Lambda
Lambda integrations enable integrating an HTTP API route with a Lambda function. When a client invokes the route, the API Gateway service forwards the request to the Lambda function and returns the function's response to the client.
The API Gateway service will invoke the Lambda function with an event payload of a specific format. The service expects the function to respond in a specific format. The details on this format are available at Working with AWS Lambda proxy integrations.
The following code configures a route GET /books with a Lambda proxy integration.
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpLambdaIntegration
# books_default_fn: lambda.Function
books_integration = HttpLambdaIntegration("BooksIntegration", books_default_fn)
http_api = apigwv2.HttpApi(self, "HttpApi")
http_api.add_routes(
path="/books",
methods=[apigwv2.HttpMethod.GET],
integration=books_integration
)
HTTP Proxy
HTTP Proxy integrations enables connecting an HTTP API route to a publicly routable HTTP endpoint. When a client invokes the route, the API Gateway service forwards the entire request and response between the API Gateway endpoint and the integrating HTTP endpoint. More information can be found at Working with HTTP proxy integrations.
The following code configures a route GET /books with an HTTP proxy integration to an HTTP endpoint
get-books-proxy.example.com.
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpUrlIntegration
books_integration = HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.example.com")
http_api = apigwv2.HttpApi(self, "HttpApi")
http_api.add_routes(
path="/books",
methods=[apigwv2.HttpMethod.GET],
integration=books_integration
)
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.
The following integrations are supported for private resources in a VPC.
Application Load Balancer
The following code is a basic application load balancer private integration of HTTP API:
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpAlbIntegration
vpc = ec2.Vpc(self, "VPC")
lb = elbv2.ApplicationLoadBalancer(self, "lb", vpc=vpc)
listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
port=80
)
http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
default_integration=HttpAlbIntegration("DefaultIntegration", listener)
)
When an imported load balancer is used, the vpc option must be specified for HttpAlbIntegration.
Network Load Balancer
The following code is a basic network load balancer private integration of HTTP API:
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpNlbIntegration
vpc = ec2.Vpc(self, "VPC")
lb = elbv2.NetworkLoadBalancer(self, "lb", vpc=vpc)
listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
port=80
)
http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
default_integration=HttpNlbIntegration("DefaultIntegration", listener)
)
When an imported load balancer is used, the vpc option must be specified for HttpNlbIntegration.
Cloud Map Service Discovery
The following code is a basic discovery service private integration of HTTP API:
import aws_cdk.aws_servicediscovery as servicediscovery
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpServiceDiscoveryIntegration
vpc = ec2.Vpc(self, "VPC")
vpc_link = apigwv2.VpcLink(self, "VpcLink", vpc=vpc)
namespace = servicediscovery.PrivateDnsNamespace(self, "Namespace",
name="boobar.com",
vpc=vpc
)
service = namespace.create_service("Service")
http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
default_integration=HttpServiceDiscoveryIntegration("DefaultIntegration", service,
vpc_link=vpc_link
)
)
Request Parameters
Request parameter mapping allows API requests from clients to be modified before they reach backend integrations. Parameter mapping can be used to specify modifications to request parameters. See Transforming API requests and responses.
The following example creates a new header - header2 - as a copy of header1 and removes header1.
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpAlbIntegration
# lb: elbv2.ApplicationLoadBalancer
listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
port=80
)
http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
default_integration=HttpAlbIntegration("DefaultIntegration", listener,
parameter_mapping=apigwv2.ParameterMapping().append_header("header2", apigwv2.MappingValue.request_header("header1")).remove_header("header1")
)
)
To add mapping keys and values not yet supported by the CDK, use the custom() method:
from aws_cdk.aws_apigatewayv2_integrations_alpha import HttpAlbIntegration
# lb: elbv2.ApplicationLoadBalancer
listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
port=80
)
http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
default_integration=HttpAlbIntegration("DefaultIntegration", listener,
parameter_mapping=apigwv2.ParameterMapping().custom("myKey", "myValue")
)
)
WebSocket APIs
WebSocket integrations connect a route to backend resources. The following integrations are supported in the CDK.
Lambda WebSocket Integration
Lambda integrations enable integrating a WebSocket API route with a Lambda function. When a client connects/disconnects or sends a message specific to a route, the API Gateway service forwards the request to the Lambda function
The API Gateway service will invoke the Lambda function with an event payload of a specific format.
The following code configures a sendMessage route with a Lambda integration
from aws_cdk.aws_apigatewayv2_integrations_alpha import WebSocketLambdaIntegration
# message_handler: lambda.Function
web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
apigwv2.WebSocketStage(self, "mystage",
web_socket_api=web_socket_api,
stage_name="dev",
auto_deploy=True
)
web_socket_api.add_route("sendMessage",
integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler)
)
2 maintainers
Release files for aws-cdk.aws-apigatewayv2-integrations-alpha 2.114.1a0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws-cdk.aws-apigatewayv2-integrations-alpha-2.114.1a0.tar.gz | 66.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_cdk.aws_apigatewayv2_integrations_alpha-2.114.1a0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 132.2 kB
Release files / aws-cdk.aws-apigatewayv2-integrations-alpha-2.114.1a0.tar.gz
| Download URL | aws-cdk.aws-apigatewayv2-integrations-alpha-2.114.1a0.tar.gz |
|---|---|
| Size | 66.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
19e1824b577683e7d3c2b01fd58c176ebe4c7b8d1b4af4cfdc3893d3ffbac9af
|
|
BLAKE2b-256 checksum How to use checksums |
8ce7741e1b6945dc34d0377e33293bb48a5a422d864e02977fd3507825b53bbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / aws_cdk.aws_apigatewayv2_integrations_alpha-2.114.1a0-py3-none-any.whl
| Download URL | aws_cdk.aws_apigatewayv2_integrations_alpha-2.114.1a0-py3-none-any.whl |
|---|---|
| Size | 65.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e440a70e6b4cbe077c95ffdd3fd0cfb3962f90762ea2e973eaa2ab7719ccb2c
|
|
BLAKE2b-256 checksum How to use checksums |
ef089e8218dc67fef0e8c70e4f1dd618cf8d8d92eb92e20c6ff5591fce5e067a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
