Modifies the description of an IPAM pool allocation¶

Description¶

Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.

Usage¶

ec2_modify_ipam_pool_allocation(DryRun, IpamPoolAllocationId,
  Description)

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.

• IpamPoolAllocationId

  [required] The ID of the IPAM pool allocation you want to modify.

• Description

  The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.

Value¶

A list with the following syntax:

list(
  IpamPoolAllocation = list(
    Cidr = "string",
    IpamPoolAllocationId = "string",
    Description = "string",
    ResourceId = "string",
    ResourceType = "ipam-pool"|"vpc"|"ec2-public-ipv4-pool"|"custom"|"subnet"|"eip"|"anycast-ip-list",
    ResourceRegion = "string",
    ResourceOwner = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax¶

svc$modify_ipam_pool_allocation(
  DryRun = TRUE|FALSE,
  IpamPoolAllocationId = "string",
  Description = "string"
)