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 Troubleshoot AWS CLI errors. Also, make sure that you're using the most recent AWS CLI version.

To create a private integration with an internal Application Load Balancer for an API Gateway HTTP API, complete the following steps:

1. Create an Amazon Virtual Private Cloud (Amazon VPC) link.
2. Create an HTTP API and route.
3. Create a private integration.
4. Deploy the HTTP API.

Create the VPC link

Prerequisite: Create an Application Load Balancer.

Complete the following steps:

1. Open the API Gateway console.

2. In the navigation pane, choose VPC links.

3. From VPC Links, choose Create.
   Or, create a VPC link from the AWS CLI with the create-vpc-link command:

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

4. From Choose a VPC link version, choose VPC link for HTTP APIs.

5. For Name, enter a name for your VPC link.

6. From the VPC dropdown list, choose a VPC for your Application Load Balancer to connect to.

7. For Subnets, choose your subnets to include in the VPC link.

8. For Security groups, choose the security groups for the VPC link, and then choose Create.

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. Choose 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, choose the Application Load Balancer that you already created.
10. For Listener, choose HTTP 80.
11. For VPC link, choose your VPC, and then choose Create.
12. (Skip this step if auto deploy is active) Choose Deploy to deploy your HTTP API.
13. For Invoke URL, copy the URL and paste it into a new browser window. For example, https://abcdef123.execute-api.us-east-1.amazonaws.com.

The HTTP API URL renders successfully in the browser window.

Related information

Amazon API Gateway HTTP API tutorials

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