Skip to content

ProvisionByoipCidrRequest

Source code in docs_src/capo_ec2/types/provision_byoip_cidr_request.py
class ProvisionByoipCidrRequest(TypedDict, closed=True):
    cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.</p>"""
    cidr_authorization_context: NotRequired[
        "capo_ec2.types.cidr_authorization_context.CidrAuthorizationContext"
    ]
    """<p>A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.</p>"""
    publicly_advertisable: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.</p> <p>Default: true</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A description for the address range and the address pool.</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>"""
    pool_tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to apply to the address pool.</p>"""
    multi_region: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Reserved.</p>"""
    network_border_group: NotRequired["capo_ec2.types.string.String"]
    """<p>If you have <a href="https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html">Local Zones</a> enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.</p> <p>You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:</p> <ul> <li> <p>us-east-1-dfw-2</p> </li> <li> <p>us-west-2-lax-1</p> </li> <li> <p>us-west-2-phx-2</p> </li> </ul> <note> <p>You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.</p> </note>"""

cidr instance-attribute

cidr: NotRequired[String]

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

cidr_authorization_context instance-attribute

cidr_authorization_context: NotRequired[CidrAuthorizationContext]

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

description instance-attribute

description: NotRequired[String]

A description for the address range and the address pool.

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.

multi_region instance-attribute

multi_region: NotRequired[Boolean]

Reserved.

network_border_group instance-attribute

network_border_group: NotRequired[String]

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

  • us-east-1-dfw-2

  • us-west-2-lax-1

  • us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

pool_tag_specifications instance-attribute

pool_tag_specifications: NotRequired[TagSpecificationList]

The tags to apply to the address pool.

publicly_advertisable instance-attribute

publicly_advertisable: NotRequired[Boolean]

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true