ManagedRuleGroupStatement (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ManagedRuleGroupStatement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 cannot 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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ManagedRuleGroupStatement()

Constructors
Constructor and Description
`ManagedRuleGroupStatement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ManagedRuleGroupStatement`	`clone()`
`boolean`	`equals(Object obj)`
`List<ExcludedRule>`	`getExcludedRules()` The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is set on the rule.
`String`	`getName()` The name of the managed rule group.
`Statement`	`getScopeDownStatement()` An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
`String`	`getVendorName()` The name of the managed rule group vendor.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExcludedRules(Collection<ExcludedRule> excludedRules)` The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is set on the rule.
`void`	`setName(String name)` The name of the managed rule group.
`void`	`setScopeDownStatement(Statement scopeDownStatement)` An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
`void`	`setVendorName(String vendorName)` The name of the managed rule group vendor.
`String`	`toString()` Returns a string representation of this object.
`ManagedRuleGroupStatement`	`withExcludedRules(Collection<ExcludedRule> excludedRules)` The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is set on the rule.
`ManagedRuleGroupStatement`	`withExcludedRules(ExcludedRule... excludedRules)` The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is set on the rule.
`ManagedRuleGroupStatement`	`withName(String name)` The name of the managed rule group.
`ManagedRuleGroupStatement`	`withScopeDownStatement(Statement scopeDownStatement)` An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
`ManagedRuleGroupStatement`	`withVendorName(String vendorName)` The name of the managed rule group vendor.

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

- Constructor Detail
  - ManagedRuleGroupStatement
```
public ManagedRuleGroupStatement()
```
- Method Detail
  - setVendorName
```
public void setVendorName(String vendorName)
```
    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
    
    Parameters:
    
    vendorName - The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
  - getVendorName
```
public String getVendorName()
```
    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
    
    Returns:
    
    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
  - withVendorName
```
public ManagedRuleGroupStatement withVendorName(String vendorName)
```
    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
    
    Parameters:
    
    vendorName - The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
    
    Parameters:
    
    name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
  - getName
```
public String getName()
```
    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
    
    Returns:
    
    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
  - withName
```
public ManagedRuleGroupStatement withName(String name)
```
    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
    
    Parameters:
    
    name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludedRules
```
public List<ExcludedRule> getExcludedRules()
```
    The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    Returns:
    
    The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
  - setExcludedRules
```
public void setExcludedRules(Collection<ExcludedRule> excludedRules)
```
    The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    Parameters:
    
    excludedRules - The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
  - withExcludedRules
```
public ManagedRuleGroupStatement withExcludedRules(ExcludedRule... excludedRules)
```
    The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    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 whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludedRules
```
public ManagedRuleGroupStatement withExcludedRules(Collection<ExcludedRule> excludedRules)
```
    The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    Parameters:
    
    excludedRules - The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScopeDownStatement
```
public void setScopeDownStatement(Statement scopeDownStatement)
```
    An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
    
    Parameters:
    
    scopeDownStatement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
  - getScopeDownStatement
```
public Statement getScopeDownStatement()
```
    An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
    
    Returns:
    
    An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
  - withScopeDownStatement
```
public ManagedRuleGroupStatement withScopeDownStatement(Statement scopeDownStatement)
```
    An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
    
    Parameters:
    
    scopeDownStatement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
    
    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 ManagedRuleGroupStatement 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 ManagedRuleGroupStatement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedRuleGroupStatement

Method Detail

setVendorName

getVendorName

withVendorName

setName

getName

withName

getExcludedRules

setExcludedRules

withExcludedRules

withExcludedRules

setScopeDownStatement

getScopeDownStatement

withScopeDownStatement

toString

equals

hashCode

clone

marshall