EC2 / Client / provision_byoip_cidr

provision_byoip_cidr#

EC2.Client.provision_byoip_cidr(**kwargs)#

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

See also: AWS API Documentation

Request Syntax

response = client.provision_byoip_cidr(
    Cidr='string',
    CidrAuthorizationContext={
        'Message': 'string',
        'Signature': 'string'
    },
    PubliclyAdvertisable=True|False,
    Description='string',
    DryRun=True|False,
    PoolTagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    MultiRegion=True|False,
    NetworkBorderGroup='string'
)
Parameters:
  • Cidr (string) –

    [REQUIRED]

    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.

  • CidrAuthorizationContext (dict) –

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

    • Message (string) – [REQUIRED]

      The plain-text authorization message for the prefix and account.

    • Signature (string) – [REQUIRED]

      The signed authorization message for the prefix and account.

  • PubliclyAdvertisable (boolean) –

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

    Default: true

  • Description (string) – A description for the address range and the address pool.

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

  • PoolTagSpecifications (list) –

    The tags to apply to the address pool.

    • (dict) –

      The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

      Note

      The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

      • ResourceType (string) –

        The type of resource to tag on creation.

      • Tags (list) –

        The tags to apply to the resource.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • MultiRegion (boolean) – Reserved.

  • NetworkBorderGroup (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

    Note

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

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'Description': 'string',
        'AsnAssociations': [
            {
                'Asn': 'string',
                'Cidr': 'string',
                'StatusMessage': 'string',
                'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
            },
        ],
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
        'NetworkBorderGroup': 'string'
    }
}

Response Structure

  • (dict) –

    • ByoipCidr (dict) –

      Information about the address range.

      • Cidr (string) –

        The address range, in CIDR notation.

      • Description (string) –

        The description of the address range.

      • AsnAssociations (list) –

        The BYOIP CIDR associations with ASNs.

        • (dict) –

          An Autonomous System Number (ASN) and BYOIP CIDR association.

          • Asn (string) –

            The association’s ASN.

          • Cidr (string) –

            The association’s CIDR.

          • StatusMessage (string) –

            The association’s status message.

          • State (string) –

            The association’s state.

      • StatusMessage (string) –

        Upon success, contains the ID of the address pool. Otherwise, contains an error message.

      • State (string) –

        The state of the address range.

        • advertised: The address range is being advertised to the internet by Amazon Web Services.

        • deprovisioned: The address range is deprovisioned.

        • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

        • failed-provision: The request to provision the address range was unsuccessful.

        • pending-deprovision: You’ve submitted a request to deprovision an address range and it’s pending.

        • pending-provision: You’ve submitted a request to provision an address range and it’s pending.

        • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

        • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

      • NetworkBorderGroup (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

        Note

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