Migración de un nombre de dominio personalizado a otro tipo punto de conexión de API en API Gateway - Amazon API Gateway
ConsideracionesMigración de nombres de dominio personalizados

Migración de un nombre de dominio personalizado a otro tipo punto de conexión de API en API Gateway

Puede migrar el nombre de dominio personalizado entre puntos de conexión optimizados para bordes y regionales. No es posible migrar un nombre de dominio personalizado público a un nombre de dominio personalizado privado. En primer lugar, debe añadir el nuevo tipo de configuración de punto de conexión a la lista endpointConfiguration.types existente para el nombre de dominio personalizado. A continuación, debe configurar un registro DNS para que el nombre de dominio personalizado señale al punto de conexión recién aprovisionado. Por último, debe quitar el punto de conexión de los nombres de dominio personalizados obsoletos.

Consideraciones

A continuación, se ofrecen algunas consideraciones para migrar el dominio personalizado entre un punto de conexión de API regional y un punto de conexión de API optimizado para la periferia:

  • Un nombre de dominio personalizado optimizado para la periferia requiere un certificado proporcionado por ACM de la región Este de EE. UU. (Norte de Virginia) - us-east-1. Este certificado se distribuye a todas las ubicaciones geográficas.

  • Un nombre de dominio personalizado regional requiere un certificado proporcionado por ACM en la misma región que aloja la API. Puede migrar un nombre de dominio personalizado optimizado para la periferia que no se encuentra en la región us-east-1 a un nombre de dominio personalizado regional mediante la solicitud de un nuevo certificado de ACM desde la región local para la API.

  • Puede tardar hasta 60 segundos en completarse una migración entre un nombre de dominio personalizado optimizado para la periferia y un nombre de dominio personalizado regional. El tiempo de migración también depende de cuándo se actualicen los registros de DNS.

  • Solo puede agregar una configuración de punto de conexión adicional si el modo de acceso de punto de conexión está configurado en BASIC. Una vez que tenga dos configuraciones de punto de conexión, no podrá cambiar el modo de acceso de punto de conexión. Para obtener más información, consulte Modo de acceso de punto de conexión.

  • Si el nombre de dominio personalizado usa una política de seguridad que comienza con SecurityPolicy_, cuando agrega un nuevo tipo de configuración de punto de conexión, el modo de acceso al punto de conexión es el mismo en ambos tipos de punto de conexión y debe elegir una política de seguridad que comience con SecurityPolicy_ para el nuevo tipo de configuración de punto de conexión.

Migración de nombres de dominio personalizados

nota

Para completar la migración, asegúrese de eliminar el punto de conexión obsoleto del nombre de dominio personalizado.

En el siguiente procedimiento se muestra cómo migrar un nombre de dominio personalizado optimizado para la periferia a un nombre de dominio personalizado regional.

Consola de administración de AWS

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija Custom domain names (Nombres de dominios personalizados) en el panel de navegación principal.

  3. Elija un nombre de dominio personalizado optimizado para la periferia.

  4. En Configuración de punto de conexión, elija Editar.

  5. Elija Agregar punto de conexión regional.

  6. En Certificado de ACM, elija un certificado.

    El certificado regional debe estar en la misma región que la API regional.

  7. Seleccione Save changes (Guardar cambios).

  8. Configure un registro de DNS para que el nombre de dominio personalizado regional apunte a este nombre de host regional. Para obtener más información, consulte Configuración de Route 53 para enrutar el tráfico a API Gateway.

  9. Después de confirmar que la configuración de DNS utiliza el punto de conexión correcto, elimine la configuración de punto de conexión optimizado para la periferia. Elija el nombre del dominio personalizado y, después, elija Eliminar para Configuración de punto de conexión (optimizado para bordes).

  10. Confirme su elección y elimine el punto de conexión.

AWS CLI

El siguiente comando update-domain-name permite migrar el nombre de dominio personalizado optimizado para bordes a un nombre de dominio personalizado regional:

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

El certificado regional debe corresponder a la misma región que la API regional.

El resultado será similar al siguiente:

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

En el caso del nombre de dominio personalizado regional actualizado, la propiedad resultante regionalDomainName devuelve el nombre de host de la API regional. Debe configurar un registro DNS para que el nombre de dominio personalizado regional señale a este nombre de host regional. Esto permite que el tráfico que se dirige al nombre de dominio personalizado sea redirigido al host regional.

Una vez configurado el registro de DNS, puede quitar el nombre de dominio personalizado optimizado para la periferia. El siguiente comando update-domain-name permite eliminar el nombre de dominio personalizado optimizado para bordes.

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

