Configuration d’un nom de domaine personnalisé régional dans API Gateway

La create-domain-namecommande suivante crée 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

Le résultat se présente comme 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 propriété DomainNameConfigurations renvoie le nom d’hôte de l’API régionale. Vous devez créer un enregistrement DNS pour 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 de cette API régionale.

La create-api-mappingcommande suivante crée 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'

En conséquence, l’URL de base utilisant le nom de domaine personnalisé pour l’API déployée pendant l’étape devient https://regional.example.com/myAPI.

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

Pour configurer vos enregistrements DNS de manière à mapper le nom de domaine personnalisé régional au nom d’hôte de l’ID de la zone hébergée, commencez par créer un fichier JSON qui contient la configuration pour créer un enregistrement DNS pour le nom de domaine régional.

L’exemple setup-dns-record.json suivant montre comment créer un enregistrement DNS A afin de 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) configuré 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
        }
      }
    }
  ]
}

Ce qui suit change-resource-record-setscrée un enregistrement DNS 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 hosted-zone-id par l’ID de la zone hébergée Route 53 du jeu d’enregistrements DNS de votre compte. La valeur du paramètre change-batch pointe vers un fichier JSON (setup-dns-record.json) dans un dossier (path/to/your).