How do I create a private custom domain name for my API Gateway private API?

Resolution

If you don't have a private API, then create one. Then, create an Amazon Virtual Private Cloud (Amazon VPC) endpoint.

Request or import an SSL/TLS certificate

Before you create a custom domain name for your API, you must request an SSL/TLS certificate from AWS Certificate Manager (ACM). Or, import an SSL/TLS certificate into ACM.

When you request or import the certificate, the certificate must include the custom domain name as an alternate domain name to pass domain validation checks.

For more information, see Get certificates ready in AWS Certificate Manager.

Create a private custom domain name

To create the custom domain name, see Tutorial: Create and invoke a custom domain name for private APIs. When you're creating the domain name, make sure that you follow best practices.

Verify that you correctly configured the private custom domain name

Use the base path mapping that you specified when you created the custom domain name to run a curl command on the domain name. Then, verify that the response to the custom domain name is the same response that you receive when you invoke the API stage URL.

Troubleshoot issues

If AWS resources fail to connect to your private API endpoint, then check your configuration requirements. For more information, see How do I troubleshoot issues when I connect to an API Gateway private API endpoint?

Related information

Migrate a custom domain name to a different API endpoint type in API Gateway

How can I set up a public custom domain name for my API Gateway API?