Come faccio a configurare un nome di dominio personalizzato per la mia API Gateway API?

Breve descrizione

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

Nota:i nomi di dominio personalizzati non sono supportati per le API private.

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

• Richiedere o importare un certificato SSL/TLS.
• Creare il nome di dominio personalizzato per la REST API, l'API HTTP o l'API WebSocket.
• Verifica la configurazione chiamando la tua API con il nuovo nome di dominio personalizzato.

Di seguito sono riportate alcune differenze chiave tra i nomi di dominio personalizzati regionali e quelli ottimizzati per l'edge.

Differenze tra 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 Amazon CloudFront.

Differenze nei certificati SSL/TLS

I nomi di dominio personalizzati regionali devono utilizzare un certificato SSL/TLS 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).

Differenze tra nomi di dominio personalizzati

I nomi di dominio personalizzati regionali possono essere condivisi con altri nomi di dominio personalizzati regionali che si trovano in diverse regioni AWS.

I nomi di dominio personalizzati ottimizzati per l'edge sono univoci e non possono essere associati a più di una distribuzione CloudFront.

Differenze nella mappatura dei nomi di dominio

Un nome di dominio personalizzato regionale per un'API WebSocket non può essere mappato su una REST API o a un'API HTTP. Tuttavia, un dominio personalizzato regionale può essere associato alle REST API e alle 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

Richiedere o importare un certificato SSL/TLS

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

• Richiedi un certificato SSL/TLS dalla Gestione certificati AWS (ACM).
  -oppure-
• Importa un certificato SSL/TLS in ACM.

**Nota:**per ulteriori informazioni, consulta Getting certificates ready in AWS Certificate Manager.

Quando richiedi o importi il certificato, tieni presente 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 CloudFront (per nomi di dominio personalizzati ottimizzati per l'edge), consulta la pagina relativa a Continually Enhancing Domain Security on Amazon CloudFront. Esistono controlli di convalida simili per i nomi di dominio personalizzati regionali.
• Per un nome di dominio personalizzato ottimizzato per l'edge, il certificato ACM deve trovarsi nella seguente regione: Stati Uniti orientali (Virginia settentrionale) (us-east-1).
• 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 Setting up custom domain names for REST APIs.

Per le API HTTP, segui le istruzioni nelle Setting up custom domain names for HTTP APIs.

Per le API WebSocket, segui le istruzioni in Setting up custom domain names for WebSocket APIs.

Indirizzare il traffico verso la propria API Gateway API

Usa Amazon Route 53 per indirizzare il traffico verso il tuo dominio personalizzato. Questo ti consente di avere un maggiore controllo sulle risorse a cui gli utenti possono accedere quando visitano il tuo dominio.

Segui le istruzioni in Configuring Route 53 to route traffic to an API Gateway endpoint.

• Quando si configura la Route 53, è necessario 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 Working with hosted zones.
• Route 53 utilizza i record per determinare dove viene indirizzato il traffico per il tuo dominio. 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 la sezione Choosing between alias and non-alias records.

Verificare la configurazione chiamando la propria API con il nuovo nome di dominio personalizzato

1. Esegui un comando curl sul nome di dominio utilizzando la mappatura del percorso di base specificata al momento della creazione del nome di dominio personalizzato.
   **Nota:**per ulteriori informazioni su curl, consulta il sito web del progetto curl.

2. Verifica che la risposta al nome di dominio personalizzato sia la stessa risposta che ricevi quando richiami l'URL della fase API.

Informazioni correlate

Migrating a custom domain name to a different API endpoint

Requesting a public certificate