UpdateRuleGroupRequest Class | AWS SDK for .NET V3

Container for the parameters to the UpdateRuleGroup operation.

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:

Create and update the Rules that you want to include in the RuleGroup. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.
Submit an UpdateRuleGroup request to add Rules to the RuleGroup.
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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WAFRegional.AmazonWAFRegionalRequest
      Amazon.WAFRegional.Model.UpdateRuleGroupRequest

Namespace: Amazon.WAFRegional.Model
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z

Syntax

public class UpdateRuleGroupRequest : AmazonWAFRegionalRequest
         IAmazonWebServiceRequest

The UpdateRuleGroupRequest type exposes the following members

Constructors

	Name	Description
	UpdateRuleGroupRequest()

Properties

Name Type Description

Name	Type	Description
ChangeToken	System.String	Gets and sets the property ChangeToken. The value returned by the most recent call to GetChangeToken.
RuleGroupId	System.String	Gets and sets the property RuleGroupId. The `RuleGroupId` of the RuleGroup that you want to update. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.
Updates	System.Collections.Generic.List<Amazon.WAFRegional.Model.RuleGroupUpdate>	Gets and sets the property Updates. 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

System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

RuleGroupId

System.String

Gets and sets the property RuleGroupId.

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

Updates

System.Collections.Generic.List<Amazon.WAFRegional.Model.RuleGroupUpdate>

Gets and sets the property Updates.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5