CREATEIPAMPOLICY()`¶

About CreateIpamPolicy¶

Creates 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.

For more information, see Define public IPv4 allocation strategy with IPAM policies in the Amazon VPC IPAM User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~CREATEIPAMPOLICY
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_IPAMID TYPE /AWS1/EC2IPAMID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2createipamplyrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_ipamid` `TYPE /AWS1/EC2IPAMID` `/AWS1/EC2IPAMID`¶

The ID of the IPAM for which you're creating the policy.

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_tagspecifications` `TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST` `TT_TAGSPECIFICATIONLIST`¶

The tags to assign to the IPAM policy.

`iv_clienttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

A unique, case-sensitive identifier to ensure the idempotency of the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2createipamplyrslt` `/AWS1/CL_EC2CREATEIPAMPLYRSLT`¶

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->createipampolicy(
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_dryrun = ABAP_TRUE
  iv_ipamid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipampolicy = lo_result->get_ipampolicy( ).
  IF lo_ipampolicy IS NOT INITIAL.
    lv_string = lo_ipampolicy->get_ownerid( ).
    lv_ipampolicyid = lo_ipampolicy->get_ipampolicyid( ).
    lv_resourcearn = lo_ipampolicy->get_ipampolicyarn( ).
    lv_string = lo_ipampolicy->get_ipampolicyregion( ).
    lv_ipampolicystate = lo_ipampolicy->get_state( ).
    lv_string = lo_ipampolicy->get_statemessage( ).
    LOOP AT lo_ipampolicy->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_key( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_ipamid = lo_ipampolicy->get_ipamid( ).
  ENDIF.
ENDIF.

/AWS1/IF_EC2=>CREATEIPAMPOLICY()¶