Tipos de endereço IP para nomes de domínio personalizados no API Gateway

Ao criar um nome de domínio personalizado, você especifica o tipo de endereços IP que podem invocar seu domínio. É possível escolher IPv4 para resolver endereços IPv4 e invocar seu domínio ou escolher pilha dupla para permitir que endereços IPv4 e IPv6 invoquem seu domínio. Recomendamos que você defina o tipo de endereço IP como pilha dupla para aliviar o esgotamento do espaço IP ou para seu procedimento de segurança. Para ter mais informações sobre os benefícios de um tipo de endereço IP de pilha dupla, consulte IPv6 na AWS.

É possível alterar o tipo de endereço IP atualizando a configuração do endpoint do nome de domínio.

Considerações sobre tipos de endereço IP

As considerações a seguir podem afetar o uso de tipos de endereço IP.

• O tipo de endereço IP padrão para nomes de domínio personalizados do API Gateway para APIs públicas é IPv4.

• Os nomes de domínio personalizados privados só podem ter um tipo de endereço IP de pilha dupla.

• Seu nome de domínio personalizado não precisa ter o mesmo tipo de endereço IP para todas as APIs associadas a ele. Se você desabilitar seu endpoint de API padrão, isso poderá afetar como os chamadores podem invocar seu domínio.

Alterar o tipo de endereço IP de um nome de domínio personalizado

É possível alterar o tipo de endereço IP atualizando a configuração do endpoint do nome de domínio. É possível atualizar a configuração do endpoint usando o AWS Management Console, a AWS CLI, o AWS CloudFormation ou um SDK da AWS.

AWS Management Console

Como alterar o tipo de endereço IP de um nome de domínio personalizado

1. Faça login no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. Escolha um nome de domínio personalizado público.

3. Escolha Configurações de endpoint.

4. Em Tipo de endereço IP, escolha IPv4 ou Pilha dupla.

5. Escolha Salvar.

AWS CLI

O comando update-domain-name a seguir atualiza uma API para ter um tipo de endereço IP de pilha dupla:

aws apigateway update-domain-name \
    --domain-name dualstack.example.com \
    --patch-operations "op='replace',path='/endpointConfiguration/ipAddressType',value='dualstack'"

A saída será exibida da seguinte forma:

{
    "domainName": "dualstack.example.com",
    "certificateUploadDate": "2025-02-04T14:46:10-08:00",
    "regionalDomainName": "d-abcd1234.execute-api.us-east-1.amazonaws.com",
    "regionalHostedZoneId": "Z3LQWSYCGH4ADY",
    "regionalCertificateArn": "arn:aws:acm:us-east-1:111122223333:certificate/a1b2c3d4-5678-90ab-cdef",
    "endpointConfiguration": {
        "types": [
            "REGIONAL"
        ],
        "ipAddressType": "dualstack"
    },
    "domainNameStatus": "AVAILABLE",
    "securityPolicy": "TLS_1_2",
    "tags": {}
}