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 |
Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
Synopsis
- data ModifyIpamPool = ModifyIpamPool' {
- addAllocationResourceTags :: Maybe [RequestIpamResourceTag]
- allocationDefaultNetmaskLength :: Maybe Natural
- allocationMaxNetmaskLength :: Maybe Natural
- allocationMinNetmaskLength :: Maybe Natural
- autoImport :: Maybe Bool
- clearAllocationDefaultNetmaskLength :: Maybe Bool
- description :: Maybe Text
- dryRun :: Maybe Bool
- removeAllocationResourceTags :: Maybe [RequestIpamResourceTag]
- ipamPoolId :: Text
- newModifyIpamPool :: Text -> ModifyIpamPool
- modifyIpamPool_addAllocationResourceTags :: Lens' ModifyIpamPool (Maybe [RequestIpamResourceTag])
- modifyIpamPool_allocationDefaultNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural)
- modifyIpamPool_allocationMaxNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural)
- modifyIpamPool_allocationMinNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural)
- modifyIpamPool_autoImport :: Lens' ModifyIpamPool (Maybe Bool)
- modifyIpamPool_clearAllocationDefaultNetmaskLength :: Lens' ModifyIpamPool (Maybe Bool)
- modifyIpamPool_description :: Lens' ModifyIpamPool (Maybe Text)
- modifyIpamPool_dryRun :: Lens' ModifyIpamPool (Maybe Bool)
- modifyIpamPool_removeAllocationResourceTags :: Lens' ModifyIpamPool (Maybe [RequestIpamResourceTag])
- modifyIpamPool_ipamPoolId :: Lens' ModifyIpamPool Text
- data ModifyIpamPoolResponse = ModifyIpamPoolResponse' {
- ipamPool :: Maybe IpamPool
- httpStatus :: Int
- newModifyIpamPoolResponse :: Int -> ModifyIpamPoolResponse
- modifyIpamPoolResponse_ipamPool :: Lens' ModifyIpamPoolResponse (Maybe IpamPool)
- modifyIpamPoolResponse_httpStatus :: Lens' ModifyIpamPoolResponse Int
Creating a Request
data ModifyIpamPool Source #
See: newModifyIpamPool
smart constructor.
ModifyIpamPool' | |
|
Instances
Create a value of ModifyIpamPool
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:addAllocationResourceTags:ModifyIpamPool'
, modifyIpamPool_addAllocationResourceTags
- Add tag allocation rules to a pool. For more information about
allocation rules, see
Create a top-level pool
in the Amazon VPC IPAM User Guide.
ModifyIpamPool
, modifyIpamPool_allocationDefaultNetmaskLength
- The default netmask length for allocations added to this pool. If, for
example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16
here, new allocations will default to 10.0.0.0/16.
ModifyIpamPool
, modifyIpamPool_allocationMaxNetmaskLength
- The maximum netmask length possible for CIDR allocations in this IPAM
pool to be compliant. Possible netmask lengths for IPv4 addresses are 0
- 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The
maximum netmask length must be greater than the minimum netmask length.
ModifyIpamPool
, modifyIpamPool_allocationMinNetmaskLength
- The minimum netmask length required for CIDR allocations in this IPAM
pool to be compliant. Possible netmask lengths for IPv4 addresses are 0
- 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The
minimum netmask length must be less than the maximum netmask length.
ModifyIpamPool
, modifyIpamPool_autoImport
- If true, IPAM will continuously look for resources within the CIDR range
of this pool and automatically import them as allocations into your
IPAM. The CIDRs that will be allocated for these resources must not
already be allocated to other resources in order for the import to
succeed. IPAM will import a CIDR regardless of its compliance with the
pool's allocation rules, so a resource might be imported and
subsequently marked as noncompliant. If IPAM discovers multiple CIDRs
that overlap, IPAM will import the largest CIDR only. If IPAM discovers
multiple CIDRs with matching CIDRs, IPAM will randomly import one of
them only.
A locale must be set on the pool for this feature to work.
$sel:clearAllocationDefaultNetmaskLength:ModifyIpamPool'
, modifyIpamPool_clearAllocationDefaultNetmaskLength
- Clear the default netmask length allocation rule for this pool.
ModifyIpamPool
, modifyIpamPool_description
- The description of the IPAM pool you want to modify.
$sel:dryRun:ModifyIpamPool'
, modifyIpamPool_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:removeAllocationResourceTags:ModifyIpamPool'
, modifyIpamPool_removeAllocationResourceTags
- Remove tag allocation rules from a pool.
ModifyIpamPool
, modifyIpamPool_ipamPoolId
- The ID of the IPAM pool you want to modify.
Request Lenses
modifyIpamPool_addAllocationResourceTags :: Lens' ModifyIpamPool (Maybe [RequestIpamResourceTag]) Source #
Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
modifyIpamPool_allocationDefaultNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural) Source #
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
modifyIpamPool_allocationMaxNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural) Source #
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
modifyIpamPool_allocationMinNetmaskLength :: Lens' ModifyIpamPool (Maybe Natural) Source #
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
modifyIpamPool_autoImport :: Lens' ModifyIpamPool (Maybe Bool) Source #
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
modifyIpamPool_clearAllocationDefaultNetmaskLength :: Lens' ModifyIpamPool (Maybe Bool) Source #
Clear the default netmask length allocation rule for this pool.
modifyIpamPool_description :: Lens' ModifyIpamPool (Maybe Text) Source #
The description of the IPAM pool you want to modify.
modifyIpamPool_dryRun :: Lens' ModifyIpamPool (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
.
modifyIpamPool_removeAllocationResourceTags :: Lens' ModifyIpamPool (Maybe [RequestIpamResourceTag]) Source #
Remove tag allocation rules from a pool.
modifyIpamPool_ipamPoolId :: Lens' ModifyIpamPool Text Source #
The ID of the IPAM pool you want to modify.
Destructuring the Response
data ModifyIpamPoolResponse Source #
See: newModifyIpamPoolResponse
smart constructor.
ModifyIpamPoolResponse' | |
|
Instances
newModifyIpamPoolResponse Source #
Create a value of ModifyIpamPoolResponse
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:ipamPool:ModifyIpamPoolResponse'
, modifyIpamPoolResponse_ipamPool
- The results of the modification.
$sel:httpStatus:ModifyIpamPoolResponse'
, modifyIpamPoolResponse_httpStatus
- The response's http status code.
Response Lenses
modifyIpamPoolResponse_ipamPool :: Lens' ModifyIpamPoolResponse (Maybe IpamPool) Source #
The results of the modification.
modifyIpamPoolResponse_httpStatus :: Lens' ModifyIpamPoolResponse Int Source #
The response's http status code.