Skip to content

/AWS1/IF_EC2=>CREATEIPAMSCOPE()

About CreateIpamScope

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

Method Signature

METHODS /AWS1/IF_EC2~CREATEIPAMSCOPE
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMID TYPE /AWS1/EC2IPAMID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IO_EXTERNALAUTHORITYCONF TYPE REF TO /AWS1/CL_EC2EXTERNALAUTHORIT00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2creipamscoperslt
  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 this scope.

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

A description for the scope you're creating.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2creipamscoperslt /AWS1/CL_EC2CREIPAMSCOPERSLT

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->createipamscope(
  io_externalauthorityconf = new /aws1/cl_ec2externalauthorit00(
    iv_externalresourceid = |string|
    iv_type = |string|
  )
  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_description = |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_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.