Migration d'un nom de domaine personnalisé à un point de terminaison d'API différent

Vous pouvez migrer votre nom de domaine personnalisé entre des points de terminaison optimisés pour les périphériques et régionaux. Vous ajoutez d'abord le nouveau type de configuration de point de terminaison à la liste endpointConfiguration.types existante pour le nom de domaine personnalisé. Ensuite, vous configurez un enregistrement DNS pour pointer le nom de domaine personnalisé vers le point de terminaison récemment configuré. Une dernière étape facultative consiste à supprimer les données de configuration du nom de domaine personnalisé obsolète.

Lorsque vous planifiez la migration, n'oubliez pas que pour un nom de domaine personnalisé de l'API optimisée pour la périphérie, le certificat requis fourni par ACM doit provenir de la région USA Est (Virginie du Nord) (us-east-1). Ce certificat est distribué à tous les emplacements géographiques. Toutefois, pour une API régionale, le certificat ACM pour le nom de domaine régional doit provenir de la même région hébergeant l'API. Vous pouvez migrer un nom de domaine personnalisé optimisé pour la périphérie qui ne se trouve pas dans la région us-east-1 vers un nom de domaine personnalisé régional en demandant d'abord un nouveau certificat ACM de la région locale vers l'API.

Il peut falloir jusqu'à 60 secondes pour effectuer une migration entre un nom de domaine personnalisé optimisé pour la périphérie et un nom de domaine personnalisé régional dans API Gateway. Pour que le point de terminaison que vous venez de créer accepte le trafic, le délai de migration dépend également du moment où vous mettez à jour vos enregistrements DNS.

Migration des noms de domaines personnalisés à l'aide de l AWS CLI

Pour utiliser AWS CLI afin d'effectuer la migration d'un nom de domaine personnalisé d'un point de terminaison optimisé pour la périphérie vers un point de terminaison régional ou vice versa, appelez la commande update-domain-name pour ajouter le nouveau type de point de terminaison et, éventuellement, appelez la commande update-domain-name pour supprimer l'ancien type de point de terminaison.

Rubriques

• Migration d'un nom de domaine personnalisé optimisé pour les périphériques en régional
• Migration d'un nom de domaine personnalisé régional en optimisé pour les périphériques

Migration d'un nom de domaine personnalisé optimisé pour les périphériques en régional

Pour migrer un nom de domaine personnalisé optimisé pour les périphériques vers un nom de domaine personnalisé régional, appelez la commande CLI update-domain-name, comme suit :

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.

La réponse positive renvoie un code de statut 200 OK et un corps similaire à ce qui 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 les périphériques en appelant la commande update-domain-name de l'AWS CLI :

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'} \
        ]

Migration d'un nom de domaine personnalisé régional en optimisé pour les périphériques

Pour migrer un nom de domaine régional en nom de domaine personnalisé optimisé pour les périphériques, appelez la commande update-domain-name de l'AWS CLI, comme suit :

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:123456789012:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a' } \
        ]

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

La réponse positive renvoie un code de statut 200 OK et un corps similaire à ce qui 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 les périphériques vers ce nom de domaine de distribution. Cela permet au trafic lié au nom de domaine personnalisé optimisé pour les périphériques d'être acheminé vers le nom d'hôte d'API optimisé pour les périphériques.

Une fois l'enregistrement DNS défini, vous pouvez supprimer le type de point de terminaison REGION du nom de domaine personnalisé :

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 de cette commande est similaire à la sortie suivante, seulement avec les données de configuration de nom de domaine optimisé pour la périphérie :

{
    "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": "regional.haymuto.com",
    "endpointConfiguration": {
        "types": "EDGE"
    }
}