Skip to content

/AWS1/IF_EC2=>CREIPAMPREFIXLISTRESOLVTGT()

About CreateIpamPrefixListResolverTarget

Creates an IPAM prefix list resolver target.

An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources.

For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.

Method Signature

METHODS /AWS1/IF_EC2~CREIPAMPREFIXLISTRESOLVTGT
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMPREFIXLISTRESOLVERID TYPE /AWS1/EC2IPAMPREFIXLSTRESOLVID OPTIONAL
    !IV_PREFIXLISTID TYPE /AWS1/EC2STRING OPTIONAL
    !IV_PREFIXLISTREGION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DESIREDVERSION TYPE /AWS1/EC2BOXEDLONG OPTIONAL
    !IV_TRACKLATESTVERSION TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2creipamprefixlst03
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipamprefixlistresolverid TYPE /AWS1/EC2IPAMPREFIXLSTRESOLVID /AWS1/EC2IPAMPREFIXLSTRESOLVID

The ID of the IPAM prefix list resolver that will manage the synchronization of CIDRs to the target prefix list.

iv_prefixlistid TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The ID of the managed prefix list that will be synchronized with CIDRs selected by the IPAM prefix list resolver. This prefix list becomes an IPAM managed prefix list.

An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver's CIDR selection rules, and direct CIDR modifications are restricted.

iv_prefixlistregion TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.

iv_tracklatestversion TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version of the prefix list.

Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.

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_desiredversion TYPE /AWS1/EC2BOXEDLONG /AWS1/EC2BOXEDLONG

The specific version of the prefix list to target. If not specified, the resolver will target the latest version.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the IPAM prefix list resolver target during creation. Tags help you organize and manage your Amazon Web Services resources.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2creipamprefixlst03 /AWS1/CL_EC2CREIPAMPREFIXLST03

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->creipamprefixlistresolvtgt(
  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_desiredversion = 123
  iv_dryrun = ABAP_TRUE
  iv_ipamprefixlistresolverid = |string|
  iv_prefixlistid = |string|
  iv_prefixlistregion = |string|
  iv_tracklatestversion = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipamprefixlistresolvert = lo_result->get_ipamprefixlistresolvtgt( ).
  IF lo_ipamprefixlistresolvert IS NOT INITIAL.
    lv_ipamprefixlistresolvert_1 = lo_ipamprefixlistresolvert->get_ipamprefixlstresolvtgtid( ).
    lv_resourcearn = lo_ipamprefixlistresolvert->get_ipamprefixlstresolvtgt00( ).
    lv_ipamprefixlistresolveri = lo_ipamprefixlistresolvert->get_ipamprefixlistresolverid( ).
    lv_string = lo_ipamprefixlistresolvert->get_ownerid( ).
    lv_prefixlistresourceid = lo_ipamprefixlistresolvert->get_prefixlistid( ).
    lv_string = lo_ipamprefixlistresolvert->get_prefixlistregion( ).
    lv_boxedlong = lo_ipamprefixlistresolvert->get_desiredversion( ).
    lv_boxedlong = lo_ipamprefixlistresolvert->get_lastsyncedversion( ).
    lv_boolean = lo_ipamprefixlistresolvert->get_tracklatestversion( ).
    lv_string = lo_ipamprefixlistresolvert->get_statemessage( ).
    lv_ipamprefixlistresolvert_2 = lo_ipamprefixlistresolvert->get_state( ).
    LOOP AT lo_ipamprefixlistresolvert->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.
  ENDIF.
ENDIF.