Comment définir un nom de domaine personnalisé pour mon API Gateway ?

Date de la dernière mise à jour : 22/05/2020

Je souhaite utiliser un nom de domaine personnalisé pour mon API Amazon API Gateway au lieu d'utiliser l'URL de base par défaut. Comment puis-je configurer cela ?

Brève description

Dans API Gateway, vous pouvez créer un nom de domaine personnalisé optimisé pour la périphérie ou un nom de domaine personnalisé régional. Il existe quelques différences clés entre ces types de noms de domaine personnalisés :

Type de nom de domaine personnalisé Type d'API Point de terminaison cible Certificat SSL/TLS Nom de domaine
Optimisé pour la périphérie Seules les API REST peuvent utiliser des noms de domaine personnalisés optimisés pour la périphérie. Une distribution Amazon CloudFront avec un format similaire à examplek7xoo.cloudfront.net. Le certificat doit être dans la région AWS USA Est (Virginie du Nord) (us-east-1). Le nom de domaine doit être unique. (Il est attaché à un point de terminaison de distribution CloudFront en tant que CNAME et vous ne pouvez pas associer un CNAME à plusieurs distributions CloudFront.)
Régional Tous ces types d'API peuvent utiliser des noms de domaine personnalisés régionaux :
API REST
API WebSocket
API HTTP
Un point de terminaison d'API régionale avec un format similaire à examplevpz7.execute-api.us-west-2.amazonaws.com. Le certificat doit se trouver dans la même région que votre API. Le nom de domaine peut être partagé par d'autres noms de domaine personnalisés régionaux dans différentes régions.

Notez également ces différences clés pour le mappage de nom de domaine :

Solution

Demander ou importer un certificat SSL/TLS

Avant de créer un nom de domaine personnalisé pour votre API, vous devez demander un certificat SSL/TLS auprès d'AWS Certificate Manager (ACM) ou importer un certificat SSL/TLS dans ACM. Pour plus d'informations, consultez la section Préparation de certificats dans AWS Certificate Manager.

Lorsque vous demandez ou importez le certificat, notez les exigences suivantes :

  • Pour réussir les contrôles de validation de domaine, le certificat doit inclure le nom de domaine personnalisé comme nom de domaine alternatif. Pour plus d'informations sur les contrôles de validation avec les distributions CloudFront (pour les noms de domaine personnalisés optimisés pour la périphérie), consultez Amélioration continue de la sécurité du domaine sur Amazon CloudFront. Il existe des contrôles de validation similaires pour les noms de domaine personnalisés régionaux.
  • Pour un nom de domaine personnalisé optimisé pour la périphérie, le certificat ACM doit se trouver dans la région USA Est (Virginie du Nord) (us-east-1).
  • Pour un nom de domaine personnalisé régional, le certificat ACM doit se trouver dans la même région que votre API.

Création du nom de domaine personnalisé

En fonction de votre type d'API Gateway, choisissez l'un des éléments suivants pour obtenir des instructions sur la création d'un nom de domaine personnalisé :

Test du nom de domaine personnalisé

  1. Exécutez une commande curl sur le nom de domaine à l'aide du mappage de chemin de base que vous avez spécifié lorsque vous avez créé le nom de domaine personnalisé.
    Remarque : pour plus d'informations sur curl, consultez le site Web du projet cURL.
  2. Vérifiez que la réponse au nom de domaine personnalisé est la même que celle que vous recevez lorsque vous appelez l'URL de l'étape d'API.

Cet article vous a-t-il été utile?


Besoin d'aide pour une question technique ou de facturation ?