Configurer un nom de domaine personnalisé régional dans API Gateway

La create-domain-namecommande suivante peut être utilisée pour créer un nom de domaine personnalisé :

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

S'il aboutit, cet appel renvoie un résultat similaire à ce qui suit :

{
    "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"
        }
    ]
}

La valeur de la DomainNameConfigurations propriété renvoie le nom API d'hôte du Regional. Vous devez créer un DNS enregistrement pour faire pointer votre nom de domaine personnalisé vers ce nom de domaine régional. Cela permet au trafic lié au nom de domaine personnalisé d'être acheminé vers le nom d'hôte API de cette région.

Pour utiliser le AWS Management Console, suivez la documentation Route 53 sur la configuration de Route 53 pour acheminer le trafic vers API Gateway.

Pour configurer vos DNS enregistrements afin de mapper le nom de domaine personnalisé régional à son nom d'hôte correspondant à l'ID de zone hébergée donné, créez d'abord un JSON fichier contenant la configuration permettant de configurer un DNS enregistrement pour le nom de domaine régional.

Ce qui suit setup-dns-record.json montre comment créer un DNS A enregistrement pour mapper un nom de domaine personnalisé régional (regional.example.com) à son nom d'hôte régional (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) fourni dans le cadre de la création du nom de domaine personnalisé. Les propriétés DNSName et HostedZoneId d'AliasTarget peuvent prendre respectivement les valeurs regionalDomainName et regionalHostedZoneId du nom de domaine personnalisé. Vous pouvez également obtenir la zone hébergée régionale Route 53 IDs dans 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
        }
      }
    }
  ]
}

Voici comment change-resource-record-setscréer un DNS enregistrement pour votre nom de domaine personnalisé régional :

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

Remplacez le hosted-zone-id par l'ID de zone hébergée Route 53 de l'DNSenregistrement enregistré dans votre compte. La valeur du change-batch paramètre pointe vers un JSON fichier (setup-dns-record.json) dans un dossier (path/to/your).

La create-api-mappingcommande suivante peut être utilisée pour créer un mappage de chemin de base :

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

Par conséquent, la base URL utilisant le nom de domaine personnalisé pour le API qui est déployé dans la phase devienthttps://regional.example.com/myAPI.