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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

Synopsis

Creating a Request

data ProvisionIpamPoolCidr Source #

See: newProvisionIpamPoolCidr smart constructor.

Constructors

ProvisionIpamPoolCidr'

Fields

cidr :: Maybe Text
The CIDR you want to assign to the IPAM pool.
cidrAuthorizationContext :: Maybe IpamCidrAuthorizationContext
A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
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.
ipamPoolId :: Text
The ID of the IPAM pool to which you want to assign a CIDR.

Instances

Instances details

ToHeaders ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods toHeaders :: ProvisionIpamPoolCidr -> [Header] #
ToPath ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods toPath :: ProvisionIpamPoolCidr -> ByteString #
ToQuery ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods toQuery :: ProvisionIpamPoolCidr -> QueryString #
AWSRequest ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Associated Types type AWSResponse ProvisionIpamPoolCidr # Methods request :: (Service -> Service) -> ProvisionIpamPoolCidr -> Request ProvisionIpamPoolCidr # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ProvisionIpamPoolCidr -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ProvisionIpamPoolCidr))) #
Generic ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Associated Types type Rep ProvisionIpamPoolCidr :: Type -> Type # Methods from :: ProvisionIpamPoolCidr -> Rep ProvisionIpamPoolCidr x # to :: Rep ProvisionIpamPoolCidr x -> ProvisionIpamPoolCidr #
Read ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods readsPrec :: Int -> ReadS ProvisionIpamPoolCidr # readList :: ReadS [ProvisionIpamPoolCidr] # readPrec :: ReadPrec ProvisionIpamPoolCidr # readListPrec :: ReadPrec [ProvisionIpamPoolCidr] #
Show ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods showsPrec :: Int -> ProvisionIpamPoolCidr -> ShowS # show :: ProvisionIpamPoolCidr -> String # showList :: [ProvisionIpamPoolCidr] -> ShowS #
NFData ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods rnf :: ProvisionIpamPoolCidr -> () #
Eq ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods (==) :: ProvisionIpamPoolCidr -> ProvisionIpamPoolCidr -> Bool # (/=) :: ProvisionIpamPoolCidr -> ProvisionIpamPoolCidr -> Bool #
Hashable ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods hashWithSalt :: Int -> ProvisionIpamPoolCidr -> Int # hash :: ProvisionIpamPoolCidr -> Int #
type AWSResponse ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr type AWSResponse ProvisionIpamPoolCidr = ProvisionIpamPoolCidrResponse
type Rep ProvisionIpamPoolCidr Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr type Rep ProvisionIpamPoolCidr = D1 ('MetaData "ProvisionIpamPoolCidr" "Amazonka.EC2.ProvisionIpamPoolCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ProvisionIpamPoolCidr'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cidrAuthorizationContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamCidrAuthorizationContext))) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ipamPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newProvisionIpamPoolCidr Source #

Arguments

:: Text	`ProvisionIpamPoolCidr`
-> ProvisionIpamPoolCidr

Create a value of ProvisionIpamPoolCidr 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:

ProvisionIpamPoolCidr, provisionIpamPoolCidr_cidr - The CIDR you want to assign to the IPAM pool.

$sel:cidrAuthorizationContext:ProvisionIpamPoolCidr', provisionIpamPoolCidr_cidrAuthorizationContext - A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.

$sel:dryRun:ProvisionIpamPoolCidr', provisionIpamPoolCidr_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.

ProvisionIpamPoolCidr, provisionIpamPoolCidr_ipamPoolId - The ID of the IPAM pool to which you want to assign a CIDR.

Request Lenses

provisionIpamPoolCidr_cidr :: Lens' ProvisionIpamPoolCidr (Maybe Text) Source #

The CIDR you want to assign to the IPAM pool.

provisionIpamPoolCidr_cidrAuthorizationContext :: Lens' ProvisionIpamPoolCidr (Maybe IpamCidrAuthorizationContext) Source #

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.

provisionIpamPoolCidr_dryRun :: Lens' ProvisionIpamPoolCidr (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.

provisionIpamPoolCidr_ipamPoolId :: Lens' ProvisionIpamPoolCidr Text Source #

The ID of the IPAM pool to which you want to assign a CIDR.

Destructuring the Response

data ProvisionIpamPoolCidrResponse Source #

See: newProvisionIpamPoolCidrResponse smart constructor.

Constructors

ProvisionIpamPoolCidrResponse'
Fields ipamPoolCidr :: Maybe IpamPoolCidr Information about the provisioned CIDR. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Associated Types type Rep ProvisionIpamPoolCidrResponse :: Type -> Type # Methods from :: ProvisionIpamPoolCidrResponse -> Rep ProvisionIpamPoolCidrResponse x # to :: Rep ProvisionIpamPoolCidrResponse x -> ProvisionIpamPoolCidrResponse #
Read ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods readsPrec :: Int -> ReadS ProvisionIpamPoolCidrResponse # readList :: ReadS [ProvisionIpamPoolCidrResponse] # readPrec :: ReadPrec ProvisionIpamPoolCidrResponse # readListPrec :: ReadPrec [ProvisionIpamPoolCidrResponse] #
Show ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods showsPrec :: Int -> ProvisionIpamPoolCidrResponse -> ShowS # show :: ProvisionIpamPoolCidrResponse -> String # showList :: [ProvisionIpamPoolCidrResponse] -> ShowS #
NFData ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods rnf :: ProvisionIpamPoolCidrResponse -> () #
Eq ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr Methods (==) :: ProvisionIpamPoolCidrResponse -> ProvisionIpamPoolCidrResponse -> Bool # (/=) :: ProvisionIpamPoolCidrResponse -> ProvisionIpamPoolCidrResponse -> Bool #
type Rep ProvisionIpamPoolCidrResponse Source #
Instance details Defined in Amazonka.EC2.ProvisionIpamPoolCidr type Rep ProvisionIpamPoolCidrResponse = D1 ('MetaData "ProvisionIpamPoolCidrResponse" "Amazonka.EC2.ProvisionIpamPoolCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ProvisionIpamPoolCidrResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamPoolCidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamPoolCidr)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newProvisionIpamPoolCidrResponse Source #

Arguments

:: Int	`$sel:httpStatus:ProvisionIpamPoolCidrResponse'`
-> ProvisionIpamPoolCidrResponse

Create a value of ProvisionIpamPoolCidrResponse 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:ipamPoolCidr:ProvisionIpamPoolCidrResponse', provisionIpamPoolCidrResponse_ipamPoolCidr - Information about the provisioned CIDR.

$sel:httpStatus:ProvisionIpamPoolCidrResponse', provisionIpamPoolCidrResponse_httpStatus - The response's http status code.

Response Lenses

provisionIpamPoolCidrResponse_ipamPoolCidr :: Lens' ProvisionIpamPoolCidrResponse (Maybe IpamPoolCidr) Source #

Information about the provisioned CIDR.

provisionIpamPoolCidrResponse_httpStatus :: Lens' ProvisionIpamPoolCidrResponse Int Source #

The response's http status code.