En el siguiente procedimiento se muestra cómo migrar un nombre de dominio personalizado optimizado para bordes que utilice una política de seguridad mejorada a un nombre de dominio personalizado regional que también utilice una política de seguridad mejorada.

Consola de administración de AWS

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija Custom domain names (Nombres de dominios personalizados) en el panel de navegación principal.

  3. Elija un nombre de dominio personalizado optimizado para la periferia.

  4. En Configuración de punto de conexión, elija Editar.

  5. Elija Agregar punto de conexión regional.

  6. En Certificado de ACM, elija un certificado.

    El certificado regional debe estar en la misma región que la API regional.

  7. Para Política de seguridad, elija una política de seguridad que comience con SecurityPolicy_.

  8. Para Modo de acceso de punto de conexión, elija Básico.

  9. Seleccione Save changes (Guardar cambios).

  10. Configure un registro de DNS para que el nombre de dominio personalizado regional apunte a este nombre de host regional. Para obtener más información, consulte Configuración de Route 53 para enrutar el tráfico a API Gateway.

  11. Después de confirmar que la configuración de DNS utiliza el punto de conexión correcto, elimine la configuración de punto de conexión optimizado para la periferia. Elija el nombre del dominio personalizado y, después, elija Eliminar para Configuración de punto de conexión (optimizado para bordes).

  12. Confirme su elección y elimine el punto de conexión.

AWS CLI

El siguiente comando update-domain-name permite migrar el nombre de dominio personalizado optimizado para bordes a un nombre de dominio personalizado regional:

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

El certificado regional debe corresponder a la misma región que la API regional.

El resultado será similar al siguiente:

{
    "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"
        ]
    },
    "securityPolicy": "SecurityPolicy_TLS13_1_3_2025_09",
    "endpointAccessMode": "BASIC",
    "regionalCertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/cd833b28-58d2-407e-83e9-dce3fd852149",
    "regionalDomainName": "d-fdisjghyn6.execute-api.us-west-2.amazonaws.com"
}

En el caso del nombre de dominio personalizado regional actualizado, la propiedad resultante regionalDomainName devuelve el nombre de host de la API regional. Debe configurar un registro DNS para que el nombre de dominio personalizado regional señale a este nombre de host regional. Esto permite que el tráfico que se dirige al nombre de dominio personalizado sea redirigido al host regional.

Una vez configurado el registro de DNS, puede quitar el nombre de dominio personalizado optimizado para la periferia. El siguiente comando update-domain-name permite eliminar el nombre de dominio personalizado optimizado para bordes.

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

En el siguiente procedimiento se muestra cómo migrar un nombre de dominio personalizado regional a un nombre de dominio personalizado optimizado para la periferia.

Consola de administración de AWS

  1. Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación principal, elija Nombres de dominio personalizados.

  3. Elija un nombre de dominio personalizado regional.

  4. En Configuración de punto de conexión, elija Editar.

  5. Elija Agregar punto de conexión optimizado para la periferia.

  6. En Certificado de ACM, elija un certificado.

    El certificado del dominio optimizado para sistemas perimetrales debe crearse en la región us-east-1.

  7. Seleccione Save.

  8. Configure un registro de DNS para que el nombre de dominio personalizado optimizado para la periferia apunte a este nombre de host optimizado para la periferia. Para obtener más información, consulte Configuración de Route 53 para enrutar el tráfico a API Gateway.

  9. Después de confirmar que la configuración de DNS utiliza el punto de conexión correcto, elimine la configuración de punto de conexión regional. Elija el nombre del dominio personalizado y, después, elija Eliminar para Configuración de punto de conexión (regional).

  10. Confirme su elección y elimine el punto de conexión.

AWS CLI

El siguiente comando update-domain-name permite migrar el nombre de dominio personalizado regional a un nombre de dominio personalizado optimizado para bordes:

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

El certificado del dominio optimizado para sistemas perimetrales debe crearse en la región us-east-1.

El resultado será similar al siguiente:

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

Para el nombre de dominio personalizado especificado, API Gateway devuelve el nombre de host de la API optimizada para bordes como el valor de la propiedad distributionDomainName. Debe configurar un registro DNS para que el nombre de dominio personalizado optimizado para sistemas perimetrales señale a este nombre de dominio de distribución. Esto permite que el tráfico que se dirige al nombre de dominio personalizado optimizado para sistemas perimetrales sea redirigido al nombre de host de la API optimizada para límites.

Una vez configurado el registro de DNS, puede quitar el tipo de punto de conexión REGION del nombre de dominio personalizado. El siguiente comando update-domain-name permite eliminar el tipo de punto de conexión regional:

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

El resultado es similar al siguiente:

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