Statement (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.Statement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Statement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

The processing guidance for a Rule, used by AWS WAF to determine whether a web request matches the rule.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Statement()

Constructors
Constructor and Description
`Statement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Statement`	`clone()`
`boolean`	`equals(Object obj)`
`AndStatement`	`getAndStatement()` A logical rule statement used to combine other rule statements with AND logic.
`ByteMatchStatement`	`getByteMatchStatement()` A rule statement that defines a string match search for AWS WAF to apply to web requests.
`GeoMatchStatement`	`getGeoMatchStatement()` A rule statement used to identify web requests based on country of origin.
`IPSetReferenceStatement`	`getIPSetReferenceStatement()` A rule statement used to detect web requests coming from particular IP addresses or address ranges.
`ManagedRuleGroupStatement`	`getManagedRuleGroupStatement()` A rule statement used to run the rules that are defined in a managed rule group.
`NotStatement`	`getNotStatement()` A logical rule statement used to negate the results of another rule statement.
`OrStatement`	`getOrStatement()` A logical rule statement used to combine other rule statements with OR logic.
`RateBasedStatement`	`getRateBasedStatement()` A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span.
`RegexPatternSetReferenceStatement`	`getRegexPatternSetReferenceStatement()` A rule statement used to search web request components for matches with regular expressions.
`RuleGroupReferenceStatement`	`getRuleGroupReferenceStatement()` A rule statement used to run the rules that are defined in a RuleGroup.
`SizeConstraintStatement`	`getSizeConstraintStatement()` A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<).
`SqliMatchStatement`	`getSqliMatchStatement()` Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database.
`XssMatchStatement`	`getXssMatchStatement()` A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAndStatement(AndStatement andStatement)` A logical rule statement used to combine other rule statements with AND logic.
`void`	`setByteMatchStatement(ByteMatchStatement byteMatchStatement)` A rule statement that defines a string match search for AWS WAF to apply to web requests.
`void`	`setGeoMatchStatement(GeoMatchStatement geoMatchStatement)` A rule statement used to identify web requests based on country of origin.
`void`	`setIPSetReferenceStatement(IPSetReferenceStatement iPSetReferenceStatement)` A rule statement used to detect web requests coming from particular IP addresses or address ranges.
`void`	`setManagedRuleGroupStatement(ManagedRuleGroupStatement managedRuleGroupStatement)` A rule statement used to run the rules that are defined in a managed rule group.
`void`	`setNotStatement(NotStatement notStatement)` A logical rule statement used to negate the results of another rule statement.
`void`	`setOrStatement(OrStatement orStatement)` A logical rule statement used to combine other rule statements with OR logic.
`void`	`setRateBasedStatement(RateBasedStatement rateBasedStatement)` A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span.
`void`	`setRegexPatternSetReferenceStatement(RegexPatternSetReferenceStatement regexPatternSetReferenceStatement)` A rule statement used to search web request components for matches with regular expressions.
`void`	`setRuleGroupReferenceStatement(RuleGroupReferenceStatement ruleGroupReferenceStatement)` A rule statement used to run the rules that are defined in a RuleGroup.
`void`	`setSizeConstraintStatement(SizeConstraintStatement sizeConstraintStatement)` A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<).
`void`	`setSqliMatchStatement(SqliMatchStatement sqliMatchStatement)` Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database.
`void`	`setXssMatchStatement(XssMatchStatement xssMatchStatement)` A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests.
`String`	`toString()` Returns a string representation of this object.
`Statement`	`withAndStatement(AndStatement andStatement)` A logical rule statement used to combine other rule statements with AND logic.
`Statement`	`withByteMatchStatement(ByteMatchStatement byteMatchStatement)` A rule statement that defines a string match search for AWS WAF to apply to web requests.
`Statement`	`withGeoMatchStatement(GeoMatchStatement geoMatchStatement)` A rule statement used to identify web requests based on country of origin.
`Statement`	`withIPSetReferenceStatement(IPSetReferenceStatement iPSetReferenceStatement)` A rule statement used to detect web requests coming from particular IP addresses or address ranges.
`Statement`	`withManagedRuleGroupStatement(ManagedRuleGroupStatement managedRuleGroupStatement)` A rule statement used to run the rules that are defined in a managed rule group.
`Statement`	`withNotStatement(NotStatement notStatement)` A logical rule statement used to negate the results of another rule statement.
`Statement`	`withOrStatement(OrStatement orStatement)` A logical rule statement used to combine other rule statements with OR logic.
`Statement`	`withRateBasedStatement(RateBasedStatement rateBasedStatement)` A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span.
`Statement`	`withRegexPatternSetReferenceStatement(RegexPatternSetReferenceStatement regexPatternSetReferenceStatement)` A rule statement used to search web request components for matches with regular expressions.
`Statement`	`withRuleGroupReferenceStatement(RuleGroupReferenceStatement ruleGroupReferenceStatement)` A rule statement used to run the rules that are defined in a RuleGroup.
`Statement`	`withSizeConstraintStatement(SizeConstraintStatement sizeConstraintStatement)` A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<).
`Statement`	`withSqliMatchStatement(SqliMatchStatement sqliMatchStatement)` Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database.
`Statement`	`withXssMatchStatement(XssMatchStatement xssMatchStatement)` A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Statement
```
public Statement()
```
- Method Detail
  - setByteMatchStatement
```
public void setByteMatchStatement(ByteMatchStatement byteMatchStatement)
```
    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
    
    Parameters:
    
    byteMatchStatement - A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
  - getByteMatchStatement
```
public ByteMatchStatement getByteMatchStatement()
```
    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
    
    Returns:
    
    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
  - withByteMatchStatement
```
public Statement withByteMatchStatement(ByteMatchStatement byteMatchStatement)
```
    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
    
    Parameters:
    
    byteMatchStatement - A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSqliMatchStatement
```
public void setSqliMatchStatement(SqliMatchStatement sqliMatchStatement)
```
    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
    
    Parameters:
    
    sqliMatchStatement - Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
  - getSqliMatchStatement
```
public SqliMatchStatement getSqliMatchStatement()
```
    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
    
    Returns:
    
    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
  - withSqliMatchStatement
```
public Statement withSqliMatchStatement(SqliMatchStatement sqliMatchStatement)
```
    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
    
    Parameters:
    
    sqliMatchStatement - Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setXssMatchStatement
```
public void setXssMatchStatement(XssMatchStatement xssMatchStatement)
```
    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
    
    Parameters:
    
    xssMatchStatement - A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
  - getXssMatchStatement
```
public XssMatchStatement getXssMatchStatement()
```
    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
    
    Returns:
    
    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
  - withXssMatchStatement
```
public Statement withXssMatchStatement(XssMatchStatement xssMatchStatement)
```
    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
    
    Parameters:
    
    xssMatchStatement - A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeConstraintStatement
```
public void setSizeConstraintStatement(SizeConstraintStatement sizeConstraintStatement)
```
    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
    
    Parameters:
    
    sizeConstraintStatement - A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
  - getSizeConstraintStatement
```
public SizeConstraintStatement getSizeConstraintStatement()
```
    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
    
    Returns:
    
    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
  - withSizeConstraintStatement
```
public Statement withSizeConstraintStatement(SizeConstraintStatement sizeConstraintStatement)
```
    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
    
    Parameters:
    
    sizeConstraintStatement - A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
    
    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
    
    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeoMatchStatement
```
public void setGeoMatchStatement(GeoMatchStatement geoMatchStatement)
```
    A rule statement used to identify web requests based on country of origin.
    
    Parameters:
    
    geoMatchStatement - A rule statement used to identify web requests based on country of origin.
  - getGeoMatchStatement
```
public GeoMatchStatement getGeoMatchStatement()
```
    A rule statement used to identify web requests based on country of origin.
    
    Returns:
    
    A rule statement used to identify web requests based on country of origin.
  - withGeoMatchStatement
```
public Statement withGeoMatchStatement(GeoMatchStatement geoMatchStatement)
```
    A rule statement used to identify web requests based on country of origin.
    
    Parameters:
    
    geoMatchStatement - A rule statement used to identify web requests based on country of origin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleGroupReferenceStatement
```
public void setRuleGroupReferenceStatement(RuleGroupReferenceStatement ruleGroupReferenceStatement)
```
    A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Parameters:
    
    ruleGroupReferenceStatement - A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - getRuleGroupReferenceStatement
```
public RuleGroupReferenceStatement getRuleGroupReferenceStatement()
```
    A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Returns:
    
    A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - withRuleGroupReferenceStatement
```
public Statement withRuleGroupReferenceStatement(RuleGroupReferenceStatement ruleGroupReferenceStatement)
```
    A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Parameters:
    
    ruleGroupReferenceStatement - A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
    
    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIPSetReferenceStatement
```
public void setIPSetReferenceStatement(IPSetReferenceStatement iPSetReferenceStatement)
```
    A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Parameters:
    
    iPSetReferenceStatement - A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
  - getIPSetReferenceStatement
```
public IPSetReferenceStatement getIPSetReferenceStatement()
```
    A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Returns:
    
    A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
  - withIPSetReferenceStatement
```
public Statement withIPSetReferenceStatement(IPSetReferenceStatement iPSetReferenceStatement)
```
    A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Parameters:
    
    iPSetReferenceStatement - A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
    
    Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegexPatternSetReferenceStatement
```
public void setRegexPatternSetReferenceStatement(RegexPatternSetReferenceStatement regexPatternSetReferenceStatement)
```
    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Parameters:
    
    regexPatternSetReferenceStatement - A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
  - getRegexPatternSetReferenceStatement
```
public RegexPatternSetReferenceStatement getRegexPatternSetReferenceStatement()
```
    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Returns:
    
    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
  - withRegexPatternSetReferenceStatement
```
public Statement withRegexPatternSetReferenceStatement(RegexPatternSetReferenceStatement regexPatternSetReferenceStatement)
```
    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Parameters:
    
    regexPatternSetReferenceStatement - A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
    
    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRateBasedStatement
```
public void setRateBasedStatement(RateBasedStatement rateBasedStatement)
```
    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    - An IP match statement with an IP set that specified the address 192.0.2.44.
    - A string match statement that searches in the User-Agent header for the string BadBot.
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    Parameters:
    rateBasedStatement - A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    
    An IP match statement with an IP set that specified the address 192.0.2.44.
    
    A string match statement that searches in the User-Agent header for the string BadBot.
    
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - getRateBasedStatement
```
public RateBasedStatement getRateBasedStatement()
```
    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    - An IP match statement with an IP set that specified the address 192.0.2.44.
    - A string match statement that searches in the User-Agent header for the string BadBot.
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    Returns:
    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    
    An IP match statement with an IP set that specified the address 192.0.2.44.
    
    A string match statement that searches in the User-Agent header for the string BadBot.
    
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - withRateBasedStatement
```
public Statement withRateBasedStatement(RateBasedStatement rateBasedStatement)
```
    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    - An IP match statement with an IP set that specified the address 192.0.2.44.
    - A string match statement that searches in the User-Agent header for the string BadBot.
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    Parameters:
    rateBasedStatement - A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
    
    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
    
    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
    
    An IP match statement with an IP set that specified the address 192.0.2.44.
    
    A string match statement that searches in the User-Agent header for the string BadBot.
    
    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
    
    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAndStatement
```
public void setAndStatement(AndStatement andStatement)
```
    A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
    
    Parameters:
    
    andStatement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
  - getAndStatement
```
public AndStatement getAndStatement()
```
    A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
    
    Returns:
    
    A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
  - withAndStatement
```
public Statement withAndStatement(AndStatement andStatement)
```
    A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
    
    Parameters:
    
    andStatement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOrStatement
```
public void setOrStatement(OrStatement orStatement)
```
    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
    
    Parameters:
    
    orStatement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
  - getOrStatement
```
public OrStatement getOrStatement()
```
    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
    
    Returns:
    
    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
  - withOrStatement
```
public Statement withOrStatement(OrStatement orStatement)
```
    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
    
    Parameters:
    
    orStatement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotStatement
```
public void setNotStatement(NotStatement notStatement)
```
    A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
    
    Parameters:
    
    notStatement - A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
  - getNotStatement
```
public NotStatement getNotStatement()
```
    A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
    
    Returns:
    
    A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
  - withNotStatement
```
public Statement withNotStatement(NotStatement notStatement)
```
    A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
    
    Parameters:
    
    notStatement - A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setManagedRuleGroupStatement
```
public void setManagedRuleGroupStatement(ManagedRuleGroupStatement managedRuleGroupStatement)
```
    A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Parameters:
    
    managedRuleGroupStatement - A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - getManagedRuleGroupStatement
```
public ManagedRuleGroupStatement getManagedRuleGroupStatement()
```
    A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Returns:
    
    A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
  - withManagedRuleGroupStatement
```
public Statement withManagedRuleGroupStatement(ManagedRuleGroupStatement managedRuleGroupStatement)
```
    A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    
    Parameters:
    
    managedRuleGroupStatement - A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
    
    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a 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 Statement 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.

Did this page help you?

Class Statement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Statement

Method Detail

setByteMatchStatement

getByteMatchStatement

withByteMatchStatement

setSqliMatchStatement

getSqliMatchStatement

withSqliMatchStatement

setXssMatchStatement

getXssMatchStatement

withXssMatchStatement

setSizeConstraintStatement

getSizeConstraintStatement

withSizeConstraintStatement

setGeoMatchStatement

getGeoMatchStatement

withGeoMatchStatement

setRuleGroupReferenceStatement

getRuleGroupReferenceStatement

withRuleGroupReferenceStatement

setIPSetReferenceStatement

getIPSetReferenceStatement

withIPSetReferenceStatement

setRegexPatternSetReferenceStatement

getRegexPatternSetReferenceStatement

withRegexPatternSetReferenceStatement

setRateBasedStatement

getRateBasedStatement

withRateBasedStatement

setAndStatement

getAndStatement

withAndStatement

setOrStatement

getOrStatement

withOrStatement

setNotStatement

getNotStatement

withNotStatement

setManagedRuleGroupStatement

getManagedRuleGroupStatement

withManagedRuleGroupStatement

toString

equals

hashCode

clone

marshall