Skip to content

/AWS1/IF_EC2=>MODIFYIPAMSCOPE()

About ModifyIpamScope

Modify an IPAM scope.

Method Signature

METHODS /AWS1/IF_EC2~MODIFYIPAMSCOPE
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMSCOPEID TYPE /AWS1/EC2IPAMSCOPEID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IO_EXTERNALAUTHORITYCONF TYPE REF TO /AWS1/CL_EC2EXTERNALAUTHORIT00 OPTIONAL
    !IV_REMEXTERNALAUTHORITYCONF TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2mdfyipamscoperslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipamscopeid TYPE /AWS1/EC2IPAMSCOPEID /AWS1/EC2IPAMSCOPEID

The ID of the scope you want to modify.

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_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The description of the scope you want to modify.

io_externalauthorityconf TYPE REF TO /AWS1/CL_EC2EXTERNALAUTHORIT00 /AWS1/CL_EC2EXTERNALAUTHORIT00

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

iv_remexternalauthorityconf TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Remove the external authority configuration. true to remove.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2mdfyipamscoperslt /AWS1/CL_EC2MDFYIPAMSCOPERSLT

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->modifyipamscope(
  io_externalauthorityconf = new /aws1/cl_ec2externalauthorit00(
    iv_externalresourceid = |string|
    iv_type = |string|
  )
  iv_description = |string|
  iv_dryrun = ABAP_TRUE
  iv_ipamscopeid = |string|
  iv_remexternalauthorityconf = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipamscope = lo_result->get_ipamscope( ).
  IF lo_ipamscope IS NOT INITIAL.
    lv_string = lo_ipamscope->get_ownerid( ).
    lv_ipamscopeid = lo_ipamscope->get_ipamscopeid( ).
    lv_resourcearn = lo_ipamscope->get_ipamscopearn( ).
    lv_resourcearn = lo_ipamscope->get_ipamarn( ).
    lv_string = lo_ipamscope->get_ipamregion( ).
    lv_ipamscopetype = lo_ipamscope->get_ipamscopetype( ).
    lv_boolean = lo_ipamscope->get_isdefault( ).
    lv_string = lo_ipamscope->get_description( ).
    lv_integer = lo_ipamscope->get_poolcount( ).
    lv_ipamscopestate = lo_ipamscope->get_state( ).
    LOOP AT lo_ipamscope->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.
    lo_ipamscopeexternalauthor = lo_ipamscope->get_externalauthorityconf( ).
    IF lo_ipamscopeexternalauthor IS NOT INITIAL.
      lv_ipamscopeexternalauthor_1 = lo_ipamscopeexternalauthor->get_type( ).
      lv_string = lo_ipamscopeexternalauthor->get_externalresourceid( ).
    ENDIF.
  ENDIF.
ENDIF.