com.amazonaws.services.waf.model

Class RateBasedRule

java.lang.Object

com.amazonaws.services.waf.model.RateBasedRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RateBasedRule
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

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:

• The requests come from 192.0.2.44.

• They contain the value BadBot in the User-Agent header.

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

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateBasedRule()

Method Summary

Modifier and Type	Method and Description
RateBasedRule	clone()
boolean	equals(Object obj)
List<Predicate>	getMatchPredicates() The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
String	getMetricName() A friendly name or description for the metrics for a RateBasedRule.
String	getName() A friendly name or description for a RateBasedRule.
String	getRateKey() The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
Long	getRateLimit() The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
String	getRuleId() A unique identifier for a RateBasedRule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMatchPredicates(Collection<Predicate> matchPredicates) The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
void	setMetricName(String metricName) A friendly name or description for the metrics for a RateBasedRule.
void	setName(String name) A friendly name or description for a RateBasedRule.
void	setRateKey(RateKey rateKey) The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
void	setRateKey(String rateKey) The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
void	setRateLimit(Long rateLimit) The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
void	setRuleId(String ruleId) A unique identifier for a RateBasedRule.
String	toString() Returns a string representation of this object.
RateBasedRule	withMatchPredicates(Collection<Predicate> matchPredicates) The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
RateBasedRule	withMatchPredicates(Predicate... matchPredicates) The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
RateBasedRule	withMetricName(String metricName) A friendly name or description for the metrics for a RateBasedRule.
RateBasedRule	withName(String name) A friendly name or description for a RateBasedRule.
RateBasedRule	withRateKey(RateKey rateKey) The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
RateBasedRule	withRateKey(String rateKey) The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
RateBasedRule	withRateLimit(Long rateLimit) The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
RateBasedRule	withRuleId(String ruleId) A unique identifier for a RateBasedRule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RateBasedRule

public RateBasedRule()

Method Detail

setRuleId

public void setRuleId(String 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).

Parameters:

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

getRuleId

public String getRuleId()

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

Returns:

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

withRuleId

public RateBasedRule withRuleId(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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

Returns:

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

withName

public RateBasedRule withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMetricName

public void setMetricName(String 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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Parameters:

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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

getMetricName

public String getMetricName()

A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Returns:

A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

withMetricName

public RateBasedRule withMetricName(String 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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Parameters:

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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Returns:

Returns a reference to this object so that method calls can be chained together.

getMatchPredicates

public List<Predicate> getMatchPredicates()

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

Returns:

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

setMatchPredicates

public void setMatchPredicates(Collection<Predicate> matchPredicates)

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

Parameters:

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

withMatchPredicates

public RateBasedRule withMatchPredicates(Predicate... matchPredicates)

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

NOTE: This method appends the values to the existing list (if any). Use setMatchPredicates(java.util.Collection) or withMatchPredicates(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withMatchPredicates

public RateBasedRule withMatchPredicates(Collection<Predicate> matchPredicates)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRateKey

public void setRateKey(String 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.

Parameters:

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.

See Also:

RateKey

getRateKey

public String getRateKey()

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.

Returns:

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.

See Also:

RateKey

withRateKey

public RateBasedRule withRateKey(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RateKey

setRateKey

public void setRateKey(RateKey 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.

Parameters:

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.

See Also:

RateKey

withRateKey

public RateBasedRule withRateKey(RateKey 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RateKey

setRateLimit

public void setRateLimit(Long 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.

Parameters:

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.

getRateLimit

public Long getRateLimit()

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.

Returns:

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.

withRateLimit

public RateBasedRule withRateLimit(Long 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RateBasedRule clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.