ModifyIpamResourceCidr - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ModifyIpamResourceCidr

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

CurrentIpamScopeId

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

Type: String

Required: Yes

DestinationIpamScopeId

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

Type: String

Required: No

DryRun

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.

Type: Boolean

Required: No

Monitored

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.

Type: Boolean

Required: Yes

ResourceCidr

The CIDR of the resource you want to modify.

Type: String

Required: Yes

ResourceId

The ID of the resource you want to modify.

Type: String

Required: Yes

ResourceRegion

The Amazon Region of the resource you want to modify.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

ipamResourceCidr

The CIDR of the resource.

Type: IpamResourceCidr object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: