Skip to content

IpamPoolCidr

Source code in docs_src/capo_ec2/types/ipam_pool_cidr.py
class IpamPoolCidr(TypedDict, closed=True):
    cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is <code>10.24.34.0/23</code>. An IPv6 CIDR example is <code>2001:DB8::/32</code>.</p>"""
    state: NotRequired["capo_ec2.types.ipam_pool_cidr_state.IpamPoolCidrState"]
    """<p>The state of the CIDR.</p>"""
    failure_reason: NotRequired[
        "capo_ec2.types.ipam_pool_cidr_failure_reason.IpamPoolCidrFailureReason"
    ]
    """<p>Details related to why an IPAM pool CIDR failed to be provisioned.</p>"""
    ipam_pool_cidr_id: NotRequired["capo_ec2.types.ipam_pool_cidr_id.IpamPoolCidrId"]
    """<p>The IPAM pool CIDR ID.</p>"""
    netmask_length: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.</p>"""

cidr instance-attribute

cidr: NotRequired[String]

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

failure_reason instance-attribute

failure_reason: NotRequired[IpamPoolCidrFailureReason]

Details related to why an IPAM pool CIDR failed to be provisioned.

ipam_pool_cidr_id instance-attribute

ipam_pool_cidr_id: NotRequired[IpamPoolCidrId]

The IPAM pool CIDR ID.

netmask_length instance-attribute

netmask_length: NotRequired[Integer]

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

state instance-attribute

state: NotRequired[IpamPoolCidrState]

The state of the CIDR.