Skip to content

ModifyIpamScopeRequest

Source code in docs_src/capo_ec2/types/modify_ipam_scope_request.py
class ModifyIpamScopeRequest(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_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The ID of the scope you want to modify.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The description of the scope you want to modify.</p>"""
    external_authority_configuration: NotRequired[
        "capo_ec2.types.external_authority_configuration.ExternalAuthorityConfiguration"
    ]
    """<p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p> <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p>"""
    remove_external_authority_configuration: NotRequired[
        "capo_ec2.types.boolean.Boolean"
    ]
    """<p>Remove the external authority configuration. <code>true</code> to remove.</p>"""

description instance-attribute

description: NotRequired[String]

The description of the scope 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.

external_authority_configuration instance-attribute

external_authority_configuration: NotRequired[ExternalAuthorityConfiguration]

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

ipam_scope_id instance-attribute

ipam_scope_id: NotRequired[IpamScopeId]

The ID of the scope you want to modify.

remove_external_authority_configuration instance-attribute

remove_external_authority_configuration: NotRequired[Boolean]

Remove the external authority configuration. true to remove.