UPDATERULE()`¶

About UpdateRule¶

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 Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet 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~UPDATERULE
  IMPORTING
    !IV_RULEID TYPE /AWS1/WAFRESOURCEID OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
    !IT_UPDATES TYPE /AWS1/CL_WAFRULEUPDATE=>TT_RULEUPDATES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafupdateruleresponse
  RAISING
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFINVACCOUNTEX
    /AWS1/CX_WAFWAFINVALIDOPEX
    /AWS1/CX_WAFWAFINVALIDPARAMEX
    /AWS1/CX_WAFWAFLIMITSEXCDEX
    /AWS1/CX_WAFWAFNONEXENTCONTA00
    /AWS1/CX_WAFWAFNONEXENTITEMEX
    /AWS1/CX_WAFWAFREFERENCEDITE00
    /AWS1/CX_WAFWAFSTALEDATAEX
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_ruleid` `TYPE /AWS1/WAFRESOURCEID` `/AWS1/WAFRESOURCEID`¶

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

`iv_changetoken` `TYPE /AWS1/WAFCHANGETOKEN` `/AWS1/WAFCHANGETOKEN`¶

The value returned by the most recent call to GetChangeToken.

`it_updates` `TYPE /AWS1/CL_WAFRULEUPDATE=>TT_RULEUPDATES` `TT_RULEUPDATES`¶

An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

RuleUpdate: Contains Action and Predicate

Predicate: Contains DataId, Negated, and Type

FieldToMatch: Contains Data and Type

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wafupdateruleresponse` `/AWS1/CL_WAFUPDATERULERESPONSE`¶

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->updaterule(
  it_updates = VALUE /aws1/cl_wafruleupdate=>tt_ruleupdates(
    (
      new /aws1/cl_wafruleupdate(
        io_predicate = new /aws1/cl_wafpredicate(
          iv_dataid = |string|
          iv_negated = ABAP_TRUE
          iv_type = |string|
        )
        iv_action = |string|
      )
    )
  )
  iv_changetoken = |string|
  iv_ruleid = |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.

To update a rule¶

The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

DATA(lo_result) = lo_client->updaterule(
  it_updates = VALUE /aws1/cl_wafruleupdate=>tt_ruleupdates(
    (
      new /aws1/cl_wafruleupdate(
        io_predicate = new /aws1/cl_wafpredicate(
          iv_dataid = |MyByteMatchSetID|
          iv_negated = ABAP_FALSE
          iv_type = |ByteMatch|
        )
        iv_action = |DELETE|
      )
    )
  )
  iv_changetoken = |abcd12f2-46da-4fdb-b8d5-fbd4c466928f|
  iv_ruleid = |example1ds3t-46da-4fdb-b8d5-abc321j569j5|
).

/AWS1/IF_WAF=>UPDATERULE()¶