| 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.CreateIpam
Description
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
Synopsis
- data CreateIpam = CreateIpam' {}
- newCreateIpam :: CreateIpam
- createIpam_clientToken :: Lens' CreateIpam (Maybe Text)
- createIpam_description :: Lens' CreateIpam (Maybe Text)
- createIpam_dryRun :: Lens' CreateIpam (Maybe Bool)
- createIpam_operatingRegions :: Lens' CreateIpam (Maybe [AddIpamOperatingRegion])
- createIpam_tagSpecifications :: Lens' CreateIpam (Maybe [TagSpecification])
- data CreateIpamResponse = CreateIpamResponse' {
- ipam :: Maybe Ipam
- httpStatus :: Int
- newCreateIpamResponse :: Int -> CreateIpamResponse
- createIpamResponse_ipam :: Lens' CreateIpamResponse (Maybe Ipam)
- createIpamResponse_httpStatus :: Lens' CreateIpamResponse Int
Creating a Request
data CreateIpam Source #
See: newCreateIpam smart constructor.
Constructors
| CreateIpam' | |
Fields
| |
Instances
newCreateIpam :: CreateIpam Source #
Create a value of CreateIpam 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:
CreateIpam, createIpam_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensuring Idempotency.
CreateIpam, createIpam_description - A description for the IPAM.
$sel:dryRun:CreateIpam', createIpam_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.
CreateIpam, createIpam_operatingRegions - The operating Regions for the IPAM. Operating Regions are Amazon Web
Services Regions where the IPAM is allowed to manage IP address CIDRs.
IPAM only discovers and monitors resources in the Amazon Web Services
Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
CreateIpam, createIpam_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.
Request Lenses
createIpam_clientToken :: Lens' CreateIpam (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
createIpam_description :: Lens' CreateIpam (Maybe Text) Source #
A description for the IPAM.
createIpam_dryRun :: Lens' CreateIpam (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.
createIpam_operatingRegions :: Lens' CreateIpam (Maybe [AddIpamOperatingRegion]) Source #
The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
createIpam_tagSpecifications :: Lens' CreateIpam (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.
Destructuring the Response
data CreateIpamResponse Source #
See: newCreateIpamResponse smart constructor.
Constructors
| CreateIpamResponse' | |
Fields
| |
Instances
newCreateIpamResponse Source #
Arguments
| :: Int | |
| -> CreateIpamResponse |
Create a value of CreateIpamResponse 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:ipam:CreateIpamResponse', createIpamResponse_ipam - Information about the IPAM created.
$sel:httpStatus:CreateIpamResponse', createIpamResponse_httpStatus - The response's http status code.
Response Lenses
createIpamResponse_ipam :: Lens' CreateIpamResponse (Maybe Ipam) Source #
Information about the IPAM created.
createIpamResponse_httpStatus :: Lens' CreateIpamResponse Int Source #
The response's http status code.