Nombres de dominio personalizados para las API de WebSocket en API Gateway
Losnombres de dominio personalizados son direcciones URL más sencillas e intuitivas que puede proporcionar a los usuarios de la API.
Después de implementar la API, usted (y sus clientes) puede invocar la API utilizando la URL base predeterminada con el siguiente formato:
https://api-id.execute-api.region.amazonaws.com/stage
donde api-id lo genera API Gateway, region es la región de AWS y stage lo especifica usted al implementar la API.
La parte del nombre de host de la URL, api-id.execute-api.region.amazonaws.com
Con los nombres de dominio personalizados, puede configurar el nombre de host de la API y elegir una ruta base (por ejemplo, myservice) para asignarle una URL alternativa. Por ejemplo, una URL base de la API más simple puede ser:
https://api.example.com/myservice
Consideraciones
Las siguientes consideraciones pueden afectar el uso de un nombre de dominio personalizado.
-
Si asigna un nombre de dominio personalizado a una API de WebSocket, no puede asignarlo a una API de REST o HTTP.
-
Solo se admiten nombres de dominio personalizados regionales.
-
Para la versión de TLS mínima, solo se admite TLS 1.2.
-
Debe crear o actualizar el registro de recursos del proveedor de DNS para asignarlo al punto de conexión de la API. Si no se realiza este mapeo, las solicitudes de API vinculadas al nombre de dominio personalizado no pueden llegar a API Gateway.
-
Puede admitir un número casi infinito de nombres de dominio sin exceder el límite predeterminado mediante el uso de un certificado comodín. Para obtener más información, consulte Nombres de dominio personalizados comodín.
Requisitos previos
Los siguientes son requisitos previos para un nombre de dominio personalizado.
Registrar un nombre de dominio
Debe disponer de un nombre de dominio de Internet registrado para poder crear nombres de dominio personalizados para sus API. Puede registrar su nombre de dominio de Internet con Amazon Route 53 o un registrador de dominios de terceros de su elección. Su nombre de dominio personalizado puede ser el nombre de un subdominio o el dominio raíz (lo que recibe el nombre de “vértice de zona”) de un dominio de Internet registrado.
El nombre de dominio debe seguir la especificación RFC 1035
Certificados para nombres de dominio personalizados
Antes de configurar un nombre de dominio personalizado para una API, debe disponer de un certificado SSL/TLS listo en ACM. Si ACM no está disponible en la región de AWS donde va a crear su nombre de dominio personalizado, debe importar un certificado en API Gateway en esa región.
Para importar un certificado SSL/TLS, debe proporcionar el cuerpo del certificado SSL/TLS con formato PEM, su clave privada y la cadena de certificados para el nombre de dominio personalizado.
Los certificados almacenados en ACM se identifican mediante su ARN. Con los certificados emitidos por ACM no tiene que preocuparse de si se exponen datos del certificado confidenciales, como la clave privada. Para utilizar un certificado administrado por AWS para un nombre de dominio, solo tiene que hacer referencia a su ARN.
Si la aplicación utiliza asignación de certificados, también conocido como asignación SSL, para asignar un certificado de ACM, es posible que la aplicación no se pueda conectar al dominio una vez que AWS renueva el certificado. Para obtener más información, consulte Problemas de asignación de certificados en la Guía del usuario de AWS Certificate Manager.
Nombres de dominio personalizados comodín
Con los nombres de dominio personalizados comodín, puede admitir un número casi infinito de nombres de dominio sin exceder el límite predeterminado. Por ejemplo, puede dar a cada uno de los clientes su propio nombre de dominio, customername.api.example.com
Para crear un nombre de dominio personalizado comodín, especifique un comodín (*) como primer subdominio de un dominio personalizado que represente todos los subdominios posibles de un dominio raíz.
Por ejemplo, el nombre de dominio personalizado comodín *.example.com produce subdominios como a.example.com, b.example.com y c.example.com, que enrutan al mismo dominio.
Los nombres de dominio personalizados comodín admiten configuraciones distintas de los nombres de dominio personalizados estándar de API Gateway. Por ejemplo, en una sola cuenta de AWS, puede configurar *.example.com y a.example.com para que se comporten de manera diferente.
Puede utilizar las variables de contexto $context.domainName y $context.domainPrefix para determinar el nombre de dominio que un cliente utilizó para llamar a la API. Para obtener más información acerca de las variables de contexto, consulte Plantilla de mapeo de API Gateway y referencia de la variable de registro de acceso.
Para crear un nombre de dominio personalizado comodín, debe proporcionar un certificado emitido por ACM que se haya validado utilizando el método DNS o de validación de correo electrónico.
nota
No se puede crear un nombre de dominio personalizado comodín si una cuenta de AWS diferente ha creado un nombre de dominio personalizado que entra en conflicto con el nombre de dominio personalizado comodín. Por ejemplo, si la cuenta A ha creado a.example.com, la cuenta B no puede crear el nombre de dominio personalizado comodín *.example.com.
Si la cuenta A y la cuenta B comparten un propietario, puede contactar con el Centro de soporte de AWS
Siguientes pasos para nombres de dominio personalizados
Para configurar un nombre de dominio personalizado para una API de HTTP, utilice la sección API de REST de la Guía para desarrolladores de API Gateway.
En primer lugar, especifique el certificado para el nombre de dominio personalizado. Para obtener más información, consulte Preparación de certificados en AWS Certificate Manager. A continuación, cree un nombre de dominio personalizado regional. Para obtener más información, consulte Configuración de un nombre de dominio personalizado regional en API Gateway.
