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

Interface RateBasedStatementCustomKey.Builder

    • Method Detail

      • header

        RateBasedStatementCustomKey.Builder header​(RateLimitHeader header)

        Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

        Parameters:
        header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cookie

        RateBasedStatementCustomKey.Builder cookie​(RateLimitCookie cookie)

        Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

        Parameters:
        cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryArgument

        RateBasedStatementCustomKey.Builder queryArgument​(RateLimitQueryArgument queryArgument)

        Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

        Parameters:
        queryArgument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryString

        RateBasedStatementCustomKey.Builder queryString​(RateLimitQueryString queryString)

        Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

        Parameters:
        queryString - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • httpMethod

        RateBasedStatementCustomKey.Builder httpMethod​(RateLimitHTTPMethod httpMethod)

        Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

        Parameters:
        httpMethod - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forwardedIP

        RateBasedStatementCustomKey.Builder forwardedIP​(RateLimitForwardedIP forwardedIP)

        Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

        When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

        With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

        Parameters:
        forwardedIP - Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

        When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

        With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

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

      • ip

        RateBasedStatementCustomKey.Builder ip​(RateLimitIP ip)

        Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

        When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

        Parameters:
        ip - Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

        When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

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

      • ip

        default RateBasedStatementCustomKey.Builder ip​(Consumer<RateLimitIP.Builder> ip)

        Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

        When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ip(RateLimitIP).

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

      • labelNamespace

        RateBasedStatementCustomKey.Builder labelNamespace​(RateLimitLabelNamespace labelNamespace)

        Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

        This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

        For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

        Parameters:
        labelNamespace - Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

        This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

        For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

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

      • uriPath

        RateBasedStatementCustomKey.Builder uriPath​(RateLimitUriPath uriPath)

        Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

        Parameters:
        uriPath - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.