Skip to content

Ipam

Source code in docs_src/capo_ec2/types/ipam.py
class Ipam(TypedDict, closed=True):
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services account ID of the owner of the IPAM.</p>"""
    ipam_id: NotRequired["capo_ec2.types.ipam_id.IpamId"]
    """<p>The ID of the IPAM.</p>"""
    ipam_arn: NotRequired["capo_ec2.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the IPAM.</p>"""
    ipam_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services Region of the IPAM.</p>"""
    public_default_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The ID of the IPAM's default public scope.</p>"""
    private_default_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The ID of the IPAM's default private scope.</p>"""
    scope_count: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html">Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The description for the IPAM.</p>"""
    operating_regions: NotRequired[
        "capo_ec2.types.ipam_operating_region_set.IpamOperatingRegionSet"
    ]
    """<p>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.</p> <p>For more information about operating Regions, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"""
    state: NotRequired["capo_ec2.types.ipam_state.IpamState"]
    """<p>The state of the IPAM.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>"""
    default_resource_discovery_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ]
    """<p>The IPAM's default resource discovery ID.</p>"""
    default_resource_discovery_association_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_association_id.IpamResourceDiscoveryAssociationId"
    ]
    """<p>The IPAM's default resource discovery association ID.</p>"""
    resource_discovery_association_count: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The IPAM's resource discovery association count.</p>"""
    state_message: NotRequired["capo_ec2.types.string.String"]
    """<p>The state message.</p>"""
    tier: NotRequired["capo_ec2.types.ipam_tier.IpamTier"]
    """<p>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 <a href="http://aws.amazon.com/vpc/pricing/">Amazon VPC pricing > IPAM tab</a>.</p>"""
    enable_private_gua: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.</p>"""
    metered_account: NotRequired[
        "capo_ec2.types.ipam_metered_account.IpamMeteredAccount"
    ]
    """<p>A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html">Enable cost distribution</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> <p>Possible values:</p> <ul> <li> <p> <code>ipam-owner</code> (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.</p> </li> <li> <p> <code>resource-owner</code>: The Amazon Web Services account that owns the IP address is charged for the active IP address.</p> </li> </ul>"""

default_resource_discovery_association_id instance-attribute

default_resource_discovery_association_id: NotRequired[
    IpamResourceDiscoveryAssociationId
]

The IPAM's default resource discovery association ID.

default_resource_discovery_id instance-attribute

default_resource_discovery_id: NotRequired[IpamResourceDiscoveryId]

The IPAM's default resource discovery ID.

description instance-attribute

description: NotRequired[String]

The description for the IPAM.

enable_private_gua instance-attribute

enable_private_gua: NotRequired[Boolean]

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

ipam_arn instance-attribute

ipam_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the IPAM.

ipam_id instance-attribute

ipam_id: NotRequired[IpamId]

The ID of the IPAM.

ipam_region instance-attribute

ipam_region: NotRequired[String]

The Amazon Web Services Region of the IPAM.

metered_account instance-attribute

metered_account: NotRequired[IpamMeteredAccount]

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 instance-attribute

operating_regions: NotRequired[IpamOperatingRegionSet]

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 instance-attribute

owner_id: NotRequired[String]

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

private_default_scope_id instance-attribute

private_default_scope_id: NotRequired[IpamScopeId]

The ID of the IPAM's default private scope.

public_default_scope_id instance-attribute

public_default_scope_id: NotRequired[IpamScopeId]

The ID of the IPAM's default public scope.

resource_discovery_association_count instance-attribute

resource_discovery_association_count: NotRequired[Integer]

The IPAM's resource discovery association count.

scope_count instance-attribute

scope_count: NotRequired[Integer]

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 instance-attribute

state: NotRequired[IpamState]

The state of the IPAM.

state_message instance-attribute

state_message: NotRequired[String]

The state message.

tags instance-attribute

tags: NotRequired[TagList]

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 instance-attribute

tier: NotRequired[IpamTier]

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.