EC2 / Client / advertise_byoip_cidr

advertise_byoip_cidr

EC2.Client.advertise_byoip_cidr(**kwargs)

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

See also: AWS API Documentation

Request Syntax

response = client.advertise_byoip_cidr(
    Cidr='string',
    DryRun=True|False
)

Parameters:

• Cidr (string) –

  [REQUIRED]

  The address range, in CIDR notation. This must be the exact range that you provisioned. You can’t advertise only a portion of the provisioned range.

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

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'Description': 'string',
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
    }
}

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.

    • StatusMessage (string) –

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

    • State (string) –

      The state of the address pool.