/AWS1/IF_WAF=>UPDATERULEGROUP()

About UpdateRuleGroup

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.

Inserts or deletes ActivatedRule objects in a RuleGroup.

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

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

1. Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

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

3. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

4. Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

If you want to replace one Rule with another, you delete the existing one and add the new one.

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~UPDATERULEGROUP
  IMPORTING
    !IV_RULEGROUPID TYPE /AWS1/WAFRESOURCEID OPTIONAL
    !IT_UPDATES TYPE /AWS1/CL_WAFRULEGROUPUPDATE=>TT_RULEGROUPUPDATES OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafupdaterulegrouprsp
  RAISING
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFINVALIDOPEX
    /AWS1/CX_WAFWAFINVALIDPARAMEX
    /AWS1/CX_WAFWAFLIMITSEXCDEX
    /AWS1/CX_WAFWAFNONEXENTCONTA00
    /AWS1/CX_WAFWAFNONEXENTITEMEX
    /AWS1/CX_WAFWAFSTALEDATAEX
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_rulegroupid TYPE /AWS1/WAFRESOURCEID /AWS1/WAFRESOURCEID

The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

it_updates TYPE /AWS1/CL_WAFRULEGROUPUPDATE=>TT_RULEGROUPUPDATES TT_RULEGROUPUPDATES

An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

You can only insert REGULAR rules into a rule group.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

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_wafupdaterulegrouprsp /AWS1/CL_WAFUPDATERULEGROUPRSP

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->updaterulegroup(
  it_updates = VALUE /aws1/cl_wafrulegroupupdate=>tt_rulegroupupdates(
    (
      new /aws1/cl_wafrulegroupupdate(
        io_activatedrule = new /aws1/cl_wafactivatedrule(
          io_action = new /aws1/cl_wafwafaction( |string| )
          io_overrideaction = new /aws1/cl_wafwafoverrideaction( |string| )
          it_excludedrules = VALUE /aws1/cl_wafexcludedrule=>tt_excludedrules(
            ( new /aws1/cl_wafexcludedrule( |string| ) )
          )
          iv_priority = 123
          iv_ruleid = |string|
          iv_type = |string|
        )
        iv_action = |string|
      )
    )
  )
  iv_changetoken = |string|
  iv_rulegroupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_changetoken = lo_result->get_changetoken( ).
ENDIF.