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.

A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

In the rule, you also define the rate limit as 15,000.

Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

Inheritance Hierarchy

System.Object
  Amazon.WAFRegional.Model.RateBasedRule

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

Syntax

C#
public class RateBasedRule

The RateBasedRule type exposes the following members

Constructors

NameDescription
Public Method RateBasedRule()

Properties

NameTypeDescription
Public Property MatchPredicates System.Collections.Generic.List<Amazon.WAFRegional.Model.Predicate>

Gets and sets the property MatchPredicates.

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

Public Property MetricName System.String

Gets and sets the property MetricName.

A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

Public Property Name System.String

Gets and sets the property Name.

A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

Public Property RateKey Amazon.WAFRegional.RateKey

Gets and sets the property RateKey.

The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

Public Property RateLimit System.Int64

Gets and sets the property RateLimit.

The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Public Property RuleId System.String

Gets and sets the property RuleId.

A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms