Configurazione di un nome di dominio personalizzato regionale in Gateway API - Amazon API Gateway
ConsiderazioniCreazione di un nome di dominio personalizzato regionale Creazione di una regola di routing per il nome di dominio personalizzato regionaleCreazione di un record DNS per il nome di dominio personalizzato regionale

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

Configurazione di un nome di dominio personalizzato regionale in Gateway API

Usa un nome di dominio personalizzato regionale per creare un URL di base dell'API intuitivo. Con un nome di dominio personalizzato regionale, puoi mappare le fasi HTTP e REST API allo stesso nome di dominio personalizzato e utilizzare l'autenticazione TLS reciproca.

Considerazioni

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

  • Devi fornire un certificato ACM specifico della Regione. Il certificato deve trovarsi nella stessa Regione dell'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 si crea un nome di dominio personalizzato regionale (o si esegue la migrazione di uno di essi) con un certificato ACM, Gateway API crea un ruolo collegato ai servizi nel tuo account. Il ruolo collegato ai servizi è necessario per collegare il certificato ACM all'endpoint regionale. Il ruolo è denominato AWSServiceRoleForAPIGateway e sarà collegato alla policy gestita APIGatewayServiceRolePolicy. 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 record DNS per far sì che il nome di dominio personalizzato punti al dominio regionale. Questo consente al traffico destinato al nome di dominio personalizzato di essere reindirizzato al nome host regionale dell'API.

    Il record DNS può essere un record CNAME o un record alias A. Se si utilizza Route 53 come provider DNS, occorre creare un record di alias di tipo A. Se si utilizza un provider DNS di terze parti, occorre usare un record CNAME. Se si utilizza un record CNAME e si crea un endpoint VPC dell’interfaccia Gateway API con DNS privato abilitato per un’API privata, non è possibile risolvere il nome di dominio personalizzato all’interno del VPC che ospita l’API privata.

Creazione di un nome di dominio personalizzato regionale

La procedura seguente mostra come creare un nome di dominio personalizzato regionale. Una volta completata questa procedura, si crea una regola di routing per instradare le fasi dell’API al nome di dominio personalizzato.

AWS Management Console

  1. Accedi 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 Modalità di routing, scegliere Solo regole di routing.

    In questa modalità di routing, puoi inviare traffico dal tuo nome di dominio personalizzato al tuo solo utilizzando le regole di routing. APIs Per ulteriori informazioni, consulta Invia traffico al tuo APIs tramite il tuo nome di dominio personalizzato in API Gateway.

  6. Per Versione TLS minima, seleziona una versione.

  7. Sotto Configurazione endpoint, per Tipo di endpoint API scegli Regionale.

  8. Scegliere un certificato ACM. Il certificato deve trovarsi nella stessa regione dell'API.

  9. Scegli Create (Crea).

AWS CLI

Il create-domain-namecomando seguente crea 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 \
    --routing-mode ROUTING_RULE_ONLY

L'output sarà 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"
        }
        "RoutingMode": "ROUTING_RULE_ONLY"
    ]
}

Il valore della proprietà DomainNameConfigurations restituisce il nome host dell'API regionale. Devi creare un record DNS per puntare il tuo nome di dominio personalizzato al nome del dominio regionale. Questo consente al traffico destinato al nome di dominio personalizzato di essere reindirizzato al nome host dell'API regionale.

Creazione di una regola di routing per il nome di dominio personalizzato regionale

Dopo aver creato il tuo nome di dominio personalizzato, configuri il modo in cui il traffico viene instradato dal tuo nome di dominio personalizzato al tuo APIs. Poiché hai impostato la modalità di routing suROUTING_RULE_ONLY, utilizzi le regole di routing per indirizzare le richieste in entrata dal tuo nome di dominio personalizzato al tuo. APIs

In questo esempio, si crea una regola catch-all che instrada a una fase dell’API tutte le richieste in entrata per il nome di dominio personalizzato. È anche possibile configurare le regole di routing in base a diverse condizioni di intestazione e percorso. Per ulteriori informazioni, consulta Regole di routing per connettere gli stadi dell'API a un nome di dominio personalizzato per REST APIs.

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. Nella scheda Dettagli di routing, scegliere Aggiungi una regola di routing.

  4. Scegliere Aggiungi una nuova condizione per aggiungere una nuova condizione.

  5. Mantenere questa regola senza condizioni. In tal modo si instradano all’API di destinazione e alla fase di destinazione tutte le richieste per il nome di dominio personalizzato.

  6. Per Azione, selezionare nel menu a discesa l’API e la fase di destinazione.

  7. Scegli Next (Successivo).

  8. Nel campo Priorità, immettere 100.

    Gateway API valuta le regole in ordine di priorità, dal valore più basso a quello più alto. Poiché si tratta di una regola catch-all, si utilizza una priorità elevata in modo che Gateway API possa soddisfare qualsiasi regola aggiuntiva creata.

  9. Scegliere Crea una regola di routing.

AWS CLI

Il comando create-routing-rule seguente crea una regola di routing catch-all:

aws apigatewayv2 create-routing-rule \
  --domain-name 'regional.example.com' \
  --priority 100 \
  --conditions  \
  --actions '[{
    "InvokeApi": {
      "ApiId": "a1b2c3",
      "Stage": "prod"
    }
  }]'

È possibile modificare la modalità di routing e creare nuove regole in qualsiasi momento. Per ulteriori informazioni, consulta Invia traffico al tuo APIs tramite il tuo nome di dominio personalizzato in API Gateway.

Creazione di un record DNS per il nome di dominio personalizzato regionale

Dopo aver creato il nome di dominio personalizzato e le mappature dei percorsi di base, puoi creare un record DNS in modo che il nome di dominio personalizzato punti 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 record DNS in modo da mappare il nome di dominio personalizzato regionale al relativo nome host dell'ID della zona ospitata, crea innanzitutto un file JSON contenente la configurazione per configurare un record DNS per il nome di dominio regionale.

Il seguente setup-dns-record.json mostra come creare un record DNS A per mappare un nome di dominio personalizzato regionale (regional.example.com) al relativo nome host regionale (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) fornito durante la 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
        }
      }
    }
  ]
}

Quanto segue change-resource-record-setscrea un record DNS per il tuo 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

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