AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateRule 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 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:

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 BadBotand 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 CreateRule.

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

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

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

Inheritance Hierarchy

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

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

Syntax

C# 
public class UpdateRuleRequest : AmazonWAFRegionalRequest
         IAmazonWebServiceRequest

The UpdateRuleRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateRuleRequest()

Properties

NameTypeDescription
Public Property ChangeToken System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

Public Property RuleId System.String

Gets and sets the property RuleId.

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

Public Property Updates System.Collections.Generic.List<Amazon.WAFRegional.Model.RuleUpdate>

Gets and sets the property Updates.

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

Examples

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

To update a rule


var client = new AmazonWAFRegionalClient();
var response = client.UpdateRule(new UpdateRuleRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    RuleId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
    Updates = new List<RuleUpdate> {
        new RuleUpdate {
            Action = "DELETE",
            Predicate = new Predicate {
                DataId = "MyByteMatchSetID",
                Negated = false,
                Type = "ByteMatch"
            }
        }
    }
});

string changeToken = response.ChangeToken;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5