Interface ManagedRuleGroupStatement.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ManagedRuleGroupStatement.Builder,
,ManagedRuleGroupStatement> SdkBuilder<ManagedRuleGroupStatement.Builder,
,ManagedRuleGroupStatement> SdkPojo
- Enclosing class:
ManagedRuleGroupStatement
-
Method Summary
Modifier and TypeMethodDescriptionexcludedRules
(Collection<ExcludedRule> excludedRules) Rules in the referenced rule group whose actions are set toCount
.excludedRules
(Consumer<ExcludedRule.Builder>... excludedRules) Rules in the referenced rule group whose actions are set toCount
.excludedRules
(ExcludedRule... excludedRules) Rules in the referenced rule group whose actions are set toCount
.managedRuleGroupConfigs
(Collection<ManagedRuleGroupConfig> managedRuleGroupConfigs) Additional information that's used by a managed rule group.managedRuleGroupConfigs
(Consumer<ManagedRuleGroupConfig.Builder>... managedRuleGroupConfigs) Additional information that's used by a managed rule group.managedRuleGroupConfigs
(ManagedRuleGroupConfig... managedRuleGroupConfigs) Additional information that's used by a managed rule group.The name of the managed rule group.ruleActionOverrides
(Collection<RuleActionOverride> ruleActionOverrides) Action settings to use in the place of the rule actions that are configured inside the rule group.ruleActionOverrides
(Consumer<RuleActionOverride.Builder>... ruleActionOverrides) Action settings to use in the place of the rule actions that are configured inside the rule group.ruleActionOverrides
(RuleActionOverride... ruleActionOverrides) Action settings to use in the place of the rule actions that are configured inside the rule group.scopeDownStatement
(Consumer<Statement.Builder> scopeDownStatement) An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.scopeDownStatement
(Statement scopeDownStatement) An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.vendorName
(String vendorName) The name of the managed rule group vendor.The version of the managed rule group to use.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
vendorName
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- Parameters:
vendorName
- The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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, includingCount
.- Parameters:
excludedRules
- Rules in the referenced rule group whose actions are set toCount
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, includingCount
.- Parameters:
excludedRules
- Rules in the referenced rule group whose actions are set toCount
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, includingCount
.ExcludedRule.Builder
avoiding the need to create one manually viaExcludedRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexcludedRules(List<ExcludedRule>)
.- Parameters:
excludedRules
- a consumer that will call methods onExcludedRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
scopeDownStatement
default ManagedRuleGroupStatement.Builder scopeDownStatement(Consumer<Statement.Builder> 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.
This is a convenience method that creates an instance of theStatement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscopeDownStatement(Statement)
.- Parameters:
scopeDownStatement
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
managedRuleGroupConfigs
ManagedRuleGroupStatement.Builder managedRuleGroupConfigs(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
managedRuleGroupConfigs
ManagedRuleGroupStatement.Builder managedRuleGroupConfigs(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
managedRuleGroupConfigs
ManagedRuleGroupStatement.Builder managedRuleGroupConfigs(Consumer<ManagedRuleGroupConfig.Builder>... 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.
ManagedRuleGroupConfig.Builder
avoiding the need to create one manually viaManagedRuleGroupConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanagedRuleGroupConfigs(List<ManagedRuleGroupConfig>)
.- Parameters:
managedRuleGroupConfigs
- a consumer that will call methods onManagedRuleGroupConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
ruleActionOverrides
ManagedRuleGroupStatement.Builder ruleActionOverrides(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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleActionOverrides
ManagedRuleGroupStatement.Builder ruleActionOverrides(Consumer<RuleActionOverride.Builder>... 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
This is a convenience method that creates an instance of theCount
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.RuleActionOverride.Builder
avoiding the need to create one manually viaRuleActionOverride.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruleActionOverrides(List<RuleActionOverride>)
.- Parameters:
ruleActionOverrides
- a consumer that will call methods onRuleActionOverride.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-