How do I troubleshoot API Gateway public custom domain name configuration issues?

Resolution

To troubleshoot API Gateway public custom domain name configuration issues, use the AWSSupport-TroubleshootAPIGatewayCustomDomainConfig runbook. This runbook supports public custom domains that are set with the default routing mode API mappings only. This runbook doesn't support custom domains that are set with the routing modes for routing rules or private custom domains.

Prerequisite: Make sure that your AWS Identity and Access Management (IAM) user or role has the required permissions. For more information, see the IAM Permissions section of AWSSupport-TroubleshootAPIGatewayCustomDomainConfig.

Run the Systems Manager runbook

Complete the following steps:

1. Open the AWS Systems Manager console.
2. In the navigation pane, choose Documents.
3. In the search bar, enter TroubleshootAPIGatewayCustomDomainConfig.
4. Select the AWSSupport-TroubleshootAPIGatewayCustomDomainConfig document.
5. Choose Execute automation.
6. Choose Execute.
   Note: For a list of the steps that the runbook performs, see AWSSupport-TroubleshootAPIGatewayCustomDomainConfig.
7. After the automation completes, review the detailed results in the Outputs section.
   If the runbook checks run successfully, then your output includes the custom domain name's configuration details.
   If the custom domain name's configuration doesn't pass one of the checks within the runbook, then the runbook fails at that step. To troubleshoot runbook failures, use the troubleshooting recommendations in the runbook output.

Related information

Run an automated operation powered by Systems Manager Automation

Setting up Automation

Systems Manager Automation Runbook Reference