RuleGroupReferenceStatement (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroupReferenceStatement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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. You can only use a rule group reference statement at the top level inside a web ACL.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroupReferenceStatement()

Constructors
Constructor and Description
`RuleGroupReferenceStatement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleGroupReferenceStatement`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`List<ExcludedRule>`	`getExcludedRules()` The rules in the referenced rule group whose actions are set to `Count`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setExcludedRules(Collection<ExcludedRule> excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.
`String`	`toString()` Returns a string representation of this object.
`RuleGroupReferenceStatement`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`RuleGroupReferenceStatement`	`withExcludedRules(Collection<ExcludedRule> excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.
`RuleGroupReferenceStatement`	`withExcludedRules(ExcludedRule... excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.

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

- Constructor Detail
  - RuleGroupReferenceStatement
```
public RuleGroupReferenceStatement()
```
- Method Detail
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public RuleGroupReferenceStatement withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludedRules
```
public List<ExcludedRule> getExcludedRules()
```
    The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    Returns:
    
    The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
  - setExcludedRules
```
public void setExcludedRules(Collection<ExcludedRule> excludedRules)
```
    The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    Parameters:
    
    excludedRules - The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
  - withExcludedRules
```
public RuleGroupReferenceStatement withExcludedRules(ExcludedRule... excludedRules)
```
    The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludedRules(java.util.Collection) or withExcludedRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludedRules - The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludedRules
```
public RuleGroupReferenceStatement withExcludedRules(Collection<ExcludedRule> excludedRules)
```
    The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    Parameters:
    
    excludedRules - The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
    
    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 RuleGroupReferenceStatement 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 RuleGroupReferenceStatement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroupReferenceStatement

Method Detail

setARN

getARN

withARN

getExcludedRules

setExcludedRules

withExcludedRules

withExcludedRules

toString

equals

hashCode

clone

marshall