:doc:`ElasticLoadBalancingv2 <../../elbv2>` / Client / set_ip_address_type

*******************
set_ip_address_type
*******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/SetIpAddressType>`_  


  **Request Syntax**
  ::

    response = client.set_ip_address_type(
        LoadBalancerArn='string',
        IpAddressType='ipv4'|'dualstack'|'dualstack-without-public-ipv4'
    )
    
  :type LoadBalancerArn: string
  :param LoadBalancerArn: **[REQUIRED]** 

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

    

  
  :type IpAddressType: string
  :param IpAddressType: **[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).

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'IpAddressType': 'ipv4'|'dualstack'|'dualstack-without-public-ipv4'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **IpAddressType** *(string) --* 

        The IP address type.

        
  
  **Exceptions**
  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.LoadBalancerNotFoundException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.InvalidConfigurationRequestException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.InvalidSubnetException`

  