Skip to content

Update Rule

waf_update_rule R Documentation

This is AWS WAF Classic documentation

Description

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:

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See create_rule.

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

  4. Submit an update_rule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See create_web_acl.

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.

Usage

waf_update_rule(RuleId, ChangeToken, Updates)

Arguments

RuleId

[required] The RuleId of the Rule that you want to update. RuleId is returned by create_rule and by list_rules.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Updates

[required] 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

Value

A list with the following syntax: 

list(
  ChangeToken = "string"
)

Request syntax

svc$update_rule(
  RuleId = "string",
  ChangeToken = "string",
  Updates = list(
    list(
      Action = "INSERT"|"DELETE",
      Predicate = list(
        Negated = TRUE|FALSE,
        Type = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch",
        DataId = "string"
      )
    )
  )
)

Examples

## Not run: 
# The following example deletes a Predicate object in a rule with the ID
# example1ds3t-46da-4fdb-b8d5-abc321j569j5.
svc$update_rule(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  RuleId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
  Updates = list(
    list(
      Action = "DELETE",
      Predicate = list(
        DataId = "MyByteMatchSetID",
        Negated = FALSE,
        Type = "ByteMatch"
      )
    )
  )
)

## End(Not run)