Skip to content

EC2  >  Structures  >  IpamResourceCidr

IpamResourceCidr

Structure Class

IpamResourceCidr dataclass

Bases: _SerdeShape

The CIDR for an IPAM resource.

Attributes

availability_zone_id class-attribute instance-attribute
availability_zone_id: str | None = ...

The Availability Zone ID.

compliance_status class-attribute instance-attribute
compliance_status: str | None = ...

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 class-attribute instance-attribute
ip_usage: float | None = ...

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 class-attribute instance-attribute
ipam_id: str | None = ...

The IPAM ID for an IPAM resource.

ipam_pool_id class-attribute instance-attribute
ipam_pool_id: str | None = ...

The pool ID for an IPAM resource.

ipam_scope_id class-attribute instance-attribute
ipam_scope_id: str | None = ...

The scope ID for an IPAM resource.

management_state class-attribute instance-attribute
management_state: str | None = ...

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 class-attribute instance-attribute
overlap_status: str | None = ...

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 class-attribute instance-attribute
resource_cidr: str | None = ...

The CIDR for an IPAM resource.

resource_id class-attribute instance-attribute
resource_id: str | None = ...

The ID of an IPAM resource.

resource_name class-attribute instance-attribute
resource_name: str | None = ...

The name of an IPAM resource.

resource_owner_id class-attribute instance-attribute
resource_owner_id: str | None = ...

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

resource_region class-attribute instance-attribute
resource_region: str | None = ...

The Amazon Web Services Region for an IPAM resource.

resource_tags class-attribute instance-attribute
resource_tags: list[IpamResourceTag] | None = ...

The tags for an IPAM resource.

resource_type class-attribute instance-attribute
resource_type: str | None = ...

The type of IPAM resource.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

The ID of a VPC.