EC2 / Client / provision_public_ipv4_pool_cidr

provision_public_ipv4_pool_cidr#

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? in the Amazon VPC IPAM User Guide.

See also: AWS API Documentation

Request Syntax

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

  • DryRun (boolean) – 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.

  • IpamPoolId (string) –

    [REQUIRED]

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

  • PoolId (string) –

    [REQUIRED]

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

  • NetmaskLength (integer) –

    [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.

  • NetworkBorderGroup (string) – 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 in the Amazon EC2 User Guide.

Return type:

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.