Update Rule Group

waf_update_rule_group

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 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 create_rule.

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

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

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

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.

Usage

waf_update_rule_group(RuleGroupId, Updates, ChangeToken)

Arguments

RuleGroupId

[required] The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by create_rule_group and by list_rule_groups.

Updates

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

ChangeToken

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

Value

A list with the following syntax:

list(
  ChangeToken = "string"
)

Request syntax

svc$update_rule_group(
  RuleGroupId = "string",
  Updates = list(
    list(
      Action = "INSERT"|"DELETE",
      ActivatedRule = list(
        Priority = 123,
        RuleId = "string",
        Action = list(
          Type = "BLOCK"|"ALLOW"|"COUNT"
        ),
        OverrideAction = list(
          Type = "NONE"|"COUNT"
        ),
        Type = "REGULAR"|"RATE_BASED"|"GROUP",
        ExcludedRules = list(
          list(
            RuleId = "string"
          )
        )
      )
    )
  ),
  ChangeToken = "string"
)