Nom de domaine personnalisé pour le REST public APIs dans API Gateway

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Les noms de domaine personnalisés sont plus simples et plus intuitifs URLs et vous pouvez les fournir aux utilisateurs de votre API.

Après avoir déployé votre API, vous (et vos clients) pouvez appeler cette API à l’aide de l’URL de base par défaut au format suivant :

https://api-id.execute-api.region.amazonaws.com/stage

où api-id est généré par API Gateway, region est la AWS région et stage est spécifiée par vous lors du déploiement de l'API.

La partie nom d’hôte de l’URL, api-id.execute-api.region.amazonaws.com, fait référence à un point de terminaison de l’API. Le nom par défaut du point de terminaison de l’API est généré de manière aléatoire, difficile à mémoriser et peu convivial.

Avec des noms de domaine personnalisés, vous pouvez configurer le nom d’hôte de votre API et choisir un chemin de base (par exemple, myservice) pour mapper l’URL alternative à votre API. Par exemple, une URL de base de l’API plus conviviale peut devenir :

https://api.example.com/myservice

Considérations

Les considérations suivantes peuvent avoir une incidence sur votre utilisation d’un nom de domaine personnalisé.

Prérequis concernant les noms de domaine personnalisés

Les conditions suivantes sont requises pour créer un nom de domaine personnalisé public ou privé. Pour plus d'informations sur les noms de domaine personnalisés pour le secteur privé APIs, consultezNoms de domaine personnalisés pour le privé APIs dans API Gateway.

Enregistrement d’un nom de domaine

Vous devez avoir un nom de domaine Internet enregistré afin de configurer des noms de domaine personnalisés pour votre APIs. Vous pouvez enregistrer votre nom de domaine Internet avec Amazon Route 53 ou utiliser un bureau d’enregistrement de domaine tiers de votre choix. Votre nom de domaine personnalisé peut être le nom d’un sous-domaine ou le domaine racine (également nommé « zone apex ») d’un domaine Internet enregistré.

Votre nom de domaine doit respecter la spécification RFC 1035 et peut comporter un maximum de 63 octets par étiquette et 255 octets au total.

Spécification du certificat pour votre nom de domaine personnalisé

Avant de configurer un nom de domaine personnalisé pour une API, vous devez avoir un certificat SSL/TLS prêt dans ACM. Si ACM n'est pas disponible dans la AWS région où vous créez votre nom de domaine personnalisé, vous devez importer un certificat dans API Gateway dans cette région.

Pour importer le corps d'un SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS certificat, sa clé privée et la chaîne de certificats pour le nom de domaine personnalisé.

Chaque certificat stocké dans ACM est identifié par son ARN. Avec les certificats émis par ACM, vous n’avez pas à vous inquiéter d’une éventuelle exposition des informations sensibles du certificat, par exemple sa clé privée. Pour utiliser un certificat AWS géré pour un nom de domaine, il suffit de référencer son ARN.

Si votre application utilise l'épinglage de certificat, parfois appelé épinglage SSL, pour épingler un certificat ACM, il est possible que l'application ne puisse pas se connecter à votre domaine après le AWS renouvellement du certificat. Pour plus d’informations, consultez la section Problèmes d’épinglage de certificat dans le Guide de l’utilisateur AWS Certificate Manager .

Noms de domaine personnalisés génériques

Avec les noms de domaine personnalisés génériques, vous pouvez prendre en charge un nombre presque infini de noms de domaine sans dépasser le quota par défaut. Par exemple, vous pouvez donner à chacun de vos clients son propre nom de domaine, customername.api.example.com.

Pour créer un nom de domaine personnalisé générique, vous pouvez spécifier un caractère générique (*) comme premier sous-domaine d’un domaine personnalisé qui représente tous les sous-domaines possibles d’un domaine racine.

Par exemple, le nom de domaine personnalisé générique *.example.com se traduit par des sous-domaines tels que a.example.com, b.example.com et c.example.com, qui effectuent tous un routage vers le même domaine.

Les noms de domaine personnalisés génériques prennent en charge des configurations distinctes des noms de domaine personnalisés standard d’API Gateway. Par exemple, dans un seul AWS compte, vous pouvez configurer *.example.com et a.example.com vous comporter différemment.

Vous pouvez utiliser les variables de contexte $context.domainName et $context.domainPrefix pour déterminer le nom de domaine utilisé par un client pour appeler votre API. Pour en savoir plus sur les variables de contexte, consultez Modèle de mappage API Gateway et référence à la variable de journalisation des accès.

Pour créer un nom de domaine personnalisé générique, vous devez fournir un certificat émis par ACM qui a été validé à l’aide du DNS ou de la méthode de validation par e-mail.

Étapes suivantes pour les noms de domaine personnalisés

Les prochaines étapes pour les noms de domaine personnalisés sont les suivantes :

Si c’est la première fois que vous créez un nom de domaine personnalisé, nous vous recommandons de commencer par la section Préparez les certificats AWS Certificate Manager pour spécifier votre certificat, puis la section Configuration d’un nom de domaine personnalisé régional dans API Gateway pour créer un nom de domaine personnalisé régional.