How do I create a private integration with an internal Application Load Balancer for an API Gateway HTTP API?

Resolution

Note: If you receive errors when you run AWS Command Line Interface (AWS CLI) commands, then see Troubleshooting errors for the AWS CLI. Also, make sure that you're using the most recent AWS CLI version.

Create the VPC link

Prerequisite: Create an Application Load Balancer.

You can use either the API Gateway console or the AWS CLI to create the VPC link.

API Gateway console

Complete the following steps:

1. Open the API Gateway console.
2. In the navigation pane, choose VPC links, and then choose Create.
3. For Choose a VPC link version, choose VPC link for HTTP APIs.
4. For Name, enter a name for your VPC link.
5. On the VPC dropdown list, select a VPC for your Application Load Balancer to connect to.
6. For Subnets, select your subnets to include in the VPC link.
7. For Security groups, select the security groups for the VPC link, and then choose Create.

AWS CLI

Run the following create-vpc-link command:

aws apigatewayv2 create-vpc-link --name MyVpcLink \      --subnet-ids subnet-aaaa subnet-bbbb \  
    --security-group-ids sg1234 sg5678

Create an HTTP API and route

Complete the following steps:

1. Open the API Gateway console.
2. Choose Create API.
3. For HTTP API, choose Build.
4. For API name, enter a name, and then choose Next.
5. For Configure routes, choose Next.
6. For Configure stages, choose Next, and then choose Create.
7. In the navigation pane, choose Routes, and then choose Create.
8. For Method, choose ANY.
9. For path, enter /{proxy+} and then choose Create.

Create a private integration and deploy the HTTP API

Complete the following steps:

1. Open the API Gateway console.
2. Select your HTTP API.
3. In the navigation pane, choose Integrations.
4. For Integrations, choose Manage integrations, and then choose Create.
5. For Attach this integration to a route, choose ANY /{proxy+}.
6. For Integration target, choose Private resource.
7. For Integration details, choose Select manually.
8. For Target service, choose ALB/NLB.
9. For Load balancer, select your Application Load Balancer.
10. For Listener, choose HTTP 80.
11. For VPC link, select your VPC, and then choose Create.
12. If you didn't activate Auto deploy, then choose Deploy.
13. For Invoke URL, note the URL and enter it into a new browser window. An example URL is https://abcdef123.execute-api.us-east-1.amazonaws.com.

Note: Private integration traffic uses the HTTP protocol. If you require private integration traffic to use HTTPS, then use the AWS Management Console to specify a TlsConfig. When you create your private integration, choose Advanced settings, and then enter a secure server name. For more information, see Create private integrations for HTTP APIs in API Gateway.

Related information

Amazon API Gateway HTTP API tutorials

How do I map the response status codes for API Gateway integrations in HTTP APIs?