Come posso configurare un nome di dominio pubblico personalizzato per la mia API di Gateway API?

5 minuti di lettura

Desidero utilizzare un nome di dominio personalizzato per la mia API di Gateway Amazon API anziché l'URL di base predefinito.

Breve descrizione

Esistono due tipi di nomi di dominio personalizzati che puoi creare per le API di API Gateway: Regionale o (solo per le REST API) ottimizzato per l'edge .

Nota: Gateway API supporta nomi di dominio personalizzati per API private.

Per configurare un nome di dominio personalizzato per un'API di Gateway API, procedi come segue:

Richiedi o importa un certificato SSL/TLS.
Crea il nome di dominio personalizzato per la REST API, l'API HTTP o l'API WebSocket.
Per verificare la configurazione, utilizza il nuovo nome di dominio personalizzato per chiamare l'API.

Per configurare correttamente un dominio personalizzato, devi comprendere le differenze tra i tipi di nomi di dominio personalizzati. Di seguito sono riportate alcune differenze essenziali tra i nomi di dominio personalizzati Regionali e quelli ottimizzati per l'edge:

Per gli endpoint di destinazione, i nomi di dominio personalizzati Regionali utilizzano un endpoint API Regionale. I nomi di dominio personalizzati ottimizzati per l'edge utilizzano una distribuzione di Amazon CloudFront.
Per i certificati SSL/TLS, i nomi di dominio personalizzati Regionali devono utilizzare un certificato SSL/TLS che si trova nella stessa Regione AWS dell'API. I nomi di dominio personalizzati ottimizzati per l'edge devono utilizzare un certificato che si trova nella seguente Regione: Stati Uniti orientali (Virginia settentrionale) (us-east-1).
Per i nomi di dominio personalizzati, puoi condividere nomi di dominio personalizzati Regionali tra diverse Regioni AWS. I nomi di dominio personalizzati ottimizzati per l'edge sono unici. Non puoi associare nomi di dominio personalizzati a più di una distribuzione di CloudFront.
Per i nomi di dominio, non puoi mappare un nome di dominio personalizzato Regionale di un'API WebSocket su una REST API o un'API HTTP. Tuttavia, puoi associare un dominio personalizzato Regionale con REST API e API HTTP. Per le REST API, sia i nomi di dominio personalizzati ottimizzati per l'edge che quelli Regionali possono avere mappature per endpoint API ottimizzati per l'edge, endpoint API Regionali o entrambi. Per le API WebSocket e le API HTTP, TLS 1.2 è l'unica versione TLS supportata.

Risoluzione

Richiedi o importa un certificato SSL/TLS

Prima di creare un nome di dominio personalizzato per l'API, devi effettuare una delle seguenti operazioni:

Richiedi un certificato SSL/TLS da Gestione certificati AWS (ACM).
Importa un certificato SSL/TLS in ACM.

Nota: per ulteriori informazioni, consulta Preparazione di certificati in Gestione certificati AWS.

Quando richiedi o importi il certificato, devi soddisfare i seguenti requisiti:

Per superare i controlli di convalida del dominio, il certificato deve includere il nome di dominio personalizzato come nome di dominio alternativo.
Nota: per ulteriori informazioni sui controlli di convalida con le distribuzioni di CloudFront (per nomi di dominio personalizzati ottimizzati per l'edge), consulta Miglioramento continuo della sicurezza dei domini in Amazon CloudFront. Esistono controlli di convalida simili per i nomi di dominio personalizzati Regionali.
Per un nome di dominio personalizzato Regionale, il certificato ACM deve trovarsi nella stessa Regione dell'API.

Creare il nome di dominio personalizzato per REST API, API HTTP o API WebSocket

Per le REST API, segui le istruzioni in Nomi di dominio personalizzati per REST API pubbliche in Gateway API.

Per le API HTTP, segui le istruzioni Nomi di dominio personalizzati per API HTTP in Gateway API.

Per le API WebSocket, segui le istruzioni in Nomi di dominio personalizzati per API WebSocket in Gateway API.

Indirizzare il traffico verso la propria API di Gateway API

Per indirizzare il traffico verso il dominio personalizzato, utilizza Amazon Route 53.

Per indirizzare il traffico verso l'API di Gateway API, segui le istruzioni in Configurazione di Route 53 per instradare il traffico a un endpoint di Gateway API.

Quando configuri Route 53, devi creare una zona ospitata pubblica o una zona ospitata privata. Per le applicazioni rivolte a Internet con risorse che desideri mettere a disposizione degli utenti, scegli una zona ospitata pubblica. Per ulteriori informazioni, consulta Utilizzo delle zone ospitate.

Per determinare dove viene indirizzato il traffico del dominio, Route 53 utilizza record. I record di alias forniscono query DNS più semplici alle risorse AWS, mentre i record CNAME (non di alias) possono reindirizzare le query DNS al di fuori delle risorse AWS. Per ulteriori informazioni, consulta Scelta tra record alias e non alias.

Verifica la configurazione

Per verificare la configurazione, puoi utilizzare il nuovo nome di dominio personalizzato per chiamare l'API:

Utilizza la mappatura del percorso di base specificata quando crei il nome di dominio personalizzato per eseguire un comando curl sul nome di dominio.
**Nota:**per ulteriori informazioni su curl, consulta il sito web del progetto curl.
Verifica che la risposta al nome di dominio personalizzato sia la stessa risposta che ricevi quando richiami l'URL della fase API.