Prerequisites (Optional) Accept the private custom domain resource share Associate your VPC endpoint with a shared private custom domain name Create a Route 53 hosted zone Create a Route 53 DNS record Next steps for an API consumer

API consumer: Associate your VPC endpoint with a private custom domain name shared with you

The following procedure shows how to consume a private domain name in another Amazon Web Services account. Depending on your trust relationship with the API provider, Amazon RAM might complete some tasks for you.

When you are in a different Amazon Web Services account from a private custom domain name, you can only associate your VPC endpoint with a private custom domain name and invoke it. You can't view the policy or any other parameters of the private custom domain name.

Prerequisites

The following prerequisites are required to consume a private custom domain name in another Amazon Web Services account:

A VPC and a VPC endpoint for the execute-api service. Your VPC must have enableDnsHostnames and enableDnsSupport set to true.
We recommend that you configure at least two Availability Zones per VPC endpoint.

If your API provider used Amazon RAM to create a resource share, you have 12 hours to accept it. If you are in the same organization using Amazon Organizations as the API provider, the share is automatically accepted. If you are in an organization that has automatic shared resources enabled, the resource is automatically shared with you.

Associate your VPC endpoint with a shared private custom domain name

Because private custom domain names aren't unique, you associate your VPC endpoint with the unique custom domain name ARN. After you create your domain name access association, it can take up to 15 minutes for your VPC endpoint to successfully invoke your private custom domain name. If you have a VPC endpoint that you use to access a public custom domain name, don't use it to create any domain name access associations.

Amazon Web Services Management Console

To associate your VPC endpoint with a shared private custom domain name

Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway.
In the main navigation pane, choose Domain name access associations.
Choose Create domain name access association.
For Domain name ARN, select the domain name ARN that the API provider shared with you.

The domain name ARN might not appear in the dropdown list. You can use the Amazon RAM console to view domain names shared with you and then copy the domain name ARN and enter it into this field.
For VPC endpoint ID, select the VPC endpoint ID you want to form the domain name access association with.
Choose Create domain name access association.

Amazon CLI

Because private custom domain names aren't unique, you associate your VPC endpoint with the unique custom domain name ARN. To find the domain name ARN, use one of the following commands.

Amazon RAM
The following list-resources command lists resources that are shared with you. The API provider must have used Amazon RAM to share their private custom domain with you to use this command.
```
aws ram list-resources \
    --resource-owner OTHER-ACCOUNTS \
    --region us-west-2
    --resource-type apigateway:Domainnames
```
API Gateway
The following get-domain-names command lists all private custom domain names owned by other Amazon Web Services accounts that you can form domain name access associations with.
```
aws apigateway get-domain-names \
    --resource-owner OTHER_ACCOUNTS \
    --region us-west-2
```

After your retrieve the ARN, use API Gateway to create the domain name access association between your VPC endpoint and a shared private custom domain name. Use the following create-domain-name-access-association command:


aws apigateway create-domain-name-access-association \
    --access-association-source-type VPCE \
    --access-association-source 'vpce-1a2b3c4d5e6f1a2b3' \
    --domain-name-arn arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234"

The output will look like the following.


{
    "domainNameAccessAssociationARN": "arn:aws:apigateway:us-west-2:444455556666:/domainnameaccessassociations/domainname/private.example.com+abcd1234/vpcesource/vpce-abcd1234efg", 
    "accessAssociationSource": "vpce-1a2b3c4d5e6f1a2b3",
    "accessAssociationSourceType": "VPCE",
    "domainNameARN" : "arn:aws:apigateway:us-west-1:111122223333:/domainnames/private.example.com+a1b2c3"
}

After you associate your VPC endpoint with the private custom domain name, confirm that your API provider has updated the policy of their private custom domain name to allow your VPC endpoint to invoke their domain name. For more information, see Allow other accounts to invoke your private custom domain name.

Create a Route 53 hosted zone

To resolve the private custom domain name, you need to create a Route 53 private hosted zone. A hosted zone is container that holds information about how you want to route traffic for a domain within one or more VPCs without exposing your resources to the internet. For more information, see Working with private hosted zones.

Create a Route 53 DNS record

After you create the hosted zone, you create an record to resolve the private custom domain. In this example, you create an A record type. If you are using IPv6 for your VPC endpoint, create an AAAA record type. If you are using dualstack for your VPC endpoint, create both an AAAA and an A record type.

Next steps for an API consumer

You can now invoke the private API in your own Amazon Web Services account. In your VPC, you can use the following curl command to access your private custom domain name.


curl https://private.example.com/v1

For more information about other ways to invoke your private API, see Invoke a private API using a custom domain name.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

API provider: Share your private custom domain name using the API Gateway Amazon CLI

API consumer: Delete your domain name access association with a private custom domain name