:doc:`EC2 <../../ec2>` / Client / provision_public_ipv4_pool_cidr

*******************************
provision_public_ipv4_pool_cidr
*******************************



.. py:method:: EC2.Client.provision_public_ipv4_pool_cidr(**kwargs)

  

  Provision a CIDR to a public IPv4 pool.

   

  For more information about IPAM, see `What is IPAM? <https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html>`__ in the *Amazon VPC IPAM User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr>`_  


  **Request Syntax**
  ::

    response = client.provision_public_ipv4_pool_cidr(
        DryRun=True|False,
        IpamPoolId='string',
        PoolId='string',
        NetmaskLength=123,
        NetworkBorderGroup='string'
    )
    
  :type DryRun: boolean
  :param DryRun: 

    A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

  
  :type IpamPoolId: string
  :param IpamPoolId: **[REQUIRED]** 

    The ID of the IPAM pool you would like to use to allocate this CIDR.

    

  
  :type PoolId: string
  :param PoolId: **[REQUIRED]** 

    The ID of the public IPv4 pool you would like to use for this CIDR.

    

  
  :type NetmaskLength: integer
  :param NetmaskLength: **[REQUIRED]** 

    The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.

    

  
  :type NetworkBorderGroup: string
  :param NetworkBorderGroup: 

    The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see `Local Zone availability <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail>`__ in the *Amazon EC2 User Guide*.

    

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

    
    ::

      {
          'PoolId': 'string',
          'PoolAddressRange': {
              'FirstAddress': 'string',
              'LastAddress': 'string',
              'AddressCount': 123,
              'AvailableAddressCount': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PoolId** *(string) --* 

        The ID of the pool that you want to provision the CIDR to.

        
      

      - **PoolAddressRange** *(dict) --* 

        Information about the address range of the public IPv4 pool.

        
        

        - **FirstAddress** *(string) --* 

          The first IP address in the range.

          
        

        - **LastAddress** *(string) --* 

          The last IP address in the range.

          
        

        - **AddressCount** *(integer) --* 

          The number of addresses in the range.

          
        

        - **AvailableAddressCount** *(integer) --* 

          The number of available addresses in the range.

          
    
  