Package software.amazon.awssdk.services.waf.model

Interface RateBasedRule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RateBasedRule.Builder,RateBasedRule>, SdkBuilder<RateBasedRule.Builder,RateBasedRule>, SdkPojo
Enclosing class:
RateBasedRule
public static interface RateBasedRule.Builder extends SdkPojo, CopyableBuilder<RateBasedRule.Builder,RateBasedRule>

  • Method Details

    • ruleId

      RateBasedRule.Builder ruleId(String ruleId)

      A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

      Parameters:
      ruleId - A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      RateBasedRule.Builder name(String name)

      A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

      Parameters:
      name - A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricName

      RateBasedRule.Builder metricName(String metricName)

      A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

      Parameters:
      metricName - A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchPredicates

      RateBasedRule.Builder matchPredicates(Collection<Predicate> matchPredicates)

      The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

      Parameters:
      matchPredicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchPredicates

      RateBasedRule.Builder matchPredicates(Predicate... matchPredicates)

      The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

      Parameters:
      matchPredicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchPredicates

      RateBasedRule.Builder matchPredicates(Consumer<Predicate.Builder>... matchPredicates)

      The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchPredicates(List<Predicate>).

      Parameters:
      matchPredicates - a consumer that will call methods on Predicate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rateKey

      RateBasedRule.Builder rateKey(String rateKey)

      The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

      Parameters:
      rateKey - The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rateKey

      RateBasedRule.Builder rateKey(RateKey rateKey)

      The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

      Parameters:
      rateKey - The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rateLimit

      RateBasedRule.Builder rateLimit(Long rateLimit)

      The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

      Parameters:
      rateLimit - The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.