Comment puis-je configurer un nom de domaine personnalisé public pour mon API Gateway ?

Brève description

Pour les API Gateway; vous pouvez créer des noms de domaines personnalisés de deux types : Régionaux, ou (pour les API REST uniquement) optimisés pour la périphérie.

Remarque : API Gateway prend en charge les noms de domaine personnalisés pour les API privées.

Pour configurer un nom de domaine personnalisé pour votre API Gateway, procédez comme suit :

• Demandez ou importez un certificat SSL/TLS.
• Créez le nom de domaine personnalisé pour votre API REST, API HTTP ou API WebSocket.
• Pour tester la configuration, utilisez le nouveau nom de domaine personnalisé pour appeler votre API.

Pour configurer correctement un domaine personnalisé, vous devez comprendre les différences entre les types de noms de domaine personnalisés. Voici quelques-unes des principales différences entre les noms de domaines personnalisés régionaux et les noms de domaine optimisés pour la périphérie.

• Pour les points de terminaison cibles, les noms de domaine personnalisés régionaux utilisent un point de terminaison d'API régional. Les noms de domaines personnalisés optimisés pour la périphérie utilisent une distribution Amazon CloudFront.
• Pour les certificats SSL/TLS, les noms de domaines personnalisés régionaux doivent utiliser un certificat SSL/TLS situé dans la même région AWS que votre API. Les noms de domaine personnalisés optimisés pour la périphérie doivent utiliser un certificat situé dans la région suivante : USA Est (Virginie du Nord) (us-east-1).
• Pour les noms de domaine personnalisés, vous pouvez partager des noms de domaine personnalisés régionaux dans différentes régions AWS. Les noms de domaine personnalisés optimisés pour la périphérie sont uniques. Il n’est pas possible d’associer des noms de domaine personnalisés à plusieurs distributions CloudFront.
• Pour les noms de domaine, il n’est pas possible de mapper un nom de domaine personnalisé régional pour une API WebSocket à une API REST ou HTTP. Toutefois, vous pouvez associer un domaine personnalisé régional aux API REST et HTTP. Pour les API REST, les noms de domaines personnalisés régionaux comme les noms de domaines optimisés pour la périphérie peuvent être mappés à des points de terminaison d’API optimisés pour la périphérie, à des points de terminaison d’API régionaux, ou aux deux. Pour les API WebSocket et les API HTTP, la seule version TLS prise en charge est TLS 1.2.

Résolution

Demander ou importer un certificat SSL/TLS

Avant de créer un nom de domaine personnalisé pour votre API, vous devez effectuer l’une des opérations suivantes :

• Demandez un certificat SSL/TLS auprès d’AWS Certificate Manager (ACM).
• Importez un certificat SSL/TLS dans ACM.

Remarque : Pour plus d’informations, consultez la section Préparer des certificats dans AWS Certificate Manager.

Lorsque vous demandez ou importez le certificat, vous devez remplir les conditions suivantes :

• Pour réussir les contrôles de validation du domaine, le certificat doit inclure le nom de domaine personnalisé comme nom de domaine alternatif.
  Remarque : Pour plus d’informations sur les contrôles de validation avec les distributions CloudFront (pour les noms de domaines personnalisés optimisés pour la périphérie), consultez la section Amélioration continue de la sécurité de domaine sur Amazon CloudFront. Les noms de domaines personnalisés régionaux font l’objet de contrôles de validation similaires.
• Pour un nom de domaine personnalisé régional, le certificat ACM doit se trouver dans la même région que votre API.

Créer le nom de domaine personnalisé de l’API REST, de l’API HTTP ou de l’API WebSocket

Pour les API REST, suivez les instructions de la section Nom de domaine personnalisé pour les API REST publiques dans API Gateway.

Pour les API HTTP, suivez les instructions de la section Noms de domaine personnalisés pour les API HTTP dans API Gateway.

Pour les API WebSocket, suivez les instructions de la section Noms de domaine personnalisés pour les API WebSocket dans l’API.

Acheminer le trafic vers une API API Gateway

Pour acheminer le trafic vers votre domaine personnalisé, utilisez Amazon Route 53.

Pour acheminer le trafic vers votre API API Gateway, suivez les instructions de la section Configuration de Route 53 pour acheminer le trafic vers un point de terminaison API Gateway.

Lors de la configuration de Route 53, vous devez créer une zone hébergée publique ou une zone hébergée privée. Pour les applications connectées à Internet comprenant des ressources que vous souhaitez mettre à la disposition des utilisateurs, choisissez une zone hébergée publique. Pour plus d’informations, consultez la section Utilisation de zones hébergées.

Pour déterminer où le trafic de votre domaine est acheminé, Route 53 utilise des enregistrements. Les enregistrements d’alias facilitent la transmission des requêtes DNS vers les ressources AWS, tandis que les enregistrements CNAME (sans alias) peuvent rediriger les requêtes DNS en dehors des ressources AWS. Pour plus d’informations, consultez la section Choix entre des enregistrement avec ou sans alias.

Tester la configuration

Pour tester la configuration, vous pouvez utiliser le nouveau nom de domaine personnalisé pour appeler l'API :

1. Utilisez le mappage de chemin de base que vous indiquez lors de la création du nom de domaine personnalisé pour exécuter une commande curl sur le nom de domaine.
   Remarque : Pour obtenir plus de renseignements sur curl, consultez le site Web du projet curl.
2. Vérifiez que la réponse au nom de domaine personnalisé est identique à celle que vous obtenez lorsque vous appelez l’URL de l’étape d’API.

Informations connexes

Migrer un nom de domaine personnalisé vers un autre type de point de terminaison d'API dans API Gateway

Demander un certificat public dans AWS Certificate Manager.