¿Cómo puedo configurar un nombre de dominio personalizado para mi API de API Gateway?

Breve descripción

Para las API de API Gateway puede crear nombres de dominio personalizados de dos tipos: regionales u optimizados para la periferia (solo para API de REST).

Nota: Las API privadas no admiten nombres de dominio personalizados.

Para configurar un nombre de dominio personalizado para su API de API Gateway, siga estos pasos:

• Solicite o importe un certificado SSL/TLS.
• Cree el nombre de dominio personalizado para su API de REST, API HTTP o API de WebSocket.
• Para probar la configuración, llame a su API con el nuevo nombre de dominio personalizado.

A continuación se explican algunas diferencias clave entre los nombres de dominio personalizados regionales y los optimizados para la periferia.

Diferencias en los puntos de enlace de destino

Los nombres de dominio personalizados regionales utilizan un punto de enlace de API regional.

Los nombres de dominio personalizados optimizados para la periferia utilizan una distribución de Amazon CloudFront.

Diferencias en los certificados SSL/TLS

Los nombres de dominio personalizados regionales deben usar un certificado SSL/TLS que se encuentre en la misma región de AWS que su API.

Los nombres de dominio personalizados optimizados para la periferia deben usar un certificado que esté en la siguiente región: Este de EE. UU. (Norte de Virginia) (us-east-1).

Diferencias en los nombres de dominio personalizados

Los nombres de dominio personalizados regionales se pueden compartir con otros nombres de dominio personalizados regionales que se encuentren en diferentes regiones de AWS.

Los nombres de dominio personalizados optimizados para la periferia son únicos y no pueden estar asociados a más de una distribución de CloudFront.

Diferencias en la asignación de nombres de dominio

Un nombre de dominio regional personalizado para una API de WebSocket no se puede asignar a una API de REST ni a una API HTTP. Sin embargo, un dominio personalizado regional se puede asociar tanto a API de REST como a API HTTP.

En el caso de las API de REST, tanto los nombres de dominio personalizados regionales como los optimizados para la periferia pueden tener asignaciones para puntos de enlace de API optimizados para la periferia, para puntos de enlace de API regionales, o para ambos.

En el caso de las API de WebSocket y las API HTTP, TLS 1.2 es la única versión de TLS compatible.

Solución

Solicitud o importación de un certificado SSL/TLS

Antes de crear un nombre de dominio personalizado para su API, debe realizar una de las siguientes acciones:

• Solicite un certificado SSL/TLS de AWS Certificate Manager (ACM).
  \Alternativa:
• Importe un certificado SSL/TLS a ACM.

Nota: Para obtener más información, consulte Getting certificates ready in AWS Certificate Manager.

Al solicitar o importar el certificado, tenga en cuenta los siguientes requisitos:

• Para superar las comprobaciones de validación del dominio, el certificado debe incluir el nombre de dominio personalizado como nombre de dominio alternativo.
  Nota: Para obtener más información sobre las comprobaciones de validación con las distribuciones de CloudFront (para nombres de dominio personalizados optimizados para la periferia), consulte Continually Enhancing Domain Security on Amazon CloudFront. Existen comprobaciones de validación similares para los nombres de dominio personalizados regionales.
• En el caso de un nombre de dominio personalizado con optimización para la periferia, el certificado de ACM se debe encontrar en la siguiente región: Este de EE. UU. (Norte de Virginia) (us-east-1).
• En el caso de un nombre de dominio personalizado regional, el certificado de ACM se debe encontrar en la misma región que su API.

Creación de un nombre de dominio personalizado para la API de REST, API HTTP o API de WebSocket

En el caso de las API de REST, siga las instrucciones en Setting up custom domain names for REST APIs.

En el caso de las API HTTP, siga las instrucciones en Setting up custom domain names for HTTP APIs.

En el caso de las API de WebSocket, siga las instrucciones en Setting up custom domain names for WebSocket APIs.

Enrutamiento del tráfico a una API de API Gateway

Utilice Amazon Route 53 para enrutar el tráfico a su dominio personalizado. De este modo tendrá un mayor control sobre los recursos a los que podrán acceder los usuarios cuando visiten su dominio.

Siga las instrucciones en Configuring Route 53 to route traffic to an API Gateway endpoint.

• Cuando configure Route 53, debe crear una zona alojada pública o una zona alojada privada. Elija una zona alojada pública para las aplicaciones con acceso a Internet con recursos que desee poner a disposición de los usuarios. Para obtener más información, consulte Working with hosted zones.
• Route 53 usa registros para determinar hacia dónde se enruta el tráfico de su dominio. Los registros de alias facilitan las consultas de DNS a los recursos de AWS, mientras que los registros CNAME (sin alias) pueden redirigir las consultas de DNS fuera de los recursos de AWS. Para obtener más información, consulte Choosing between alias and non-alias records.

Prueva de la configuración mediante una llamada a la API con el nuevo nombre de dominio personalizado

1.    Ejecute un comando curl en el nombre de dominio mediante la asignación de rutas base que especificó al crear el nombre de dominio personalizado.
Nota: Para obtener más información sobre curl, consulte el sitio web del proyecto curl.

2.    Compruebe que la respuesta al nombre de dominio personalizado sea la misma que recibe al invocar la URL de la etapa de la API.

Información relacionada

Migrating a custom domain name to a different API endpoint

Requesting a public certificate