CREATEXSSMATCHSET()`¶

About CreateXssMatchSet¶

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 an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

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~CREATEXSSMATCHSET
  IMPORTING
    !IV_NAME TYPE /AWS1/WAFRESOURCENAME OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafcrexssmatchsetrsp
  RAISING
    /AWS1/CX_WAFWAFDISALWEDNAMEEX
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFINVACCOUNTEX
    /AWS1/CX_WAFWAFINVALIDPARAMEX
    /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 for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

`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_wafcrexssmatchsetrsp` `/AWS1/CL_WAFCREXSSMATCHSETRSP`¶

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->createxssmatchset(
  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_xssmatchset = lo_result->get_xssmatchset( ).
  IF lo_xssmatchset IS NOT INITIAL.
    lv_resourceid = lo_xssmatchset->get_xssmatchsetid( ).
    lv_resourcename = lo_xssmatchset->get_name( ).
    LOOP AT lo_xssmatchset->get_xssmatchtuples( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lo_fieldtomatch = lo_row_1->get_fieldtomatch( ).
        IF lo_fieldtomatch IS NOT INITIAL.
          lv_matchfieldtype = lo_fieldtomatch->get_type( ).
          lv_matchfielddata = lo_fieldtomatch->get_data( ).
        ENDIF.
        lv_texttransformation = lo_row_1->get_texttransformation( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_changetoken = lo_result->get_changetoken( ).
ENDIF.

To create an XSS match set¶

The following example creates an XSS match set named MySampleXssMatchSet.

DATA(lo_result) = lo_client->createxssmatchset(
  iv_changetoken = |abcd12f2-46da-4fdb-b8d5-fbd4c466928f|
  iv_name = |MySampleXssMatchSet|
).

/AWS1/IF_WAF=>CREATEXSSMATCHSET()¶