Skip to content

advertise_byoip_cidr

Operation

advertise_byoip_cidr

advertise_byoip_cidr(request: AdvertiseByoipCidrInput | AdvertiseByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AdvertiseByoipCidrInputDict]) -> AdvertiseByoipCidrOutput

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.

Parameters:

Name Type Description Default
request AdvertiseByoipCidrInput | AdvertiseByoipCidrInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AdvertiseByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AdvertiseByoipCidrOutput

An instance of AdvertiseByoipCidrOutput.

advertise_byoip_cidr async

advertise_byoip_cidr(request: AdvertiseByoipCidrInput | AdvertiseByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AdvertiseByoipCidrInputDict]) -> AdvertiseByoipCidrOutput

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.

Parameters:

Name Type Description Default
request AdvertiseByoipCidrInput | AdvertiseByoipCidrInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AdvertiseByoipCidrInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AdvertiseByoipCidrOutput

An instance of AdvertiseByoipCidrOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

AdvertiseByoipCidrInputDict

Bases: TypedDict

Dictionary form of AdvertiseByoipCidrInput.

Attributes

asn instance-attribute
asn: str | None

The public 2-byte or 4-byte ASN that you want to advertise.

cidr instance-attribute
cidr: Required[str]

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.

dry_run instance-attribute
dry_run: bool | None

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.

network_border_group instance-attribute
network_border_group: str | None

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.

AdvertiseByoipCidrInput dataclass

Bases: _SerdeShape

Dataclass for AdvertiseByoipCidrInput structure.

Attributes

asn class-attribute instance-attribute
asn: str | None = ...

The public 2-byte or 4-byte ASN that you want to advertise.

cidr class-attribute instance-attribute
cidr: str | None = ...

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.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

network_border_group class-attribute instance-attribute
network_border_group: str | None = ...

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.

Output

AdvertiseByoipCidrOutput dataclass

Bases: _SerdeShape

Dataclass for AdvertiseByoipCidrOutput structure.

Attributes

byoip_cidr class-attribute instance-attribute
byoip_cidr: ByoipCidr | None = ...

Information about the address range.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.