Skip to content

EC2  >  Structures  >  IpamPolicyDocument

IpamPolicyDocument

Structure Class

IpamPolicyDocument dataclass

Bases: _SerdeShape

Information about an IPAM policy.

Attributes

allocation_rules class-attribute instance-attribute
allocation_rules: list[IpamPolicyAllocationRule] | None = ...

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

The ID of the IPAM policy.

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

The locale of the IPAM policy document.

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

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