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

Description

Modify the configurations of an IPAM pool.

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

Synopsis

Creating a Request

data ModifyIpamPool Source #

See: newModifyIpamPool smart constructor.

Constructors

ModifyIpamPool' 

Fields

  • addAllocationResourceTags :: Maybe [RequestIpamResourceTag]

    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.

  • allocationDefaultNetmaskLength :: Maybe Natural

    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.

  • allocationMaxNetmaskLength :: Maybe Natural

    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.

  • allocationMinNetmaskLength :: Maybe Natural

    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.

  • autoImport :: Maybe Bool

    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.

  • clearAllocationDefaultNetmaskLength :: Maybe Bool

    Clear the default netmask length allocation rule for this pool.

  • description :: Maybe Text

    The description of the IPAM pool you want to modify.

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

  • removeAllocationResourceTags :: Maybe [RequestIpamResourceTag]

    Remove tag allocation rules from a pool.

  • ipamPoolId :: Text

    The ID of the IPAM pool you want to modify.

Instances

Instances details
ToHeaders ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

ToPath ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

ToQuery ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

AWSRequest ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Associated Types

type AWSResponse ModifyIpamPool #

Generic ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Associated Types

type Rep ModifyIpamPool :: Type -> Type #

Read ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Show ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

NFData ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Methods

rnf :: ModifyIpamPool -> () #

Eq ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Hashable ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

type AWSResponse ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

type Rep ModifyIpamPool Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

type Rep ModifyIpamPool = D1 ('MetaData "ModifyIpamPool" "Amazonka.EC2.ModifyIpamPool" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyIpamPool'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addAllocationResourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequestIpamResourceTag])) :*: S1 ('MetaSel ('Just "allocationDefaultNetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "allocationMaxNetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "allocationMinNetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "autoImport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "clearAllocationDefaultNetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "removeAllocationResourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequestIpamResourceTag])) :*: S1 ('MetaSel ('Just "ipamPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyIpamPool Source #

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

Constructors

ModifyIpamPoolResponse' 

Fields

Instances

Instances details
Generic ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Associated Types

type Rep ModifyIpamPoolResponse :: Type -> Type #

Read ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Show ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

NFData ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

Methods

rnf :: ModifyIpamPoolResponse -> () #

Eq ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

type Rep ModifyIpamPoolResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpamPool

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

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