Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
Parameters:
-
cidr
(GenericString)
–
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.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
Raises:
Source code in docs_src/capo_global_accelerator/_services/global_accelerator.py
| def advertise_byoip_cidr(
self,
cidr: "capo_global_accelerator.types.generic_string.GenericString",
*,
config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
) -> "capo_global_accelerator.types.advertise_byoip_cidr_response.AdvertiseByoipCidrResponse":
"""<p>Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. </p> <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html"> WithdrawByoipCidr</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
Args:
cidr: <p>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.</p> <p> For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>
Raises:
capo_global_accelerator.errors.access_denied_exception.AccessDeniedException: <p>You don't have access permission.</p>
capo_global_accelerator.errors.byoip_cidr_not_found_exception.ByoipCidrNotFoundException: <p>The CIDR that you specified was not found or is incorrect.</p>
capo_global_accelerator.errors.incorrect_cidr_state_exception.IncorrectCidrStateException: <p>The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.</p>
capo_global_accelerator.errors.internal_service_error_exception.InternalServiceErrorException: <p>There was an internal error for Global Accelerator.</p>
capo_global_accelerator.errors.invalid_argument_exception.InvalidArgumentException: <p>An argument that you specified is invalid.</p>
capo_global_accelerator.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_global_accelerator.types.advertise_byoip_cidr_request.AdvertiseByoipCidrRequest]",
) -> OperationResponse[
"capo_global_accelerator.types.advertise_byoip_cidr_response.AdvertiseByoipCidrResponse"
]:
import capo_global_accelerator._operations.global_accelerator_v20180706.advertise_byoip_cidr
output, http_response = (
capo_global_accelerator._operations.global_accelerator_v20180706.advertise_byoip_cidr.advertise_byoip_cidr(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("AdvertiseByoipCidr")
)
input_: capo_global_accelerator.types.advertise_byoip_cidr_request.AdvertiseByoipCidrRequest = {
"cidr": cidr
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|