Modify Ipam Resource Cidr

ec2_modify_ipam_resource_cidr

R Documentation

Modify a resource CIDR

Description

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.

Usage

ec2_modify_ipam_resource_cidr(DryRun, ResourceId, ResourceCidr,
  ResourceRegion, CurrentIpamScopeId, DestinationIpamScopeId, Monitored)

Arguments

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.

ResourceId

[required] The ID of the resource you want to modify.

ResourceCidr

[required] The CIDR of the resource you want to modify.

ResourceRegion

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

CurrentIpamScopeId

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

DestinationIpamScopeId

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

Monitored

[required] 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.

Value

A list with the following syntax:

list(
  IpamResourceCidr = list(
    IpamId = "string",
    IpamScopeId = "string",
    IpamPoolId = "string",
    ResourceRegion = "string",
    ResourceOwnerId = "string",
    ResourceId = "string",
    ResourceName = "string",
    ResourceCidr = "string",
    ResourceType = "vpc"|"subnet"|"eip"|"public-ipv4-pool"|"ipv6-pool"|"eni",
    ResourceTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    IpUsage = 123.0,
    ComplianceStatus = "compliant"|"noncompliant"|"unmanaged"|"ignored",
    ManagementState = "managed"|"unmanaged"|"ignored",
    OverlapStatus = "overlapping"|"nonoverlapping"|"ignored",
    VpcId = "string",
    AvailabilityZoneId = "string"
  )
)

Request syntax

svc$modify_ipam_resource_cidr(
  DryRun = TRUE|FALSE,
  ResourceId = "string",
  ResourceCidr = "string",
  ResourceRegion = "string",
  CurrentIpamScopeId = "string",
  DestinationIpamScopeId = "string",
  Monitored = TRUE|FALSE
)