Skip to content

/AWS1/IF_WA2=>CREATEIPSET()

About CreateIPSet

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

Method Signature

METHODS /AWS1/IF_WA2~CREATEIPSET
  IMPORTING
    !IV_NAME TYPE /AWS1/WA2ENTITYNAME OPTIONAL
    !IV_SCOPE TYPE /AWS1/WA2SCOPE OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/WA2ENTITYDESCRIPTION OPTIONAL
    !IV_IPADDRESSVERSION TYPE /AWS1/WA2IPADDRESSVERSION OPTIONAL
    !IT_ADDRESSES TYPE /AWS1/CL_WA2IPADDRESSES_W=>TT_IPADDRESSES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_WA2TAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wa2createipsetrsp
  RAISING
    /AWS1/CX_WA2WAFDUPLICATEITEMEX
    /AWS1/CX_WA2WAFINTERNALERROREX
    /AWS1/CX_WA2WAFINVALIDOPEX
    /AWS1/CX_WA2WAFINVALIDPARAMEX
    /AWS1/CX_WA2WAFLIMITSEXCDEX
    /AWS1/CX_WA2WAFOPTIMISTICLKEX
    /AWS1/CX_WA2WAFTAGOPERATIONEX
    /AWS1/CX_WA2WAFTAGOPINTERNAL00
    /AWS1/CX_WA2CLIENTEXC
    /AWS1/CX_WA2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/WA2ENTITYNAME /AWS1/WA2ENTITYNAME

The name of the IP set. You cannot change the name of an IPSet after you create it.

iv_scope TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

iv_ipaddressversion TYPE /AWS1/WA2IPADDRESSVERSION /AWS1/WA2IPADDRESSVERSION

The version of the IP addresses, either IPV4 or IPV6.

it_addresses TYPE /AWS1/CL_WA2IPADDRESSES_W=>TT_IPADDRESSES TT_IPADDRESSES

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

  • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

  • Empty array: "Addresses": []

  • Array with one address: "Addresses": ["192.0.2.44/32"]

  • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

  • INVALID specification: "Addresses": [""] INVALID

Optional arguments:

iv_description TYPE /AWS1/WA2ENTITYDESCRIPTION /AWS1/WA2ENTITYDESCRIPTION

A description of the IP set that helps with identification.

it_tags TYPE /AWS1/CL_WA2TAG=>TT_TAGLIST TT_TAGLIST

An array of key:value pairs to associate with the resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_wa2createipsetrsp /AWS1/CL_WA2CREATEIPSETRSP

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->createipset(
  it_addresses = VALUE /aws1/cl_wa2ipaddresses_w=>tt_ipaddresses(
    ( new /aws1/cl_wa2ipaddresses_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_wa2tag=>tt_taglist(
    (
      new /aws1/cl_wa2tag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_ipaddressversion = |string|
  iv_name = |string|
  iv_scope = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipsetsummary = lo_result->get_summary( ).
  IF lo_ipsetsummary IS NOT INITIAL.
    lv_entityname = lo_ipsetsummary->get_name( ).
    lv_entityid = lo_ipsetsummary->get_id( ).
    lv_entitydescription = lo_ipsetsummary->get_description( ).
    lv_locktoken = lo_ipsetsummary->get_locktoken( ).
    lv_resourcearn = lo_ipsetsummary->get_arn( ).
  ENDIF.
ENDIF.