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 |
Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
Synopsis
- data AllocateIpamPoolCidr = AllocateIpamPoolCidr' {
- cidr :: Maybe Text
- clientToken :: Maybe Text
- description :: Maybe Text
- disallowedCidrs :: Maybe [Text]
- dryRun :: Maybe Bool
- netmaskLength :: Maybe Int
- previewNextCidr :: Maybe Bool
- ipamPoolId :: Text
- newAllocateIpamPoolCidr :: Text -> AllocateIpamPoolCidr
- allocateIpamPoolCidr_cidr :: Lens' AllocateIpamPoolCidr (Maybe Text)
- allocateIpamPoolCidr_clientToken :: Lens' AllocateIpamPoolCidr (Maybe Text)
- allocateIpamPoolCidr_description :: Lens' AllocateIpamPoolCidr (Maybe Text)
- allocateIpamPoolCidr_disallowedCidrs :: Lens' AllocateIpamPoolCidr (Maybe [Text])
- allocateIpamPoolCidr_dryRun :: Lens' AllocateIpamPoolCidr (Maybe Bool)
- allocateIpamPoolCidr_netmaskLength :: Lens' AllocateIpamPoolCidr (Maybe Int)
- allocateIpamPoolCidr_previewNextCidr :: Lens' AllocateIpamPoolCidr (Maybe Bool)
- allocateIpamPoolCidr_ipamPoolId :: Lens' AllocateIpamPoolCidr Text
- data AllocateIpamPoolCidrResponse = AllocateIpamPoolCidrResponse' {}
- newAllocateIpamPoolCidrResponse :: Int -> AllocateIpamPoolCidrResponse
- allocateIpamPoolCidrResponse_ipamPoolAllocation :: Lens' AllocateIpamPoolCidrResponse (Maybe IpamPoolAllocation)
- allocateIpamPoolCidrResponse_httpStatus :: Lens' AllocateIpamPoolCidrResponse Int
Creating a Request
data AllocateIpamPoolCidr Source #
See: newAllocateIpamPoolCidr
smart constructor.
AllocateIpamPoolCidr' | |
|
Instances
newAllocateIpamPoolCidr Source #
Create a value of AllocateIpamPoolCidr
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:
AllocateIpamPoolCidr
, allocateIpamPoolCidr_cidr
- The CIDR you would like to allocate from the IPAM pool. Note the
following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
AllocateIpamPoolCidr
, allocateIpamPoolCidr_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensuring Idempotency.
AllocateIpamPoolCidr
, allocateIpamPoolCidr_description
- A description for the allocation.
$sel:disallowedCidrs:AllocateIpamPoolCidr'
, allocateIpamPoolCidr_disallowedCidrs
- Exclude a particular CIDR range from being returned by the pool.
Disallowed CIDRs are only allowed if using netmask length for
allocation.
$sel:dryRun:AllocateIpamPoolCidr'
, allocateIpamPoolCidr_dryRun
- A check for 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:netmaskLength:AllocateIpamPoolCidr'
, allocateIpamPoolCidr_netmaskLength
- The netmask length of the CIDR you would like to allocate from the IPAM
pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
$sel:previewNextCidr:AllocateIpamPoolCidr'
, allocateIpamPoolCidr_previewNextCidr
- A preview of the next available CIDR in a pool.
AllocateIpamPoolCidr
, allocateIpamPoolCidr_ipamPoolId
- The ID of the IPAM pool from which you would like to allocate a CIDR.
Request Lenses
allocateIpamPoolCidr_cidr :: Lens' AllocateIpamPoolCidr (Maybe Text) Source #
The CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
allocateIpamPoolCidr_clientToken :: Lens' AllocateIpamPoolCidr (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
allocateIpamPoolCidr_description :: Lens' AllocateIpamPoolCidr (Maybe Text) Source #
A description for the allocation.
allocateIpamPoolCidr_disallowedCidrs :: Lens' AllocateIpamPoolCidr (Maybe [Text]) Source #
Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
allocateIpamPoolCidr_dryRun :: Lens' AllocateIpamPoolCidr (Maybe Bool) Source #
A check for 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
.
allocateIpamPoolCidr_netmaskLength :: Lens' AllocateIpamPoolCidr (Maybe Int) Source #
The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
allocateIpamPoolCidr_previewNextCidr :: Lens' AllocateIpamPoolCidr (Maybe Bool) Source #
A preview of the next available CIDR in a pool.
allocateIpamPoolCidr_ipamPoolId :: Lens' AllocateIpamPoolCidr Text Source #
The ID of the IPAM pool from which you would like to allocate a CIDR.
Destructuring the Response
data AllocateIpamPoolCidrResponse Source #
See: newAllocateIpamPoolCidrResponse
smart constructor.
AllocateIpamPoolCidrResponse' | |
|
Instances
newAllocateIpamPoolCidrResponse Source #
Create a value of AllocateIpamPoolCidrResponse
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:ipamPoolAllocation:AllocateIpamPoolCidrResponse'
, allocateIpamPoolCidrResponse_ipamPoolAllocation
- Information about the allocation created.
$sel:httpStatus:AllocateIpamPoolCidrResponse'
, allocateIpamPoolCidrResponse_httpStatus
- The response's http status code.
Response Lenses
allocateIpamPoolCidrResponse_ipamPoolAllocation :: Lens' AllocateIpamPoolCidrResponse (Maybe IpamPoolAllocation) Source #
Information about the allocation created.
allocateIpamPoolCidrResponse_httpStatus :: Lens' AllocateIpamPoolCidrResponse Int Source #
The response's http status code.