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 |
Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
Synopsis
- data CreateIpamPool = CreateIpamPool' {
- allocationDefaultNetmaskLength :: Maybe Natural
- allocationMaxNetmaskLength :: Maybe Natural
- allocationMinNetmaskLength :: Maybe Natural
- allocationResourceTags :: Maybe [RequestIpamResourceTag]
- autoImport :: Maybe Bool
- awsService :: Maybe IpamPoolAwsService
- clientToken :: Maybe Text
- description :: Maybe Text
- dryRun :: Maybe Bool
- locale :: Maybe Text
- publiclyAdvertisable :: Maybe Bool
- sourceIpamPoolId :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- ipamScopeId :: Text
- addressFamily :: AddressFamily
- newCreateIpamPool :: Text -> AddressFamily -> CreateIpamPool
- createIpamPool_allocationDefaultNetmaskLength :: Lens' CreateIpamPool (Maybe Natural)
- createIpamPool_allocationMaxNetmaskLength :: Lens' CreateIpamPool (Maybe Natural)
- createIpamPool_allocationMinNetmaskLength :: Lens' CreateIpamPool (Maybe Natural)
- createIpamPool_allocationResourceTags :: Lens' CreateIpamPool (Maybe [RequestIpamResourceTag])
- createIpamPool_autoImport :: Lens' CreateIpamPool (Maybe Bool)
- createIpamPool_awsService :: Lens' CreateIpamPool (Maybe IpamPoolAwsService)
- createIpamPool_clientToken :: Lens' CreateIpamPool (Maybe Text)
- createIpamPool_description :: Lens' CreateIpamPool (Maybe Text)
- createIpamPool_dryRun :: Lens' CreateIpamPool (Maybe Bool)
- createIpamPool_locale :: Lens' CreateIpamPool (Maybe Text)
- createIpamPool_publiclyAdvertisable :: Lens' CreateIpamPool (Maybe Bool)
- createIpamPool_sourceIpamPoolId :: Lens' CreateIpamPool (Maybe Text)
- createIpamPool_tagSpecifications :: Lens' CreateIpamPool (Maybe [TagSpecification])
- createIpamPool_ipamScopeId :: Lens' CreateIpamPool Text
- createIpamPool_addressFamily :: Lens' CreateIpamPool AddressFamily
- data CreateIpamPoolResponse = CreateIpamPoolResponse' {
- ipamPool :: Maybe IpamPool
- httpStatus :: Int
- newCreateIpamPoolResponse :: Int -> CreateIpamPoolResponse
- createIpamPoolResponse_ipamPool :: Lens' CreateIpamPoolResponse (Maybe IpamPool)
- createIpamPoolResponse_httpStatus :: Lens' CreateIpamPoolResponse Int
Creating a Request
data CreateIpamPool Source #
See: newCreateIpamPool
smart constructor.
CreateIpamPool' | |
|
Instances
Create a value of CreateIpamPool
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:
CreateIpamPool
, createIpamPool_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.
CreateIpamPool
, createIpamPool_allocationMaxNetmaskLength
- The maximum netmask length possible for CIDR allocations in this IPAM
pool to be compliant. The maximum netmask length must be greater than
the minimum netmask length. Possible netmask lengths for IPv4 addresses
are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
CreateIpamPool
, createIpamPool_allocationMinNetmaskLength
- The minimum netmask length required for CIDR allocations in this IPAM
pool to be compliant. The minimum netmask length must be less than the
maximum netmask length. Possible netmask lengths for IPv4 addresses are
0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
CreateIpamPool
, createIpamPool_allocationResourceTags
- Tags that are required for resources that use CIDRs from this IPAM pool.
Resources that do not have these tags will not be allowed to allocate
space from the pool. If the resources have their tags changed after they
have allocated space or if the allocation tagging requirements are
changed on the pool, the resource may be marked as noncompliant.
CreateIpamPool
, createIpamPool_autoImport
- If selected, 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.
CreateIpamPool
, createIpamPool_awsService
- Limits which service in Amazon Web Services that the pool can be used
in. "ec2", for example, allows users to use space for Elastic IP
addresses and VPCs.
CreateIpamPool
, createIpamPool_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensuring Idempotency.
CreateIpamPool
, createIpamPool_description
- A description for the IPAM pool.
$sel:dryRun:CreateIpamPool'
, createIpamPool_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
.
CreateIpamPool
, createIpamPool_locale
- In IPAM, the locale is the Amazon Web Services Region where you want to
make an IPAM pool available for allocations. Only resources in the same
Region as the locale of the pool can get IP address allocations from the
pool. You can only allocate a CIDR for a VPC, for example, from an IPAM
pool that shares a locale with the VPC’s Region. Note that once you
choose a Locale for a pool, you cannot modify it. If you do not choose a
locale, resources in Regions others than the IPAM's home region cannot
use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
CreateIpamPool
, createIpamPool_publiclyAdvertisable
- Determines if the pool is publicly advertisable. This option is not
available for pools with AddressFamily set to ipv4
.
CreateIpamPool
, createIpamPool_sourceIpamPoolId
- The ID of the source IPAM pool. Use this option to create a pool within
an existing pool. Note that the CIDR you provision for the pool within
the source pool must be available in the source pool's CIDR range.
CreateIpamPool
, createIpamPool_tagSpecifications
- The key/value combination of a tag assigned to the resource. Use the
tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner
and
the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
CreateIpamPool
, createIpamPool_ipamScopeId
- The ID of the scope in which you would like to create the IPAM pool.
CreateIpamPool
, createIpamPool_addressFamily
- The IP protocol assigned to this IPAM pool. You must choose either IPv4
or IPv6 protocol for a pool.
Request Lenses
createIpamPool_allocationDefaultNetmaskLength :: Lens' CreateIpamPool (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.
createIpamPool_allocationMaxNetmaskLength :: Lens' CreateIpamPool (Maybe Natural) Source #
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
createIpamPool_allocationMinNetmaskLength :: Lens' CreateIpamPool (Maybe Natural) Source #
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
createIpamPool_allocationResourceTags :: Lens' CreateIpamPool (Maybe [RequestIpamResourceTag]) Source #
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
createIpamPool_autoImport :: Lens' CreateIpamPool (Maybe Bool) Source #
If selected, 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.
createIpamPool_awsService :: Lens' CreateIpamPool (Maybe IpamPoolAwsService) Source #
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
createIpamPool_clientToken :: Lens' CreateIpamPool (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
createIpamPool_description :: Lens' CreateIpamPool (Maybe Text) Source #
A description for the IPAM pool.
createIpamPool_dryRun :: Lens' CreateIpamPool (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
.
createIpamPool_locale :: Lens' CreateIpamPool (Maybe Text) Source #
In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
createIpamPool_publiclyAdvertisable :: Lens' CreateIpamPool (Maybe Bool) Source #
Determines if the pool is publicly advertisable. This option is not
available for pools with AddressFamily set to ipv4
.
createIpamPool_sourceIpamPoolId :: Lens' CreateIpamPool (Maybe Text) Source #
The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
createIpamPool_tagSpecifications :: Lens' CreateIpamPool (Maybe [TagSpecification]) Source #
The key/value combination of a tag assigned to the resource. Use the
tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner
and
the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
createIpamPool_ipamScopeId :: Lens' CreateIpamPool Text Source #
The ID of the scope in which you would like to create the IPAM pool.
createIpamPool_addressFamily :: Lens' CreateIpamPool AddressFamily Source #
The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
Destructuring the Response
data CreateIpamPoolResponse Source #
See: newCreateIpamPoolResponse
smart constructor.
CreateIpamPoolResponse' | |
|
Instances
newCreateIpamPoolResponse Source #
Create a value of CreateIpamPoolResponse
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:CreateIpamPoolResponse'
, createIpamPoolResponse_ipamPool
- Information about the IPAM pool created.
$sel:httpStatus:CreateIpamPoolResponse'
, createIpamPoolResponse_httpStatus
- The response's http status code.
Response Lenses
createIpamPoolResponse_ipamPool :: Lens' CreateIpamPoolResponse (Maybe IpamPool) Source #
Information about the IPAM pool created.
createIpamPoolResponse_httpStatus :: Lens' CreateIpamPoolResponse Int Source #
The response's http status code.