Skip to content

Provision Ipam Pool Cidr

ec2_provision_ipam_pool_cidr R Documentation

Provision a CIDR to an IPAM pool

Description

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

Usage

ec2_provision_ipam_pool_cidr(DryRun, IpamPoolId, Cidr,
  CidrAuthorizationContext, NetmaskLength, ClientToken,
  VerificationMethod, IpamExternalResourceVerificationTokenId)

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 to which you want to assign a CIDR.

Cidr

The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.

CidrAuthorizationContext

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

NetmaskLength

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

VerificationMethod

The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

IpamExternalResourceVerificationTokenId

Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

Value

A list with the following syntax: 

list(
  IpamPoolCidr = list(
    Cidr = "string",
    State = "pending-provision"|"provisioned"|"failed-provision"|"pending-deprovision"|"deprovisioned"|"failed-deprovision"|"pending-import"|"failed-import",
    FailureReason = list(
      Code = "cidr-not-available"|"limit-exceeded",
      Message = "string"
    ),
    IpamPoolCidrId = "string",
    NetmaskLength = 123
  )
)

Request syntax

svc$provision_ipam_pool_cidr(
  DryRun = TRUE|FALSE,
  IpamPoolId = "string",
  Cidr = "string",
  CidrAuthorizationContext = list(
    Message = "string",
    Signature = "string"
  ),
  NetmaskLength = 123,
  ClientToken = "string",
  VerificationMethod = "remarks-x509"|"dns-token",
  IpamExternalResourceVerificationTokenId = "string"
)