Skip to content

EC2  >  Structures  >  Ipam

Ipam

Structure Class

Ipam dataclass

Bases: _SerdeShape

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Attributes

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

The IPAM's default resource discovery association ID.

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

The IPAM's default resource discovery ID.

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

The description for the IPAM.

enable_private_gua class-attribute instance-attribute
enable_private_gua: bool | None = ...

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

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

The Amazon Resource Name (ARN) of the IPAM.

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

The ID of the IPAM.

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

The Amazon Web Services Region of the IPAM.

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

A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.

Possible values:

  • ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.

  • resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.

operating_regions class-attribute instance-attribute
operating_regions: list[IpamOperatingRegion] | None = ...

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

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

The Amazon Web Services account ID of the owner of the IPAM.

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

The ID of the IPAM's default private scope.

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

The ID of the IPAM's default public scope.

resource_discovery_association_count class-attribute instance-attribute
resource_discovery_association_count: int | None = ...

The IPAM's resource discovery association count.

scope_count class-attribute instance-attribute
scope_count: int | None = ...

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

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

The state of the IPAM.

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

The state message.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.