/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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.
*
* 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.
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule * group. *
*/ private String vendorName; /** ** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. *
*/ private String name; /** ** 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. *
*/ private String version; /** *
* 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
.
*
* 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. *
*/ private Statement scopeDownStatement; /** ** 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.
*
* 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.
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule * group. *
* * @param 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 setVendorName(String vendorName) { this.vendorName = vendorName; } /** ** The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule * group. *
* * @return 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() { return this.vendorName; } /** ** The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule * group. *
* * @param vendorName * The name of the managed rule group vendor. You use this, along with the rule group name, to identify a * rule group. * @return Returns a reference to this object so that method calls can be chained together. */ public ManagedRuleGroupStatement withVendorName(String vendorName) { setVendorName(vendorName); return this; } /** ** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. *
* * @param name * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. */ public void setName(String name) { this.name = name; } /** ** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. *
* * @return The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. */ public String getName() { return this.name; } /** ** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. *
* * @param name * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. * @return Returns a reference to this object so that method calls can be chained together. */ public ManagedRuleGroupStatement withName(String name) { setName(name); return this; } /** ** 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. *
* * @param 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 void setVersion(String version) { this.version = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ManagedRuleGroupStatement withVersion(String version) { setVersion(version); return this; } /** *
* 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
.
*
* 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
.
*
* 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 * {@link #setExcludedRules(java.util.Collection)} or {@link #withExcludedRules(java.util.Collection)} if you want * to override the existing values. *
* * @param excludedRules * Rules in the referenced rule group whose actions are set toCount
.
* Instead of this option, use RuleActionOverrides
. It accepts any valid action setting,
* including Count
.
*
* 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
.
*
* 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. *
* * @param 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 void setScopeDownStatement(Statement scopeDownStatement) { this.scopeDownStatement = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ManagedRuleGroupStatement withScopeDownStatement(Statement scopeDownStatement) { setScopeDownStatement(scopeDownStatement); return this; } /** ** 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.
*
* 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.
*
* 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 * {@link #setManagedRuleGroupConfigs(java.util.Collection)} or * {@link #withManagedRuleGroupConfigs(java.util.Collection)} if you want to override the existing values. *
* * @param 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.
*
* 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.
*
* 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
* 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 java.util.ListCount
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
* 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
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRuleActionOverrides(java.util.Collection)} or {@link #withRuleActionOverrides(java.util.Collection)}
* if you want to override the existing values.
* 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(java.util.CollectionCount
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
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ManagedRuleGroupStatement withRuleActionOverrides(RuleActionOverride... ruleActionOverrides) {
if (this.ruleActionOverrides == null) {
setRuleActionOverrides(new java.util.ArrayListCount
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ManagedRuleGroupStatement withRuleActionOverrides(java.util.Collection