Migration d’un nom de domaine personnalisé vers un autre type de point de terminaison d’API dans API Gateway

La update-domain-namecommande suivante fait migrer un nom de domaine personnalisé optimisé pour les périphériques vers un nom de domaine personnalisé régional :

aws apigateway update-domain-name \
    --domain-name 'api.example.com' \
    --patch-operations  '[ 
        { "op":"add", "path": "/endpointConfiguration/types","value": "REGIONAL" },
        { "op":"add", "path": "/regionalCertificateArn", "value": "arn:aws:acm:us-west-2:123456789012:certificate/cd833b28-58d2-407e-83e9-dce3fd852149" }
      ]'

Le certificat régional doit se situer dans la même région que l’API régionale.

Le résultat se présente comme suit :

{
    "certificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "api.example.com",
    "endpointConfiguration": {
        "types": [
            "EDGE",
            "REGIONAL"
        ]
    },
    "regionalCertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/cd833b28-58d2-407e-83e9-dce3fd852149",
    "regionalDomainName": "d-fdisjghyn6.execute-api.us-west-2.amazonaws.com"
}

Pour le nom de domaine personnalisé régional migré, la propriété regionalDomainName résultante renvoie le nom d’hôte de l’API régionale. Vous devez configurer un enregistrement DNS pour pointer le nom de domaine personnalisé régional vers ce nom d’hôte régional. Cela permet au trafic lié au nom de domaine personnalisé d’être acheminé vers le nom d’hôte régional.

Une fois l’enregistrement DNS défini, vous pouvez supprimer le nom de domaine personnalisé optimisé pour la périphérie. La update-domain-namecommande suivante supprime le nom de domaine personnalisé optimisé pour les périphériques :

aws apigateway update-domain-name \
    --domain-name api.example.com \
    --patch-operations '[
            {"op":"remove", "path":"/endpointConfiguration/types", "value":"EDGE"},
            {"op":"remove", "path":"certificateName"},
            {"op":"remove", "path":"certificateArn"}
        ]'

La update-domain-namecommande suivante fait migrer votre nom de domaine personnalisé régional vers un nom de domaine personnalisé optimisé pour les périphériques :

aws apigateway update-domain-name \
    --domain-name 'api.example.com' \
    --patch-operations  '[ 
        { "op":"add", "path": "/endpointConfiguration/types","value": "EDGE" },
        { "op":"add", "path": "/certificateName", "value": "edge-cert" },
	{"op":"add", "path": "/certificateArn", "value": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a"}
      ]'

Le certificat du domaine optimisé pour la périphérie doit être créé dans la région us-east-1.

Le résultat se présente comme suit :

{
    "certificateArn": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "api.example.com",
    "endpointConfiguration": {
        "types": [
            "EDGE",
            "REGIONAL"
        ]
    },
    "regionalCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/3d881b54-851a-478a-a887-f6502760461d",
    "regionalDomainName": "d-cgkq2qwgzf.execute-api.us-east-1.amazonaws.com"
}

Pour le nom de domaine personnalisé spécifié, API Gateway renvoie le nom d’hôte de l’API optimisée pour la périphérie en tant que valeur de propriété distributionDomainName. Vous devez définir un enregistrement DNS pour pointer le nom de domaine personnalisé optimisé pour la périphérie vers ce nom de domaine de distribution. Cela permet au trafic lié au nom de domaine personnalisé optimisé pour la périphérie d’être acheminé vers le nom d’hôte d’API optimisé pour la périphérie.

Une fois l’enregistrement DNS défini, vous pouvez supprimer le type de point de terminaison REGION du nom de domaine personnalisé. La update-domain-namecommande suivante supprime le type de point de terminaison régional :

aws apigateway update-domain-name \
    --domain-name api.example.com \
    --patch-operations '[
        {"op":"remove", "path":"/endpointConfiguration/types", value:"REGIONAL"},
        {"op":"remove", "path":"regionalCertificateArn"}
      ]'

Le résultat se présente comme suit :

{
    "certificateArn": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "api.example.com",
    "endpointConfiguration": {
        "types": "EDGE"
    }
}