Amazonka.EC2.Types.IpamResourceCidr

Documentation

data IpamResourceCidr

The CIDR for an IPAM resource.

See: newIpamResourceCidr smart constructor.

Constructors

IpamResourceCidr'

Fields

• complianceStatus :: Maybe IpamComplianceStatus

  The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

• ipUsage :: Maybe Double

  The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

  • For a resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
  • For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
  • For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
• ipamId :: Maybe Text

  The IPAM ID for an IPAM resource.

• ipamPoolId :: Maybe Text

  The pool ID for an IPAM resource.

• ipamScopeId :: Maybe Text

  The scope ID for an IPAM resource.

• managementState :: Maybe IpamManagementState

  The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

• overlapStatus :: Maybe IpamOverlapStatus

  The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

• resourceCidr :: Maybe Text

  The CIDR for an IPAM resource.

• resourceId :: Maybe Text

  The ID of an IPAM resource.

• resourceName :: Maybe Text

  The name of an IPAM resource.

• resourceOwnerId :: Maybe Text

  The Amazon Web Services account number of the owner of an IPAM resource.

• resourceRegion :: Maybe Text

  The Amazon Web Services Region for an IPAM resource.

• resourceTags :: Maybe [IpamResourceTag]

  The tags for an IPAM resource.

• resourceType :: Maybe IpamResourceType

  The type of IPAM resource.

• vpcId :: Maybe Text

  The ID of a VPC.

Instances

FromXML IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

parseXML :: [Node] -> Either String IpamResourceCidr

Generic IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Associated Types

type Rep IpamResourceCidr :: Type -> Type

Methods

from :: IpamResourceCidr -> Rep IpamResourceCidr x

to :: Rep IpamResourceCidr x -> IpamResourceCidr

Read IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

readsPrec :: Int -> ReadS IpamResourceCidr

readList :: ReadS [IpamResourceCidr]

readPrec :: ReadPrec IpamResourceCidr

readListPrec :: ReadPrec [IpamResourceCidr]

Show IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

showsPrec :: Int -> IpamResourceCidr -> ShowS

show :: IpamResourceCidr -> String

showList :: [IpamResourceCidr] -> ShowS

NFData IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

rnf :: IpamResourceCidr -> ()

Eq IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

(==) :: IpamResourceCidr -> IpamResourceCidr -> Bool

(/=) :: IpamResourceCidr -> IpamResourceCidr -> Bool

Hashable IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

Methods

hashWithSalt :: Int -> IpamResourceCidr -> Int

hash :: IpamResourceCidr -> Int

type Rep IpamResourceCidr

Defined in Amazonka.EC2.Types.IpamResourceCidr

type Rep IpamResourceCidr = D1 ('MetaData "IpamResourceCidr" "Amazonka.EC2.Types.IpamResourceCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "IpamResourceCidr'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "complianceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamComplianceStatus)) :*: (S1 ('MetaSel ('Just "ipUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "ipamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "ipamPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ipamScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "managementState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamManagementState)) :*: S1 ('MetaSel ('Just "overlapStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamOverlapStatus))))) :*: (((S1 ('MetaSel ('Just "resourceCidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceOwnerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resourceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamResourceTag]))) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamResourceType)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newIpamResourceCidr :: IpamResourceCidr

Create a value of IpamResourceCidr 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:complianceStatus:IpamResourceCidr', ipamResourceCidr_complianceStatus - The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

$sel:ipUsage:IpamResourceCidr', ipamResourceCidr_ipUsage - The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

• For a resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
• For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
• For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).

$sel:ipamId:IpamResourceCidr', ipamResourceCidr_ipamId - The IPAM ID for an IPAM resource.

$sel:ipamPoolId:IpamResourceCidr', ipamResourceCidr_ipamPoolId - The pool ID for an IPAM resource.

$sel:ipamScopeId:IpamResourceCidr', ipamResourceCidr_ipamScopeId - The scope ID for an IPAM resource.

$sel:managementState:IpamResourceCidr', ipamResourceCidr_managementState - The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

$sel:overlapStatus:IpamResourceCidr', ipamResourceCidr_overlapStatus - The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

$sel:resourceCidr:IpamResourceCidr', ipamResourceCidr_resourceCidr - The CIDR for an IPAM resource.

$sel:resourceId:IpamResourceCidr', ipamResourceCidr_resourceId - The ID of an IPAM resource.

$sel:resourceName:IpamResourceCidr', ipamResourceCidr_resourceName - The name of an IPAM resource.

$sel:resourceOwnerId:IpamResourceCidr', ipamResourceCidr_resourceOwnerId - The Amazon Web Services account number of the owner of an IPAM resource.

$sel:resourceRegion:IpamResourceCidr', ipamResourceCidr_resourceRegion - The Amazon Web Services Region for an IPAM resource.

$sel:resourceTags:IpamResourceCidr', ipamResourceCidr_resourceTags - The tags for an IPAM resource.

$sel:resourceType:IpamResourceCidr', ipamResourceCidr_resourceType - The type of IPAM resource.

$sel:vpcId:IpamResourceCidr', ipamResourceCidr_vpcId - The ID of a VPC.

ipamResourceCidr_complianceStatus :: Lens' IpamResourceCidr (Maybe IpamComplianceStatus)

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

ipamResourceCidr_ipUsage :: Lens' IpamResourceCidr (Maybe Double)

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

• For a resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
• For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
• For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).

ipamResourceCidr_ipamId :: Lens' IpamResourceCidr (Maybe Text)

The IPAM ID for an IPAM resource.

ipamResourceCidr_ipamPoolId :: Lens' IpamResourceCidr (Maybe Text)

The pool ID for an IPAM resource.

ipamResourceCidr_ipamScopeId :: Lens' IpamResourceCidr (Maybe Text)

The scope ID for an IPAM resource.

ipamResourceCidr_managementState :: Lens' IpamResourceCidr (Maybe IpamManagementState)

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

ipamResourceCidr_overlapStatus :: Lens' IpamResourceCidr (Maybe IpamOverlapStatus)

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

ipamResourceCidr_resourceCidr :: Lens' IpamResourceCidr (Maybe Text)

The CIDR for an IPAM resource.

ipamResourceCidr_resourceId :: Lens' IpamResourceCidr (Maybe Text)

The ID of an IPAM resource.

ipamResourceCidr_resourceName :: Lens' IpamResourceCidr (Maybe Text)

The name of an IPAM resource.

ipamResourceCidr_resourceOwnerId :: Lens' IpamResourceCidr (Maybe Text)

The Amazon Web Services account number of the owner of an IPAM resource.

ipamResourceCidr_resourceRegion :: Lens' IpamResourceCidr (Maybe Text)

The Amazon Web Services Region for an IPAM resource.

ipamResourceCidr_resourceTags :: Lens' IpamResourceCidr (Maybe [IpamResourceTag])

The tags for an IPAM resource.

ipamResourceCidr_resourceType :: Lens' IpamResourceCidr (Maybe IpamResourceType)

The type of IPAM resource.

ipamResourceCidr_vpcId :: Lens' IpamResourceCidr (Maybe Text)

The ID of a VPC.