Modify Ipam Pool

ec2_modify_ipam_pool

R Documentation

Modify the configurations of an IPAM pool

Description

Modify the configurations of an IPAM pool.

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

Usage

ec2_modify_ipam_pool(DryRun, IpamPoolId, Description, AutoImport,
  AllocationMinNetmaskLength, AllocationMaxNetmaskLength,
  AllocationDefaultNetmaskLength, ClearAllocationDefaultNetmaskLength,
  AddAllocationResourceTags, RemoveAllocationResourceTags)

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.

IpamPoolId

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

Description

The description of the IPAM pool you want to modify.

AutoImport

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

AllocationMinNetmaskLength

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

AllocationMaxNetmaskLength

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

AllocationDefaultNetmaskLength

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

ClearAllocationDefaultNetmaskLength

Clear the default netmask length allocation rule for this pool.

AddAllocationResourceTags

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

RemoveAllocationResourceTags

Remove tag allocation rules from a pool.

Value

A list with the following syntax:

list(
  IpamPool = list(
    OwnerId = "string",
    IpamPoolId = "string",
    SourceIpamPoolId = "string",
    IpamPoolArn = "string",
    IpamScopeArn = "string",
    IpamScopeType = "public"|"private",
    IpamArn = "string",
    IpamRegion = "string",
    Locale = "string",
    PoolDepth = 123,
    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",
    StateMessage = "string",
    Description = "string",
    AutoImport = TRUE|FALSE,
    PubliclyAdvertisable = TRUE|FALSE,
    AddressFamily = "ipv4"|"ipv6",
    AllocationMinNetmaskLength = 123,
    AllocationMaxNetmaskLength = 123,
    AllocationDefaultNetmaskLength = 123,
    AllocationResourceTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    AwsService = "ec2",
    PublicIpSource = "amazon"|"byoip",
    SourceResource = list(
      ResourceId = "string",
      ResourceType = "vpc",
      ResourceRegion = "string",
      ResourceOwner = "string"
    )
  )
)

Request syntax

svc$modify_ipam_pool(
  DryRun = TRUE|FALSE,
  IpamPoolId = "string",
  Description = "string",
  AutoImport = TRUE|FALSE,
  AllocationMinNetmaskLength = 123,
  AllocationMaxNetmaskLength = 123,
  AllocationDefaultNetmaskLength = 123,
  ClearAllocationDefaultNetmaskLength = TRUE|FALSE,
  AddAllocationResourceTags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  RemoveAllocationResourceTags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)