Skip to content

IpamPolicyDocument

Source code in docs_src/capo_ec2/types/ipam_policy_document.py
class IpamPolicyDocument(TypedDict, closed=True):
    ipam_policy_id: NotRequired["capo_ec2.types.ipam_policy_id.IpamPolicyId"]
    """<p>The ID of the IPAM policy.</p>"""
    locale: NotRequired["capo_ec2.types.string.String"]
    """<p>The locale of the IPAM policy document.</p>"""
    resource_type: NotRequired[
        "capo_ec2.types.ipam_policy_resource_type.IpamPolicyResourceType"
    ]
    """<p>The resource type of the IPAM policy document.</p> <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p> <ul> <li> <p>Elastic IP addresses</p> </li> </ul>"""
    allocation_rules: NotRequired[
        "capo_ec2.types.ipam_policy_allocation_rule_list.IpamPolicyAllocationRuleList"
    ]
    """<p>The allocation rules in the IPAM policy document.</p> <p>Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.</p>"""

allocation_rules instance-attribute

allocation_rules: NotRequired[IpamPolicyAllocationRuleList]

The allocation rules in the IPAM policy document.

Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

ipam_policy_id instance-attribute

ipam_policy_id: NotRequired[IpamPolicyId]

The ID of the IPAM policy.

locale instance-attribute

locale: NotRequired[String]

The locale of the IPAM policy document.

resource_type instance-attribute

resource_type: NotRequired[IpamPolicyResourceType]

The resource type of the IPAM policy document.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

  • Elastic IP addresses