Interface RuleGroupReferenceStatement.Builder

  • Method Details

    • arn

      The Amazon Resource Name (ARN) of the entity.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the entity.
      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, 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

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

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

      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:
    • ruleActionOverrides

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

      Verify the rule names in your overrides carefully. With managed rule groups, 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.

      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, 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:
      Returns a reference to this object so that method calls can be chained together.
    • ruleActionOverrides

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

      Verify the rule names in your overrides carefully. With managed rule groups, 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.

      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, 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:
      Returns a reference to this object so that method calls can be chained together.
    • ruleActionOverrides

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

      Verify the rule names in your overrides carefully. With managed rule groups, 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.

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

      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: