Migrer un nom de domaine personnalisé vers un autre type de API point de terminaison dans API Gateway

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 DNS enregistrement pour pointer le nom de domaine personnalisé vers le point de terminaison nouvellement configuré. Enfin, vous supprimez les données de configuration des noms de domaine personnalisés obsolètes.

Considérations

Voici quelques considérations relatives à la migration de votre domaine personnalisé entre un point de API terminaison régional et un point de terminaison optimisé pour les périphériques. API

• Un nom de domaine personnalisé optimisé pour les périphériques nécessite un certificat fourni par la région ACM de l'est des États-Unis (Virginie du Nord). us-east-1 Ce certificat est distribué à tous les emplacements géographiques.

• Un nom de domaine personnalisé régional nécessite un certificat fourni par ACM la même région hébergeant leAPI. Vous pouvez migrer un nom de domaine personnalisé optimisé pour les périphériques qui ne se trouve pas dans la us-east-1 région vers un nom de domaine personnalisé régional en demandant un nouveau ACM certificat à la région locale du. API

• La réalisation d'une migration entre un nom de domaine personnalisé optimisé pour les périphériques et un nom de domaine personnalisé régional peut prendre jusqu'à 60 secondes. Le délai de migration dépend également de la date à laquelle vous mettez à jour vos DNS dossiers.

Migrer des noms de domaine personnalisés

La procédure suivante montre comment migrer un nom de domaine personnalisé optimisé pour les périphériques vers un nom de domaine personnalisé régional.

AWS Management Console

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Dans le volet de navigation principal, sélectionnez Noms de domaine personnalisés.

3. Choisissez un nom de domaine personnalisé optimisé pour les périphériques.

4. Dans l'onglet Configurations, pour la configuration du point de terminaison, choisissez Modifier.

5. Choisissez Ajouter un point de terminaison régional.

6. Pour ACMcertificat, choisissez-en un.

   Le certificat régional doit être de la même région que le certificat régionalAPI.

7. Choisissez Enregistrer.

8. Configurez un DNS enregistrement pour faire pointer le nom de domaine personnalisé régional vers ce nom d'hôte régional. Pour plus d'informations, consultez la section Configuration de Route 53 pour acheminer le trafic vers API Gateway.

9. Après avoir confirmé que votre DNS configuration utilise le bon point de terminaison, vous supprimez la configuration du point de terminaison optimisé pour les périphériques. Choisissez votre nom de domaine personnalisé, puis pour la configuration du point de terminaison (optimisée pour les périphériques), choisissez Supprimer.

10. Confirmez votre choix et supprimez le point de terminaison.

AWS CLI

La update-domain-namecommande suivante indique comment migrer votre nom de domaine personnalisé 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 être de la même région que le certificat régionalAPI.

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 regionalDomainName propriété résultante renvoie le nom d'APIhôte régional. Vous devez configurer un DNS enregistrement pour faire 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'DNSenregistrement défini, vous pouvez supprimer le nom de domaine personnalisé optimisé pour les périphériques. La update-domain-namecommande suivante indique comment supprimer 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 procédure suivante montre comment migrer un nom de domaine personnalisé régional vers un nom de domaine personnalisé optimisé pour les périphériques.

AWS Management Console

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Dans le volet de navigation principal, sélectionnez Noms de domaine personnalisés.

3. Choisissez un nom de domaine personnalisé optimisé pour les périphériques.

4. Dans l'onglet Configurations, pour la configuration du point de terminaison, choisissez Modifier.

5. Choisissez Ajouter un point de terminaison optimisé pour les périphériques.

6. Pour ACMcertificat, choisissez-en un.

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

7. Choisissez Enregistrer.

8. Configurez un DNS enregistrement pour faire pointer le nom de domaine personnalisé optimisé pour les bords vers ce nom d'hôte optimisé pour les périphériques. Pour plus d'informations, consultez la section Configuration de Route 53 pour acheminer le trafic vers API Gateway.

9. Après avoir confirmé que votre DNS configuration utilise le point de terminaison approprié, vous supprimez la configuration du point de terminaison régional. Choisissez votre nom de domaine personnalisé, puis pour la configuration du point de terminaison (régional), choisissez Supprimer.

10. Confirmez votre choix et supprimez le point de terminaison.

AWS CLI

La update-domain-namecommande suivante indique comment migrer votre nom de domaine personnalisé 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 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'APIhôte optimisé pour les périphériques comme valeur de distributionDomainName propriété. Vous devez définir un DNS enregistrement pour faire pointer le nom de domaine personnalisé optimisé pour les bords 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 optimisé pour les périphériques. API

Une fois l'DNSenregistrement défini, vous pouvez supprimer le type de point de REGION terminaison du nom de domaine personnalisé. La update-domain-namecommande suivante indique comment supprimer 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 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"
    }
}