ElasticLoadBalancingv2 / Client / set_ip_address_type

set_ip_address_type#

ElasticLoadBalancingv2.Client.set_ip_address_type(**kwargs)#

Sets the type of IP addresses used by the subnets of the specified load balancer.

See also: AWS API Documentation

Request Syntax

response = client.set_ip_address_type(
    LoadBalancerArn='string',
    IpAddressType='ipv4'|'dualstack'|'dualstack-without-public-ipv4'
)
Parameters:

  • LoadBalancerArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the load balancer.

  • IpAddressType (string) –

    [REQUIRED]

    Note: Internal load balancers must use the ipv4 IP address type.

    [Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).

    Note: Application Load Balancer authentication only supports IPv4 addresses when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer cannot complete the authentication process, resulting in HTTP 500 errors.

    [Network Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.

    [Gateway Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

Return type:

dict

Returns:

Response Syntax

{
    'IpAddressType': 'ipv4'|'dualstack'|'dualstack-without-public-ipv4'
}

Response Structure

  • (dict) –

    • IpAddressType (string) –

      The IP address type.

Exceptions