Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data AdvertiseByoipCidr = AdvertiseByoipCidr' {}
- newAdvertiseByoipCidr :: Text -> AdvertiseByoipCidr
- advertiseByoipCidr_dryRun :: Lens' AdvertiseByoipCidr (Maybe Bool)
- advertiseByoipCidr_cidr :: Lens' AdvertiseByoipCidr Text
- data AdvertiseByoipCidrResponse = AdvertiseByoipCidrResponse' {
- byoipCidr :: Maybe ByoipCidr
- httpStatus :: Int
- newAdvertiseByoipCidrResponse :: Int -> AdvertiseByoipCidrResponse
- advertiseByoipCidrResponse_byoipCidr :: Lens' AdvertiseByoipCidrResponse (Maybe ByoipCidr)
- advertiseByoipCidrResponse_httpStatus :: Lens' AdvertiseByoipCidrResponse Int
Creating a Request
data AdvertiseByoipCidr Source #
See: newAdvertiseByoipCidr
smart constructor.
AdvertiseByoipCidr' | |
|
Instances
newAdvertiseByoipCidr Source #
Create a value of AdvertiseByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:AdvertiseByoipCidr'
, advertiseByoipCidr_dryRun
- 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
.
AdvertiseByoipCidr
, advertiseByoipCidr_cidr
- 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.
Request Lenses
advertiseByoipCidr_dryRun :: Lens' AdvertiseByoipCidr (Maybe Bool) Source #
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
.
advertiseByoipCidr_cidr :: Lens' AdvertiseByoipCidr Text Source #
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.
Destructuring the Response
data AdvertiseByoipCidrResponse Source #
See: newAdvertiseByoipCidrResponse
smart constructor.
AdvertiseByoipCidrResponse' | |
|
Instances
newAdvertiseByoipCidrResponse Source #
Create a value of AdvertiseByoipCidrResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidr:AdvertiseByoipCidrResponse'
, advertiseByoipCidrResponse_byoipCidr
- Information about the address range.
$sel:httpStatus:AdvertiseByoipCidrResponse'
, advertiseByoipCidrResponse_httpStatus
- The response's http status code.
Response Lenses
advertiseByoipCidrResponse_byoipCidr :: Lens' AdvertiseByoipCidrResponse (Maybe ByoipCidr) Source #
Information about the address range.
advertiseByoipCidrResponse_httpStatus :: Lens' AdvertiseByoipCidrResponse Int Source #
The response's http status code.