Skip to content

ModifyIpamRequest

Source code in docs_src/capo_ec2/types/modify_ipam_request.py
class ModifyIpamRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    ipam_id: NotRequired["capo_ec2.types.ipam_id.IpamId"]
    """<p>The ID of the IPAM you want to modify.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The description of the IPAM you want to modify.</p>"""
    add_operating_regions: NotRequired[
        "capo_ec2.types.add_ipam_operating_region_set.AddIpamOperatingRegionSet"
    ]
    """<p>Choose the operating Regions for the 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>"""
    remove_operating_regions: NotRequired[
        "capo_ec2.types.remove_ipam_operating_region_set.RemoveIpamOperatingRegionSet"
    ]
    """<p>The operating Regions to remove.</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>"""

add_operating_regions instance-attribute

add_operating_regions: NotRequired[AddIpamOperatingRegionSet]

Choose the operating Regions for the 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.

description instance-attribute

description: NotRequired[String]

The description of the IPAM you want to modify.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

ipam_id: NotRequired[IpamId]

The ID of the IPAM you want to modify.

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.

remove_operating_regions instance-attribute

remove_operating_regions: NotRequired[RemoveIpamOperatingRegionSet]

The operating Regions to remove.

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.