Configura un nome di dominio personalizzato regionale in API Gateway - Amazon API Gateway

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 regionale in API Gateway

Usa un nome di dominio personalizzato regionale per creare una API base URL intuitiva. Con un nome di dominio personalizzato regionale, puoi mappare HTTP e utilizzare REST API lo stesso nome di dominio personalizzato e utilizzare l'TLSautenticazione reciproca.

Considerazioni

Di seguito sono riportate alcune considerazioni relative al nome di dominio personalizzato regionale.

  • È necessario fornire un certificato specifico per la regione. ACM Questo certificato deve essere nella stessa regione della tua. API Per ulteriori informazioni sulla creazione o il caricamento di un certificato di un nome di dominio personalizzato consulta Prepara i certificati in AWS Certificate Manager.

  • Quando crei un nome di dominio personalizzato regionale (o ne migri uno) con un ACM certificato, API Gateway crea un ruolo collegato al servizio nel tuo account. Il ruolo collegato al servizio è necessario per allegare il ACM certificato all'endpoint regionale. Il ruolo è denominato AWSServiceRoleForAPIGatewaye avrà la politica APIGatewayServiceRolePolicygestita allegata. Per ulteriori informazioni sull'uso del ruolo collegato ai servizi, consulta Utilizzo dei ruoli collegati ai servizi.

  • Dopo aver creato il nome di dominio personalizzato regionale, è necessario creare un DNS record per indirizzare il nome di dominio personalizzato al nome di dominio regionale. Ciò consente al traffico associato al nome di dominio personalizzato di essere indirizzato al nome API host regionale. Il DNS record può essere di tipo CNAME o «A».

Crea un nome di dominio personalizzato regionale

La procedura seguente mostra come creare un nome di dominio personalizzato regionale. Dopo aver completato questa procedura, è necessario creare un DNS record per indirizzare il nome di dominio personalizzato al nome di dominio regionale.

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

  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 Regionale.

  7. Scegliere un certificato ACM. Il certificato deve trovarsi nella stessa regione del. API

  8. Scegli Create (Crea) .

AWS CLI

Il create-domain-namecomando seguente può essere utilizzato per creare un nome di dominio personalizzato:

aws apigatewayv2 create-domain-name \ --domain-name 'regional.example.com' \ --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

Se l'operazione va a buon fine, la risposta alla chiamata presenta un risultato simile al seguente:

{ "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "DomainNameStatus": "AVAILABLE", "EndpointType": "REGIONAL", "HostedZoneId": "Z2OJLYMUO9EFXC", "SecurityPolicy": "TLS_1_2" } ] }

Il valore della DomainNameConfigurations proprietà restituisce il nome host API del Regional. È necessario creare un DNS record per indirizzare il nome di dominio personalizzato a questo nome di dominio regionale. Ciò consente al traffico associato al nome di dominio personalizzato di essere indirizzato al nome host API di questa regione.

Crea un DNS record per il tuo nome di dominio personalizzato regionale

La procedura seguente mostra come creare un DNS record che indichi il nome di dominio personalizzato al nome di dominio regionale appena creato.

AWS Management Console

Per utilizzare il AWS Management Console, segui la documentazione di Route 53 sulla configurazione di Route 53 per instradare il traffico verso API Gateway.

AWS CLI

Per configurare i DNS record in modo da mappare il nome di dominio personalizzato regionale al nome host dell'ID della zona ospitata specificato, crea innanzitutto un JSON file che contenga la configurazione per l'impostazione di un DNS record per il nome di dominio regionale.

Di seguito setup-dns-record.json viene illustrato come creare un DNS A record per mappare un nome di dominio personalizzato regionale (regional.example.com) al relativo hostname regionale (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) fornito come parte della creazione del nome di dominio personalizzato. Le proprietà DNSName e HostedZoneId di AliasTarget possono prendere rispettivamente i valori regionalDomainName e regionalHostedZoneId del nome di dominio personalizzato. Puoi anche ottenere la Regional Route 53 Hosted Zone IDs in Amazon API Gateway Endpoints and Quotas.

{ "Changes": [ { "Action": "CREATE", "ResourceRecordSet": { "Name": "regional.example.com", "Type": "A", "AliasTarget": { "DNSName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com", "HostedZoneId": "Z2OJLYMUO9EFXC", "EvaluateTargetHealth": false } } } ] }

Di seguito change-resource-record-setsviene illustrato come creare un DNS record per il nome di dominio personalizzato regionale:

aws route53 change-resource-record-sets \ --hosted-zone-id Z2OJLYMUO9EFXC \ --change-batch file://path/to/your/setup-dns-record.json

hosted-zone-idSostituiscilo con l'ID della zona ospitata Route 53 del DNS record impostato nel tuo account. Il valore del change-batch parametro punta a un JSON file (setup-dns-record.json) in una cartella (path/to/your).

Crea una mappatura del percorso di base per il tuo nome di dominio personalizzato regionale

Dopo aver creato un DNS record, crei una mappatura del percorso di base per mappare il tuo API al nome di dominio personalizzato. Ad esempio, puoi mappare lo stage test per l'APIID di abc123 al nome di dominio personalizzato regional.example.com utilizzando la chiave di API mappatura di. myApi Questo mappa il APIhttps://abcd1234.execute-api.us-west-2.amazonaws.com/test. https://regional.example.com/myApi

AWS Management Console
  1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegliere un nome di dominio personalizzato.

  3. Scegli Configura mappature. API

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

  5. Specificate APIlo stadio e il percorso per la mappatura.

  6. Seleziona Salva.

AWS CLI

Il create-api-mappingcomando seguente può essere usato per creare una mappatura del percorso di base:

aws apigatewayv2 create-api-mapping \ --domain-name 'regional.example.com' \ --api-mapping-key 'myApi' \ --api-id abcd1234 \ --stage 'test'

Di conseguenza, la base che URL utilizza il nome di dominio personalizzato per il API che viene distribuito nella fase diventa. https://regional.example.com/myAPI

Con un nome di dominio personalizzato regionale, puoi creare una API mappatura con più livelli, ad esempio. https://regional.example.com/orders/v1/items/123 Puoi anche mappare HTTP e REST API utilizzare lo stesso nome di dominio personalizzato. Per ulteriori informazioni, consulta Mappa API le fasi su un nome di dominio personalizzato per REST APIs.