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.

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]

The IP address type. Internal load balancers must use ipv4.

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

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

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

Return type:

dict

Returns:

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