Modify Ipam

ec2_modify_ipam

R Documentation

Modify the configurations of an IPAM

Description

Modify the configurations of an IPAM.

Usage

ec2_modify_ipam(DryRun, IpamId, Description, AddOperatingRegions,
  RemoveOperatingRegions, Tier, EnablePrivateGua)

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.

IpamId

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

Description

The description of the IPAM you want to modify.

AddOperatingRegions

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

RemoveOperatingRegions

The operating Regions to remove.

Tier

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing \> IPAM tab.

EnablePrivateGua

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Value

A list with the following syntax:

list(
  Ipam = list(
    OwnerId = "string",
    IpamId = "string",
    IpamArn = "string",
    IpamRegion = "string",
    PublicDefaultScopeId = "string",
    PrivateDefaultScopeId = "string",
    ScopeCount = 123,
    Description = "string",
    OperatingRegions = list(
      list(
        RegionName = "string"
      )
    ),
    State = "create-in-progress"|"create-complete"|"create-failed"|"modify-in-progress"|"modify-complete"|"modify-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"isolate-in-progress"|"isolate-complete"|"restore-in-progress",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    DefaultResourceDiscoveryId = "string",
    DefaultResourceDiscoveryAssociationId = "string",
    ResourceDiscoveryAssociationCount = 123,
    StateMessage = "string",
    Tier = "free"|"advanced",
    EnablePrivateGua = TRUE|FALSE
  )
)

Request syntax

svc$modify_ipam(
  DryRun = TRUE|FALSE,
  IpamId = "string",
  Description = "string",
  AddOperatingRegions = list(
    list(
      RegionName = "string"
    )
  ),
  RemoveOperatingRegions = list(
    list(
      RegionName = "string"
    )
  ),
  Tier = "free"|"advanced",
  EnablePrivateGua = TRUE|FALSE
)