Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty>
Enclosing interface:
CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty
@Stability(Stable) public static final class CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty>
A builder for CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • excludedRules

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder excludedRules(IResolvable excludedRules)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getExcludedRules()
      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:
      this

    • excludedRules

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder excludedRules(List<? extends Object> excludedRules)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getExcludedRules()
      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:
      this

    • managedRuleGroupConfigs

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder managedRuleGroupConfigs(IResolvable managedRuleGroupConfigs)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getManagedRuleGroupConfigs()
      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 AWSManagedRulesAntiDDoSRuleSet configuration object to configure the anti-DDoS managed rule group. The configuration includes the sensitivity levels to use in the rules that typically block and challenge requests that might be participating in DDoS attacks and the specification to use to indicate whether a request can handle a silent browser challenge.
      • 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:
      this

    • managedRuleGroupConfigs

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder managedRuleGroupConfigs(List<? extends Object> managedRuleGroupConfigs)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getManagedRuleGroupConfigs()
      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 AWSManagedRulesAntiDDoSRuleSet configuration object to configure the anti-DDoS managed rule group. The configuration includes the sensitivity levels to use in the rules that typically block and challenge requests that might be participating in DDoS attacks and the specification to use to indicate whether a request can handle a silent browser challenge.
      • 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:
      this

    • name

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder name(String name)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getName()
      Parameters:
      name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
      Returns:
      this

    • ruleActionOverrides

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder ruleActionOverrides(IResolvable ruleActionOverrides)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getRuleActionOverrides()
      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.

      Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

      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:
      this

    • ruleActionOverrides

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder ruleActionOverrides(List<? extends Object> ruleActionOverrides)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getRuleActionOverrides()
      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.

      Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

      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:
      this

    • scopeDownStatement

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder scopeDownStatement(IResolvable scopeDownStatement)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getScopeDownStatement()
      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:
      this

    • scopeDownStatement

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder scopeDownStatement(CfnWebACLPropsMixin.StatementProperty scopeDownStatement)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getScopeDownStatement()
      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:
      this

    • vendorName

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder vendorName(String vendorName)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getVendorName()
      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:
      this

    • version

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.Builder version(String version)
      Sets the value of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty.getVersion()
      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, AWS 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:
      this

    • build

      @Stability(Stable) public CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty>
      Returns:
      a new instance of CfnWebACLPropsMixin.ManagedRuleGroupStatementProperty
      Throws:
      NullPointerException - if any required attribute was not provided