@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. You cannot use a managed rule group inside another rule group. You can only reference a
managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule
group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP)
managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
| Constructor and Description |
|---|
ManagedRuleGroupStatement() |
| Modifier and Type | Method and Description |
|---|---|
ManagedRuleGroupStatement |
clone() |
boolean |
equals(Object obj) |
List<ExcludedRule> |
getExcludedRules()
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.
|
List<RuleActionOverride> |
getRuleActionOverrides()
Action settings to use in the place of the rule actions that are configured inside the 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)
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 |
setRuleActionOverrides(Collection<RuleActionOverride> ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the 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)
Rules in the referenced rule group whose actions are set to
Count. |
ManagedRuleGroupStatement |
withExcludedRules(ExcludedRule... excludedRules)
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 |
withRuleActionOverrides(Collection<RuleActionOverride> ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the rule group.
|
ManagedRuleGroupStatement |
withRuleActionOverrides(RuleActionOverride... ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the 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.
|
public void setVendorName(String vendorName)
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
vendorName - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a
rule group.public String getVendorName()
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
public ManagedRuleGroupStatement withVendorName(String vendorName)
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
vendorName - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a
rule group.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.
name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.public String getName()
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
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.
name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.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.
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.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.
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.
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.public List<ExcludedRule> getExcludedRules()
Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including
Count.
Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting,
including Count.
public void setExcludedRules(Collection<ExcludedRule> excludedRules)
Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including
Count.
excludedRules - Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting,
including Count.
public ManagedRuleGroupStatement withExcludedRules(ExcludedRule... excludedRules)
Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including
Count.
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.
excludedRules - Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting,
including Count.
public ManagedRuleGroupStatement withExcludedRules(Collection<ExcludedRule> excludedRules)
Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including
Count.
excludedRules - Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting,
including Count.
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.
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.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.
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.
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.public List<ManagedRuleGroupConfig> getManagedRuleGroupConfigs()
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud
prevention managed rule group. The configuration includes the registration and sign-up pages of your application
and the locations in the account creation request payload of data, such as the user email and phone number
fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention
managed rule group. The configuration includes the sign-in page of your application and the locations in the
login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that
you want the Bot Control rule group to use.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation
fraud prevention managed rule group. The configuration includes the registration and sign-up pages of
your application and the locations in the account creation request payload of data, such as the user
email and phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover
prevention managed rule group. The configuration includes the sign-in page of your application and the
locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection
level that you want the Bot Control rule group to use.
public void setManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud
prevention managed rule group. The configuration includes the registration and sign-up pages of your application
and the locations in the account creation request payload of data, such as the user email and phone number
fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention
managed rule group. The configuration includes the sign-in page of your application and the locations in the
login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that
you want the Bot Control rule group to use.
managedRuleGroupConfigs - Additional information that's used by a managed rule group. Many managed rule groups don't require
this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation
fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your
application and the locations in the account creation request payload of data, such as the user email and
phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover
prevention managed rule group. The configuration includes the sign-in page of your application and the
locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection
level that you want the Bot Control rule group to use.
public ManagedRuleGroupStatement withManagedRuleGroupConfigs(ManagedRuleGroupConfig... managedRuleGroupConfigs)
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud
prevention managed rule group. The configuration includes the registration and sign-up pages of your application
and the locations in the account creation request payload of data, such as the user email and phone number
fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention
managed rule group. The configuration includes the sign-in page of your application and the locations in the
login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that
you want the Bot Control rule group to use.
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.
managedRuleGroupConfigs - Additional information that's used by a managed rule group. Many managed rule groups don't require
this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation
fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your
application and the locations in the account creation request payload of data, such as the user email and
phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover
prevention managed rule group. The configuration includes the sign-in page of your application and the
locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection
level that you want the Bot Control rule group to use.
public ManagedRuleGroupStatement withManagedRuleGroupConfigs(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs)
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud
prevention managed rule group. The configuration includes the registration and sign-up pages of your application
and the locations in the account creation request payload of data, such as the user email and phone number
fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention
managed rule group. The configuration includes the sign-in page of your application and the locations in the
login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that
you want the Bot Control rule group to use.
managedRuleGroupConfigs - Additional information that's used by a managed rule group. Many managed rule groups don't require
this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation
fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your
application and the locations in the account creation request payload of data, such as the user email and
phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover
prevention managed rule group. The configuration includes the sign-in page of your application and the
locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection
level that you want the Bot Control rule group to use.
public List<RuleActionOverride> getRuleActionOverrides()
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and
then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule group manages your web traffic.
You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web
traffic. You can also permanently override some or all actions, to modify how the rule group manages your
web traffic.
public void setRuleActionOverrides(Collection<RuleActionOverride> ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and
then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule group manages your web traffic.
ruleActionOverrides - Action settings to use in the place of the rule actions that are configured inside the rule group. You
specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web
traffic. You can also permanently override some or all actions, to modify how the rule group manages your
web traffic.
public ManagedRuleGroupStatement withRuleActionOverrides(RuleActionOverride... ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and
then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule group manages your web traffic.
NOTE: This method appends the values to the existing list (if any). Use
setRuleActionOverrides(java.util.Collection) or withRuleActionOverrides(java.util.Collection)
if you want to override the existing values.
ruleActionOverrides - Action settings to use in the place of the rule actions that are configured inside the rule group. You
specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web
traffic. You can also permanently override some or all actions, to modify how the rule group manages your
web traffic.
public ManagedRuleGroupStatement withRuleActionOverrides(Collection<RuleActionOverride> ruleActionOverrides)
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and
then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule group manages your web traffic.
ruleActionOverrides - Action settings to use in the place of the rule actions that are configured inside the rule group. You
specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web
traffic. You can also permanently override some or all actions, to modify how the rule group manages your
web traffic.
public String toString()
toString in class ObjectObject.toString()public ManagedRuleGroupStatement clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.