Skip to content

AllocateAddressRequest

Source code in docs_src/capo_ec2/types/allocate_address_request.py
class AllocateAddressRequest(TypedDict, closed=True):
    domain: NotRequired["capo_ec2.types.domain_type.DomainType"]
    """<p>The network (<code>vpc</code>).</p>"""
    address: NotRequired["capo_ec2.types.public_ip_address.PublicIpAddress"]
    """<p>The Elastic IP address to recover or an IPv4 address from an address pool.</p>"""
    public_ipv4_pool: NotRequired["capo_ec2.types.ipv4_pool_ec2_id.Ipv4PoolEc2Id"]
    """<p>The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the <code>Address</code> parameter instead.</p>"""
    network_border_group: NotRequired["capo_ec2.types.string.String"]
    """<p> A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.</p>"""
    customer_owned_ipv4_pool: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to assign to the Elastic IP address.</p>"""
    ipam_pool_id: NotRequired["capo_ec2.types.ipam_pool_id.IpamPoolId"]
    """<p>The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html">Allocate sequential Elastic IP addresses from an IPAM pool</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""

address instance-attribute

address: NotRequired[PublicIpAddress]

The Elastic IP address to recover or an IPv4 address from an address pool.

customer_owned_ipv4_pool instance-attribute

customer_owned_ipv4_pool: NotRequired[String]

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

domain instance-attribute

domain: NotRequired[DomainType]

The network (vpc).

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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

ipam_pool_id instance-attribute

ipam_pool_id: NotRequired[IpamPoolId]

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

network_border_group instance-attribute

network_border_group: NotRequired[String]

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

public_ipv4_pool instance-attribute

public_ipv4_pool: NotRequired[Ipv4PoolEc2Id]

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

The tags to assign to the Elastic IP address.