| 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 |
Amazonka.EC2.ProvisionByoipCidr
Description
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 Elastic Compute Cloud 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.
Synopsis
- data ProvisionByoipCidr = ProvisionByoipCidr' {}
- newProvisionByoipCidr :: Text -> ProvisionByoipCidr
- provisionByoipCidr_cidrAuthorizationContext :: Lens' ProvisionByoipCidr (Maybe CidrAuthorizationContext)
- provisionByoipCidr_description :: Lens' ProvisionByoipCidr (Maybe Text)
- provisionByoipCidr_dryRun :: Lens' ProvisionByoipCidr (Maybe Bool)
- provisionByoipCidr_multiRegion :: Lens' ProvisionByoipCidr (Maybe Bool)
- provisionByoipCidr_poolTagSpecifications :: Lens' ProvisionByoipCidr (Maybe [TagSpecification])
- provisionByoipCidr_publiclyAdvertisable :: Lens' ProvisionByoipCidr (Maybe Bool)
- provisionByoipCidr_cidr :: Lens' ProvisionByoipCidr Text
- data ProvisionByoipCidrResponse = ProvisionByoipCidrResponse' {
- byoipCidr :: Maybe ByoipCidr
- httpStatus :: Int
- newProvisionByoipCidrResponse :: Int -> ProvisionByoipCidrResponse
- provisionByoipCidrResponse_byoipCidr :: Lens' ProvisionByoipCidrResponse (Maybe ByoipCidr)
- provisionByoipCidrResponse_httpStatus :: Lens' ProvisionByoipCidrResponse Int
Creating a Request
data ProvisionByoipCidr Source #
See: newProvisionByoipCidr smart constructor.
Constructors
| ProvisionByoipCidr' | |
Fields
| |
Instances
newProvisionByoipCidr Source #
Arguments
| :: Text | |
| -> ProvisionByoipCidr |
Create a value of ProvisionByoipCidr 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:cidrAuthorizationContext:ProvisionByoipCidr', provisionByoipCidr_cidrAuthorizationContext - A signed document that proves that you are authorized to bring the
specified IP address range to Amazon using BYOIP.
ProvisionByoipCidr, provisionByoipCidr_description - A description for the address range and the address pool.
$sel:dryRun:ProvisionByoipCidr', provisionByoipCidr_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.
$sel:multiRegion:ProvisionByoipCidr', provisionByoipCidr_multiRegion - Reserved.
$sel:poolTagSpecifications:ProvisionByoipCidr', provisionByoipCidr_poolTagSpecifications - The tags to apply to the address pool.
ProvisionByoipCidr, provisionByoipCidr_publiclyAdvertisable - (IPv6 only) Indicate whether the address range will be publicly
advertised to the internet.
Default: true
ProvisionByoipCidr, provisionByoipCidr_cidr - 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 prefix you can specify is /56. The address range cannot overlap
with another address range that you've brought to this or another
Region.
Request Lenses
provisionByoipCidr_cidrAuthorizationContext :: Lens' ProvisionByoipCidr (Maybe CidrAuthorizationContext) Source #
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
provisionByoipCidr_description :: Lens' ProvisionByoipCidr (Maybe Text) Source #
A description for the address range and the address pool.
provisionByoipCidr_dryRun :: Lens' ProvisionByoipCidr (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.
provisionByoipCidr_multiRegion :: Lens' ProvisionByoipCidr (Maybe Bool) Source #
Reserved.
provisionByoipCidr_poolTagSpecifications :: Lens' ProvisionByoipCidr (Maybe [TagSpecification]) Source #
The tags to apply to the address pool.
provisionByoipCidr_publiclyAdvertisable :: Lens' ProvisionByoipCidr (Maybe Bool) Source #
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
provisionByoipCidr_cidr :: Lens' ProvisionByoipCidr Text Source #
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 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.
Destructuring the Response
data ProvisionByoipCidrResponse Source #
See: newProvisionByoipCidrResponse smart constructor.
Constructors
| ProvisionByoipCidrResponse' | |
Fields
| |
Instances
newProvisionByoipCidrResponse Source #
Create a value of ProvisionByoipCidrResponse 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:ProvisionByoipCidrResponse', provisionByoipCidrResponse_byoipCidr - Information about the address range.
$sel:httpStatus:ProvisionByoipCidrResponse', provisionByoipCidrResponse_httpStatus - The response's http status code.
Response Lenses
provisionByoipCidrResponse_byoipCidr :: Lens' ProvisionByoipCidrResponse (Maybe ByoipCidr) Source #
Information about the address range.
provisionByoipCidrResponse_httpStatus :: Lens' ProvisionByoipCidrResponse Int Source #
The response's http status code.