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 in the referenced rule group whose actions are set to `Count`.
`List<ManagedRuleGroupConfig>`	`getManagedRuleGroupConfigs()` Additional information that's used by a managed rule group.
`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.
`String`	`getVersion()` The version of the managed rule group to use.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExcludedRules(Collection<ExcludedRule> excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.
`void`	`setManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)` Additional information that's used by a managed rule group.
`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.
`void`	`setVersion(String version)` The version of the managed rule group to use.
`String`	`toString()` Returns a string representation of this object.
`ManagedRuleGroupStatement`	`withExcludedRules(Collection<ExcludedRule> excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.
`ManagedRuleGroupStatement`	`withExcludedRules(ExcludedRule... excludedRules)` The rules in the referenced rule group whose actions are set to `Count`.
`ManagedRuleGroupStatement`	`withManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)` Additional information that's used by a managed rule group.
`ManagedRuleGroupStatement`	`withManagedRuleGroupConfigs(ManagedRuleGroupConfig... managedRuleGroupConfigs)` Additional information that's used by a managed rule group.
`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.
`ManagedRuleGroupStatement`	`withVersion(String version)` The version of the managed rule group to use.

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.
  - setVersion
```
public void setVersion(String version)
```
    The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
    
    Parameters:
    
    version - The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
  - getVersion
```
public String getVersion()
```
    The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
    
    Returns:
    
    The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
  - withVersion
```
public ManagedRuleGroupStatement withVersion(String version)
```
    The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
    
    Parameters:
    
    version - The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
    
    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 ManagedRuleGroupStatement 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 ManagedRuleGroupStatement 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.
  - 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.
  - getManagedRuleGroupConfigs
```
public List<ManagedRuleGroupConfig> getManagedRuleGroupConfigs()
```
    Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    Returns:
    
    Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
  - setManagedRuleGroupConfigs
```
public void setManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)
```
    Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    Parameters:
    
    managedRuleGroupConfigs - Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
  - withManagedRuleGroupConfigs
```
public ManagedRuleGroupStatement withManagedRuleGroupConfigs(ManagedRuleGroupConfig... managedRuleGroupConfigs)
```
    Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    NOTE: This method appends the values to the existing list (if any). Use setManagedRuleGroupConfigs(java.util.Collection) or withManagedRuleGroupConfigs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    managedRuleGroupConfigs - Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withManagedRuleGroupConfigs
```
public ManagedRuleGroupStatement withManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)
```
    Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    Parameters:
    
    managedRuleGroupConfigs - Additional information that's used by a managed rule group. Most managed rule groups don't require this.
    
    Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
    
    You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
    
    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

setVersion

getVersion

withVersion

getExcludedRules

setExcludedRules

withExcludedRules

withExcludedRules

setScopeDownStatement

getScopeDownStatement

withScopeDownStatement

getManagedRuleGroupConfigs

setManagedRuleGroupConfigs

withManagedRuleGroupConfigs

withManagedRuleGroupConfigs

toString

equals

hashCode

clone

marshall