Skip to content

/AWS1/IF_EC2=>GETIPAMPOLICYALLOCATIONRULES()

About GetIpamPolicyAllocationRules

Gets the allocation rules for an IPAM policy.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

Method Signature

METHODS /AWS1/IF_EC2~GETIPAMPOLICYALLOCATIONRULES
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMPOLICYID TYPE /AWS1/EC2IPAMPOLICYID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_LOCALE TYPE /AWS1/EC2STRING OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/EC2IPAMPOLICYRESTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2IPAMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2getipamplyallocr01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipampolicyid TYPE /AWS1/EC2IPAMPOLICYID /AWS1/EC2IPAMPOLICYID

The ID of the IPAM policy for which to get allocation rules.

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.

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

One or more filters for the allocation rules.

iv_locale TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The locale for which to get the allocation rules.

iv_resourcetype TYPE /AWS1/EC2IPAMPOLICYRESTYPE /AWS1/EC2IPAMPOLICYRESTYPE

The resource type for which to get the allocation rules.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

  • Elastic IP addresses

iv_maxresults TYPE /AWS1/EC2IPAMMAXRESULTS /AWS1/EC2IPAMMAXRESULTS

The maximum number of results to return in a single call.

iv_nexttoken TYPE /AWS1/EC2NEXTTOKEN /AWS1/EC2NEXTTOKEN

The token for the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2getipamplyallocr01 /AWS1/CL_EC2GETIPAMPLYALLOCR01

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->getipampolicyallocationrules(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_ipampolicyid = |string|
  iv_locale = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_ipampolicydocuments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_ipampolicyid = lo_row_1->get_ipampolicyid( ).
      lv_string = lo_row_1->get_locale( ).
      lv_ipampolicyresourcetype = lo_row_1->get_resourcetype( ).
      LOOP AT lo_row_1->get_allocationrules( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_ipampoolid = lo_row_3->get_sourceipampoolid( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.