Package software.amazon.awssdk.services.wafv2.model

Interface ManagedRuleGroupStatement.Builder

    • Method Detail

      • vendorName

        ManagedRuleGroupStatement.Builder vendorName​(String 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

        ManagedRuleGroupStatement.Builder name​(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.

      • version

        ManagedRuleGroupStatement.Builder version​(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.

      • excludedRules

        ManagedRuleGroupStatement.Builder excludedRules​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludedRules

        ManagedRuleGroupStatement.Builder excludedRules​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludedRules

        ManagedRuleGroupStatement.Builder excludedRules​(Consumer<ExcludedRule.Builder>... 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.

        This is a convenience method that creates an instance of the ExcludedRule.Builder avoiding the need to create one manually via ExcludedRule.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #excludedRules(List).

        Parameters:
        excludedRules - a consumer that will call methods on ExcludedRule.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #excludedRules(java.util.Collection)

      • scopeDownStatement

        ManagedRuleGroupStatement.Builder scopeDownStatement​(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.

      • 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.

        This is a convenience method that creates an instance of the ManagedRuleGroupConfig.Builder avoiding the need to create one manually via ManagedRuleGroupConfig.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #managedRuleGroupConfigs(List).

        Parameters:
        managedRuleGroupConfigs - a consumer that will call methods on ManagedRuleGroupConfig.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #managedRuleGroupConfigs(java.util.Collection)

      • 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

        ManagedRuleGroupStatement.Builder ruleActionOverrides​(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

        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 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.

        This is a convenience method that creates an instance of the RuleActionOverride.Builder avoiding the need to create one manually via RuleActionOverride.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #ruleActionOverrides(List).

        Parameters:
        ruleActionOverrides - a consumer that will call methods on RuleActionOverride.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #ruleActionOverrides(java.util.Collection)