Skip to content

/AWS1/IF_WAF=>CREATEREGEXPATTERNSET()

About CreateRegexPatternSet

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexPatternSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

  2. Submit a CreateRegexPatternSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

  4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Method Signature

METHODS /AWS1/IF_WAF~CREATEREGEXPATTERNSET
  IMPORTING
    !IV_NAME TYPE /AWS1/WAFRESOURCENAME OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafcreregexpatsetrsp
  RAISING
    /AWS1/CX_WAFWAFDISALWEDNAMEEX
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFLIMITSEXCDEX
    /AWS1/CX_WAFWAFSTALEDATAEX
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/WAFRESOURCENAME /AWS1/WAFRESOURCENAME

A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

iv_changetoken TYPE /AWS1/WAFCHANGETOKEN /AWS1/WAFCHANGETOKEN

The value returned by the most recent call to GetChangeToken.

RETURNING

oo_output TYPE REF TO /aws1/cl_wafcreregexpatsetrsp /AWS1/CL_WAFCREREGEXPATSETRSP

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->createregexpatternset(
  iv_changetoken = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_regexpatternset = lo_result->get_regexpatternset( ).
  IF lo_regexpatternset IS NOT INITIAL.
    lv_resourceid = lo_regexpatternset->get_regexpatternsetid( ).
    lv_resourcename = lo_regexpatternset->get_name( ).
    LOOP AT lo_regexpatternset->get_regexpatternstrings( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_regexpatternstring = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_changetoken = lo_result->get_changetoken( ).
ENDIF.