EC2 / Client / assign_private_ip_addresses

assign_private_ip_addresses

EC2.Client.assign_private_ip_addresses(**kwargs)

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet’s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.assign_private_ip_addresses(
    Ipv4Prefixes=[
        'string',
    ],
    Ipv4PrefixCount=123,
    NetworkInterfaceId='string',
    PrivateIpAddresses=[
        'string',
    ],
    SecondaryPrivateIpAddressCount=123,
    AllowReassignment=True|False
)

Parameters:

• Ipv4Prefixes (list) –

  One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

  • (string) –

• Ipv4PrefixCount (integer) – The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

• NetworkInterfaceId (string) –

  [REQUIRED]

  The ID of the network interface.

• PrivateIpAddresses (list) –

  The IP addresses to be assigned as a secondary private IP address to the network interface. You can’t specify this parameter when also specifying a number of secondary IP addresses.

  If you don’t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

  • (string) –

• SecondaryPrivateIpAddressCount (integer) – The number of secondary IP addresses to assign to the network interface. You can’t specify this parameter when also specifying private IP addresses.

• AllowReassignment (boolean) – Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkInterfaceId': 'string',
    'AssignedPrivateIpAddresses': [
        {
            'PrivateIpAddress': 'string'
        },
    ],
    'AssignedIpv4Prefixes': [
        {
            'Ipv4Prefix': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • NetworkInterfaceId (string) –

    The ID of the network interface.

  • AssignedPrivateIpAddresses (list) –

    The private IP addresses assigned to the network interface.

    • (dict) –

      Describes the private IP addresses assigned to a network interface.

      • PrivateIpAddress (string) –

        The private IP address assigned to the network interface.

  • AssignedIpv4Prefixes (list) –

    The IPv4 prefixes that are assigned to the network interface.

    • (dict) –

      Describes an IPv4 prefix.

      • Ipv4Prefix (string) –

        The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

Examples

This example assigns the specified secondary private IP address to the specified network interface.

response = client.assign_private_ip_addresses(
    NetworkInterfaceId='eni-e5aa89a3',
    PrivateIpAddresses=[
        '10.0.0.82',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.

response = client.assign_private_ip_addresses(
    NetworkInterfaceId='eni-e5aa89a3',
    SecondaryPrivateIpAddressCount=2,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}