Configuración de un nombre de dominio personalizado regional en API Gateway

El siguiente comando create-domain-name se puede utilizar para crear un nombre de dominio personalizado:

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

Si es correcta, la llamada devuelve un resultado similar al siguiente:

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

El valor de propiedad DomainNameConfigurations devuelve el nombre de host de la API regional. Debe crear un registro DNS para apuntar su nombre de dominio personalizado a este nombre de dominio regional. Esto permite que el tráfico que se dirige al nombre de dominio personalizado se enrute al nombre de host de esta API regional.

Para usar la AWS Management Console, siga la documentación de Route 53 sobre la configuración de Route 53 para enrutar el tráfico a API Gateway.

Para configurar sus registros de DNS para asignar el nombre de dominio regional personalizado al nombre de host del ID de zona alojada designado, cree primero un archivo JSON que contenga la configuración a fin de establecer un registro de DNS para el nombre de dominio regional.

En el siguiente setup-dns-record.json se muestra cómo crear un registro A de DNS para asignar un nombre de dominio personalizado regional (regional.example.com) a su nombre de host regional (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) aprovisionado como parte de la creación de nombres de dominio personalizados. Las propiedades DNSName y HostedZoneId de AliasTarget pueden tener los valores regionalDomainName y regionalHostedZoneId, respectivamente, del nombre de dominio personalizado. También puede obtener los ID de zona alojada regionales de Route 53 en Puntos de enlace y cuotas de Amazon API Gateway.

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

El siguiente comando change-resource-record-sets muestra cómo crear un registro de DNS para su nombre de dominio personalizado regional:

aws route53 change-resource-record-sets \
    --hosted-zone-id Z2OJLYMUO9EFXC \
    --change-batch file://path/to/your/setup-dns-record.json

Reemplace hosted-zone-id por el ID de zona alojada de Route 53 del conjunto de registros de DNS de la cuenta. El valor del parámetro change-batch apunta a un archivo JSON (setup-dns-record.json) de una carpeta (ruta/a/su).

El siguiente comando create-api-mapping se puede usar para crear una asignación de ruta base:

aws apigatewayv2 create-api-mapping \
    --domain-name 'regional.example.com' \
    --api-mapping-key 'myApi' \
    --api-id abcd1234 \
    --stage 'test'

Como resultado, la URL base que utiliza el nombre de dominio personalizado para la API que se implementa en la etapa se convierte en https://regional.example.com/myAPI.