Skip to content

/AWS1/IF_EC2=>PROVISIONIPAMPOOLCIDR()

About ProvisionIpamPoolCidr

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.

Method Signature

METHODS /AWS1/IF_EC2~PROVISIONIPAMPOOLCIDR
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMPOOLID TYPE /AWS1/EC2IPAMPOOLID OPTIONAL
    !IV_CIDR TYPE /AWS1/EC2STRING OPTIONAL
    !IO_CIDRAUTHORIZATIONCONTEXT TYPE REF TO /AWS1/CL_EC2IPAMCIDRAUTHCTX OPTIONAL
    !IV_NETMASKLENGTH TYPE /AWS1/EC2INTEGER OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_VERIFICATIONMETHOD TYPE /AWS1/EC2VERIFICATIONMETHOD OPTIONAL
    !IV_IPAMEXTERNALRESRCVERIFI00 TYPE /AWS1/EC2IPAMEXTERNALRESRCVE00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2provisionipampoo01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipampoolid TYPE /AWS1/EC2IPAMPOOLID /AWS1/EC2IPAMPOOLID

The ID of the IPAM pool to which you want to assign a CIDR.

Optional arguments:

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

iv_cidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

io_cidrauthorizationcontext TYPE REF TO /AWS1/CL_EC2IPAMCIDRAUTHCTX /AWS1/CL_EC2IPAMCIDRAUTHCTX

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.

iv_netmasklength TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

iv_verificationmethod TYPE /AWS1/EC2VERIFICATIONMETHOD /AWS1/EC2VERIFICATIONMETHOD

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.

iv_ipamexternalresrcverifi00 TYPE /AWS1/EC2IPAMEXTERNALRESRCVE00 /AWS1/EC2IPAMEXTERNALRESRCVE00

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

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2provisionipampoo01 /AWS1/CL_EC2PROVISIONIPAMPOO01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->provisionipampoolcidr(
  io_cidrauthorizationcontext = new /aws1/cl_ec2ipamcidrauthctx(
    iv_message = |string|
    iv_signature = |string|
  )
  iv_cidr = |string|
  iv_clienttoken = |string|
  iv_dryrun = ABAP_TRUE
  iv_ipamexternalresrcverifi00 = |string|
  iv_ipampoolid = |string|
  iv_netmasklength = 123
  iv_verificationmethod = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipampoolcidr = lo_result->get_ipampoolcidr( ).
  IF lo_ipampoolcidr IS NOT INITIAL.
    lv_string = lo_ipampoolcidr->get_cidr( ).
    lv_ipampoolcidrstate = lo_ipampoolcidr->get_state( ).
    lo_ipampoolcidrfailurereas = lo_ipampoolcidr->get_failurereason( ).
    IF lo_ipampoolcidrfailurereas IS NOT INITIAL.
      lv_ipampoolcidrfailurecode = lo_ipampoolcidrfailurereas->get_code( ).
      lv_string = lo_ipampoolcidrfailurereas->get_message( ).
    ENDIF.
    lv_ipampoolcidrid = lo_ipampoolcidr->get_ipampoolcidrid( ).
    lv_integer = lo_ipampoolcidr->get_netmasklength( ).
  ENDIF.
ENDIF.