Skip to content

EC2  >  Operations  >  modify_ipam_resource_cidr

modify_ipam_resource_cidr

Operation

modify_ipam_resource_cidr async

modify_ipam_resource_cidr(request: ModifyIpamResourceCidrInput | ModifyIpamResourceCidrInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyIpamResourceCidrOutput
modify_ipam_resource_cidr(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamResourceCidrInputDict]) -> ModifyIpamResourceCidrOutput

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyIpamResourceCidrOutput

An instance of ModifyIpamResourceCidrOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyIpamResourceCidrInput dataclass

Bases: _SerdeShape

Dataclass for ModifyIpamResourceCidrInput structure.

Attributes
current_ipam_scope_id class-attribute instance-attribute
current_ipam_scope_id: str | None = ...

The ID of the current scope that the resource CIDR is in.

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

The ID of the scope you want to transfer the resource CIDR to.

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

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.

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

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource's CIDR.

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

The CIDR of the resource you want to modify.

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

The ID of the resource you want to modify.

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

The Amazon Web Services Region of the resource you want to modify.

Dictionaries

ModifyIpamResourceCidrInputDict

Bases: TypedDict

Dictionary form of ModifyIpamResourceCidrInput.

Attributes
current_ipam_scope_id instance-attribute
current_ipam_scope_id: Required[str]

The ID of the current scope that the resource CIDR is in.

destination_ipam_scope_id instance-attribute
destination_ipam_scope_id: str | None

The ID of the scope you want to transfer the resource CIDR to.

dry_run instance-attribute
dry_run: bool | None

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.

monitored instance-attribute
monitored: Required[bool]

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource's CIDR.

resource_cidr instance-attribute
resource_cidr: Required[str]

The CIDR of the resource you want to modify.

resource_id instance-attribute
resource_id: Required[str]

The ID of the resource you want to modify.

resource_region instance-attribute
resource_region: Required[str]

The Amazon Web Services Region of the resource you want to modify.

Output

ModifyIpamResourceCidrOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyIpamResourceCidrOutput structure.

Attributes

ipam_resource_cidr class-attribute instance-attribute
ipam_resource_cidr: IpamResourceCidr | None = ...

The CIDR of the resource.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.