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

Interface CreateRateBasedRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>, SdkBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>, SdkPojo, SdkRequest.Builder, WafRequest.Builder
Enclosing class:
CreateRateBasedRuleRequest
public static interface CreateRateBasedRuleRequest.Builder extends WafRequest.Builder, SdkPojo, CopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>

  • Method Details

    • name

      CreateRateBasedRuleRequest.Builder name(String name)

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

      Parameters:
      name - A friendly name or description of the 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

      CreateRateBasedRuleRequest.Builder metricName(String metricName)

      A friendly name or description for the metrics for this 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 this 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.

    • rateKey

      CreateRateBasedRuleRequest.Builder rateKey(String rateKey)

      The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive 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 a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive 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

      CreateRateBasedRuleRequest.Builder rateKey(RateKey rateKey)

      The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive 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 a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive 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

      CreateRateBasedRuleRequest.Builder rateLimit(Long rateLimit)

      The maximum number of requests, which have an identical value in the field that is specified by 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 that is specified by 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.

    • changeToken

      CreateRateBasedRuleRequest.Builder changeToken(String changeToken)

      The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

      Parameters:
      changeToken - The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRateBasedRuleRequest.Builder tags(Collection<Tag> tags)

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

    • tags

      CreateRateBasedRuleRequest.Builder tags(Tag... tags)

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

    • tags

      CreateRateBasedRuleRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

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

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

    • overrideConfiguration

      CreateRateBasedRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateRateBasedRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.