amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.AllocateIpamPoolCidr

Description

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

Creating a Request

data AllocateIpamPoolCidr Source #

See: newAllocateIpamPoolCidr smart constructor.

Constructors

AllocateIpamPoolCidr' 

Fields

  • cidr :: Maybe Text

    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.

  • clientToken :: Maybe Text

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

  • description :: Maybe Text

    A description for the allocation.

  • disallowedCidrs :: Maybe [Text]

    Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

  • dryRun :: Maybe Bool

    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.

  • netmaskLength :: Maybe Int

    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.

  • previewNextCidr :: Maybe Bool

    A preview of the next available CIDR in a pool.

  • ipamPoolId :: Text

    The ID of the IPAM pool from which you would like to allocate a CIDR.

Instances

Instances details
ToHeaders AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

ToPath AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

ToQuery AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

AWSRequest AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Associated Types

type AWSResponse AllocateIpamPoolCidr #

Generic AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Associated Types

type Rep AllocateIpamPoolCidr :: Type -> Type #

Read AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Show AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

NFData AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Methods

rnf :: AllocateIpamPoolCidr -> () #

Eq AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Hashable AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

type AWSResponse AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

type Rep AllocateIpamPoolCidr Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

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_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.

Constructors

AllocateIpamPoolCidrResponse' 

Fields

Instances

Instances details
Generic AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Associated Types

type Rep AllocateIpamPoolCidrResponse :: Type -> Type #

Read AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Show AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

NFData AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

Eq AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

type Rep AllocateIpamPoolCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AllocateIpamPoolCidr

type Rep AllocateIpamPoolCidrResponse = D1 ('MetaData "AllocateIpamPoolCidrResponse" "Amazonka.EC2.AllocateIpamPoolCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AllocateIpamPoolCidrResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamPoolAllocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamPoolAllocation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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