Configura un nome di dominio personalizzato ottimizzato per i dispositivi periferici in Gateway API - Amazon API Gateway
ConsiderazioniCrea un nome di dominio personalizzato ottimizzato per i bordiCrea un DNS record per il tuo nome di dominio personalizzato ottimizzato per edgeAccedi alla creazione di nomi di dominio personalizzati CloudTrailConfigura la mappatura del percorso di base di un utente API con un nome di dominio personalizzato come nome hostRotazione di un certificato importato in ACMChiama il tuo con nomi di dominio personalizzati API

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configura un nome di dominio personalizzato ottimizzato per i dispositivi periferici in Gateway API

Quando si crea un nome di dominio personalizzato per un sistema ottimizzato per i dispositivi edgeAPI, API Gateway imposta una CloudFront distribuzione e un DNS record per mappare il nome di API dominio al nome di dominio di CloudFront distribuzione. Le richieste per il API vengono quindi indirizzate a API Gateway tramite la distribuzione mappata. CloudFront Questa mappatura riguarda API le richieste destinate al nome di dominio personalizzato da indirizzare a API Gateway tramite la distribuzione mappata. CloudFront

Considerazioni

Di seguito sono riportate alcune considerazioni relative al nome di dominio personalizzato ottimizzato per i dispositivi edge.

  • Per configurare un nome di dominio personalizzato ottimizzato per i dispositivi periferici o per aggiornarne il certificato, devi disporre dell'autorizzazione per aggiornare le distribuzioni. CloudFront

    Per aggiornare le distribuzioni sono necessarie le seguenti autorizzazioni: CloudFront 

    {
    "Version": "2012-10-17",
    "Statement": [
         {
            "Sid": "AllowCloudFrontUpdateDistribution",
            "Effect": "Allow",
            "Action": [
                "cloudfront:updateDistribution"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

  • È necessario richiedere o importare un certificato per il nome di dominio personalizzato ottimizzato per i dispositivi edge nella regione Stati Uniti orientali (Virginia settentrionale). us-east-1

  • La CloudFront distribuzione creata da API Gateway è di proprietà di un account specifico della regione affiliato a Gateway. API Quando si tracciano le operazioni per creare e aggiornare tale CloudFront distribuzione CloudTrail, è necessario utilizzare questo API ID account Gateway. Per ulteriori informazioni, consulta Accedi alla creazione di nomi di dominio personalizzati CloudTrail.

  • APIGateway supporta nomi di dominio personalizzati ottimizzati per i dispositivi perimetrali sfruttando Server Name Indication () SNI sulla distribuzione. CloudFront Per ulteriori informazioni sull'utilizzo di nomi di dominio personalizzati su una CloudFront distribuzione, incluso il formato di certificato richiesto e la dimensione massima della lunghezza della chiave del certificato, consulta Using Alternate Domain Names e HTTPS nella Amazon CloudFront Developer Guide

  • Un nome di dominio personalizzato ottimizzato per l'edge impiega circa 40 minuti per essere pronto.

  • Dopo aver creato il nome di dominio personalizzato ottimizzato per i bordi, devi creare un DNS record per mappare il nome di dominio personalizzato al nome di distribuzione. CloudFront

Crea un nome di dominio personalizzato ottimizzato per i bordi

La procedura seguente descrive come creare un nome di dominio personalizzato ottimizzato per i bordi per un. API

AWS Management Console

  1. Accedere alla console API Gateway all'indirizzo /apigateway. https://console.aws.amazon.com

  2. Scegliere Custom Domain Names (Nomi di dominio personalizzati) nel riquadro di navigazione principale.

  3. Seleziona Crea.

  4. In Domain name (Nome di dominio), immettere un nome di dominio.

  5. Per TLSVersione minima, seleziona una versione.

  6. In Configurazione dell'endpoint, per il tipo di API endpoint, scegli Ottimizzato per Edge.

  7. Per il ACMcertificato, scegli un certificato. ACM

  8. Scegliere Create domain name (Crea nome di dominio).

REST API

  1. Chiama domainname:create, specificando il nome di dominio personalizzato e il certificato archiviato inARN. AWS Certificate Manager

    La API chiamata riuscita restituisce una 201 Created risposta contenente il certificato e il nome ARN di CloudFront distribuzione associato nel relativo payload.

  2. Annota il nome del dominio di CloudFront distribuzione mostrato nell'output. Ne hai bisogno nel passaggio successivo per impostare l'alias A-record del dominio personalizzato nel tuo. DNS

Per esempi di codice di questa REST API chiamata, vedi domainname:create.

Un nome di dominio personalizzato ottimizzato per l'edge impiega circa 40 minuti per essere pronto, ma la console visualizza immediatamente il nome di dominio di CloudFront distribuzione associato, sotto forma di, insieme al certificato. distribution-id.cloudfront.net ARN Nel frattempo, puoi continuare con il passaggio successivo e configurare l'alias del DNS record per mappare il nome di dominio personalizzato al nome di dominio di distribuzione associato. CloudFront

Crea un DNS record per il tuo nome di dominio personalizzato ottimizzato per edge

Dopo aver avviato la creazione del nome di dominio personalizzato ottimizzato per i dispositivi perimetrali, configura l'alias del record. DNS

Ti consigliamo di utilizzare Route 53 per creare un alias di record A per il tuo nome di dominio personalizzato e specificare il nome di dominio di CloudFront distribuzione come destinazione dell'alias. Ciò significa che Route 53 è in grado di instradare il nome di dominio personalizzato anche se si tratta di un apex di zona. Per ulteriori informazioni, consulta la pagina relativa alla scelta tra set di record della risorsa alias e non alias nella Guida per gli sviluppatori di Amazon Route 53.

Per istruzioni su Amazon Route 53, consulta Routing del traffico verso un Amazon API Gateway API utilizzando il tuo nome di dominio nella Amazon Route 53 Developer Guide.

Accedi alla creazione di nomi di dominio personalizzati CloudTrail

Quando CloudTrail è abilitato per la registrazione delle chiamate API Gateway effettuate dall'account, API Gateway registra gli aggiornamenti di CloudFront distribuzione associati quando viene creato o aggiornato un nome di dominio personalizzato per un. API Questi registri sono disponibili in. us-east-1 Poiché queste CloudFront distribuzioni sono di proprietà di API Gateway, ognuna di queste CloudFront distribuzioni segnalate è identificata da uno dei seguenti account API Gateway specifici della regioneIDs, anziché dall'ID dell'account del API proprietario.

Region

ID account
us-east-1 392220576650
us-east-2 718770453195
us-west-1 968246515281
us-west-2 109351309407
ca-central-1 796887884028
eu-west-1 631144002099
eu-west-2 544388816663
eu-west-3 061510835048
eu-central-1 474240146802
eu-central-2 166639821150
eu-north-1 394634713161
eu-south-1 753362059629
eu-south-2 359345898052
ap-northeast-1 969236854626
ap-northeast-2 020402002396
ap-northeast-3 360671645888
ap-southeast-1 195145609632
ap-southeast-2 798376113853
ap-southeast-3 652364314486
ap-southeast-4 849137399833
ap-south-1 507069717855
ap-south-2 644042651268
ap-east-1 174803364771
sa-east-1 287228555773
me-south-1 855739686837
me-central-1 614065512851

Configura la mappatura del percorso di base di un utente API con un nome di dominio personalizzato come nome host

È possibile utilizzare la mappatura del percorso di base per utilizzare un singolo nome di dominio personalizzato come nome host di più nomi. APIs Ciò lo rende API accessibile tramite la combinazione del nome di dominio personalizzato e del percorso di base associato.

Ad esempio, se in API Gateway hai creato un API nome PetStore e un altro API nome Dogs e poi hai impostato un nome di dominio personalizzato diapi.example.com, puoi PetStore API impostarli URL comehttps://api.example.com.

Questo lo associa al PetStore API percorso di base di una stringa vuota. Se imposti i PetStore API s URL comehttps://api.example.com/PetStore, questo li associa al PetStore API percorso base di. PetStore È possibile assegnare un percorso base aMyDogList. Dogs API L'URLof https://api.example.com/MyDogList è quindi la radice URL di DogsAPI.

Per configurare le API mappature su più livelli, puoi utilizzare solo un nome di dominio personalizzato regionale. I nomi di dominio personalizzati ottimizzati per Edge non sono supportati. Per ulteriori informazioni, consulta Mappa API le fasi su un nome di dominio personalizzato per REST APIs.

La procedura seguente configura le API mappature per mappare i percorsi dal nome di dominio personalizzato agli stage. API

AWS Management Console

  1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com /apigateway.

  2. Scegli Nomi di dominio personalizzati dal pannello di navigazione principale della console API Gateway.

  3. Scegliere un nome di dominio personalizzato.

  4. Scegli Configura API mappature.

  5. Scegliere Add new mapping (Aggiungi nuova mappatura).

  6. Specificate APIlo stage e il percorso (opzionale) per la mappatura.

  7. Seleziona Salva.

REST API

Richiamare basepathmapping:create su un nome di dominio personalizzato specifico, indicando le proprietà basePath, restApiId e stage della distribuzione nel payload della richiesta.

La API chiamata riuscita restituisce una 201 Created risposta.

Per esempi di codice della REST API chiamata, vedete basepathmapping:create.

Rotazione di un certificato importato in ACM

ACMgestisce automaticamente il rinnovo dei certificati che emette. Non è necessario ruotare i certificati ACM emessi per i nomi di dominio personalizzati. CloudFront lo gestisce per tuo conto.

Tuttavia, se importi un certificato ACM e lo utilizzi per un nome di dominio personalizzato, devi ruotare il certificato prima che scada. A tale scopo, è necessario importare un nuovo certificato di terze parti per il nome di dominio e ruotare il certificato esistente in quello nuovo. Il processo deve essere ripetuto quando il nuovo certificato importato scade. In alternativa, puoi richiedere l'emissione ACM di un nuovo certificato per il nome di dominio e ruotare quello esistente con il nuovo ACM certificato emesso. Dopodiché, puoi andartene ACM e CloudFront gestire automaticamente la rotazione dei certificati. Per creare o importare un nuovo ACM certificato, procedi nel seguente modoPer creare o importare un certificato/in SSL TLS ACM.

La procedura seguente descrive come ruotare un certificato per un nome di dominio.

Nota

Sono necessari circa 40 minuti per ruotare un certificato importato in. ACM

AWS Management Console

  1. Richiedi o importa un certificato inACM.

  2. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  3. Scegli Nomi di dominio personalizzati dal pannello di navigazione principale della console API Gateway.

  4. Scegliere un nome di dominio personalizzato.

  5. Seleziona Edit (Modifica).

  6. Scegli il certificato desiderato dall'elenco a discesa dei ACMcertificati.

  7. Scegliere Save (Salva) per iniziare la rotazione del certificato per il nome di dominio personalizzato.

  8. Al termine della rotazione, puoi scegliere l'icona a forma di freccia bidirezionale accanto a ACMCertificato per tornare al certificato originale.

REST API

Chiama domainname:update action, specificando il nuovo ACM certificato per il nome ARN di dominio specificato.

Chiama il tuo con nomi di dominio personalizzati API

Chiamare un utente API con un nome di dominio personalizzato equivale a chiamarlo API con il suo nome di dominio predefinito, a condizione che URL venga utilizzato quello corretto.

Gli esempi seguenti confrontano e contrappongono un insieme di valori predefiniti URLs e personalizzati corrispondenti URLs di due APIs (udxjefeqf3duz) in una regione specificata (us-east-1) e di un determinato nome di dominio personalizzato (api.example.com).

APIID Stage Predefinito URL Percorso di base Personalizzato URL
udxjef prod https://udxjef.execute-api.us-east-1.amazonaws.com/prodotto /petstore https://api.example.com/negozio di animali
udxjef tst https://udxjef.execute-api.us-east-1.amazonaws.com/tst /petdepot https://api.example.com/petdepot
qf3duz dev https://qf3duz.execute-api.us-east-1.amazonaws.com/dev /bookstore https://api.example.com/libreria
qf3duz tst https://qf3duz.execute-api.us-east-1.amazonaws.com/tst /bookstand https://api.example.com/leggio

APIGateway supporta nomi di dominio personalizzati per e API utilizzando Server Name Indication () SNI. È possibile richiamarli API con un nome di dominio personalizzato utilizzando un browser o una libreria client che supportiSNI.

APIGateway si applica SNI alla distribuzione. CloudFront Per informazioni su come vengono CloudFront utilizzati i nomi di dominio personalizzati, consulta Amazon CloudFront Custom SSL.