Skip to content

IpamResourceCidr

Source code in docs_src/capo_ec2/types/ipam_resource_cidr.py
class IpamResourceCidr(TypedDict, closed=True):
    ipam_id: NotRequired["capo_ec2.types.ipam_id.IpamId"]
    """<p>The IPAM ID for an IPAM resource.</p>"""
    ipam_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The scope ID for an IPAM resource.</p>"""
    ipam_pool_id: NotRequired["capo_ec2.types.ipam_pool_id.IpamPoolId"]
    """<p>The pool ID for an IPAM resource.</p>"""
    resource_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services Region for an IPAM resource.</p>"""
    resource_owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services account number of the owner of an IPAM resource.</p>"""
    resource_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of an IPAM resource.</p>"""
    resource_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of an IPAM resource.</p>"""
    resource_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The CIDR for an IPAM resource.</p>"""
    resource_type: NotRequired["capo_ec2.types.ipam_resource_type.IpamResourceType"]
    """<p>The type of IPAM resource.</p>"""
    resource_tags: NotRequired[
        "capo_ec2.types.ipam_resource_tag_list.IpamResourceTagList"
    ]
    """<p>The tags for an IPAM resource.</p>"""
    ip_usage: NotRequired["capo_ec2.types.boxed_double.BoxedDouble"]
    """<p>The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:</p> <ul> <li> <p>For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. </p> </li> <li> <p>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. </p> </li> <li> <p>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). </p> </li> </ul>"""
    compliance_status: NotRequired[
        "capo_ec2.types.ipam_compliance_status.IpamComplianceStatus"
    ]
    """<p>The compliance status of the IPAM resource. For more information on compliance statuses, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"""
    management_state: NotRequired[
        "capo_ec2.types.ipam_management_state.IpamManagementState"
    ]
    """<p>The management state of the resource. For more information about management states, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"""
    overlap_status: NotRequired["capo_ec2.types.ipam_overlap_status.IpamOverlapStatus"]
    """<p>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 <a href="https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"""
    vpc_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a VPC.</p>"""
    availability_zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Availability Zone ID.</p>"""

availability_zone_id instance-attribute

availability_zone_id: NotRequired[String]

The Availability Zone ID.

compliance_status instance-attribute

compliance_status: NotRequired[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.

ip_usage instance-attribute

ip_usage: NotRequired[BoxedDouble]

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

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

ipam_id instance-attribute

ipam_id: NotRequired[IpamId]

The IPAM ID for an IPAM resource.

ipam_pool_id instance-attribute

ipam_pool_id: NotRequired[IpamPoolId]

The pool ID for an IPAM resource.

ipam_scope_id instance-attribute

ipam_scope_id: NotRequired[IpamScopeId]

The scope ID for an IPAM resource.

management_state instance-attribute

management_state: NotRequired[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.

overlap_status instance-attribute

overlap_status: NotRequired[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.

resource_cidr instance-attribute

resource_cidr: NotRequired[String]

The CIDR for an IPAM resource.

resource_id instance-attribute

resource_id: NotRequired[String]

The ID of an IPAM resource.

resource_name instance-attribute

resource_name: NotRequired[String]

The name of an IPAM resource.

resource_owner_id instance-attribute

resource_owner_id: NotRequired[String]

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

resource_region instance-attribute

resource_region: NotRequired[String]

The Amazon Web Services Region for an IPAM resource.

resource_tags instance-attribute

resource_tags: NotRequired[IpamResourceTagList]

The tags for an IPAM resource.

resource_type instance-attribute

resource_type: NotRequired[IpamResourceType]

The type of IPAM resource.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of a VPC.