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

Dernière mise à jour : 28 mai 2021

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 procéder ?

Brève description

Il existe deux types de noms de domaine personnalisés que vous pouvez créer pour les API Gateway API : Régionaux ou (pour les API REST uniquement) optimisés pour les périphéries.

Remarque : les noms de domaine personnalisés ne sont pas supportés pour les API REST privées.

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

Voici quelques différences clés entre les noms de domaine personnalisés régionaux et les noms de domaine personnalisés optimisés pour les périphéries.

Différences des endpoints cibles

Les noms de domaine personnalisés régionaux utilisent un point de terminaison API régionale.

Les noms de domaine personnalisés optimisés pour les périphéries utilisent une distribution Amazon CloudFront.

Différences des certificats SSL/TLS

Les noms de domaine personnalisés régionaux doivent utiliser un certificat SSL/TLS qui se trouve dans la même région AWS que votre API.

Les noms de domaine personnalisés optimisés pour les périphéries doivent utiliser un certificat situé dans la région suivante : USA Est (Virginie du Nord) (us-east-1).

Différences de noms de domaine personnalisés

Les noms de domaine personnalisés régionaux peuvent être partagés par d'autres noms de domaine personnalisés régionaux qui se trouvent dans différentes régions AWS.

Les noms de domaine personnalisés optimisés pour les périphéries sont uniques et ne peuvent pas être associés à plusieurs distributions CloudFront.

Différences de mappage des noms

Un nom de domaine personnalisé régional pour une API WebSocket ne peut pas être mappé à une API REST ou à une API HTTP. Toutefois, un domaine personnalisé régional peut être associé à des API REST et à des API HTTP.

Pour les API REST, les noms de domaine personnalisés optimisés pour la périphérie et régionaux peuvent avoir des mappages pour les points de terminaison d'API optimisés pour la périphérie, les points de terminaison d'API régionaux, ou les deux.

Pour les API WebSocket et HTTP, TLS 1.2 est la seule version TLS prise en charge.

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 :
Demander un certificat SSL/TLS à l’AWS Certificate Manager (ACM).
-ou-
Importer un certificat SSL/TLS.

Remarque : 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.
    Remarque: 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éez le nom de domaine personnalisé pour votre API REST, API HTTP ou API WebSocket

Pour les API REST, suivez les instructions de la section Configuration des noms de domaine personnalisés pour les API REST.

Pour les API HTTP, suivez les instructions de la section Configuration des noms de domaine personnalisés pour les API HTTP.

Pour les API WebSocket, suivez les instructions de la section Configuration des noms de domaine personnalisés pour les API WebSocket.

Testez la configuration en appelant votre API à l'aide du nouveau 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 ?