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

Interface AWSManagedRulesATPRuleSet.Builder

    • Method Detail

      • loginPath

        AWSManagedRulesATPRuleSet.Builder loginPath​(String loginPath)

        The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.

        The rule group inspects only HTTP POST requests to your specified login endpoint.

        Parameters:
        loginPath - The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.

        The rule group inspects only HTTP POST requests to your specified login endpoint.

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

      • requestInspection

        AWSManagedRulesATPRuleSet.Builder requestInspection​(RequestInspection requestInspection)

        The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

        Parameters:
        requestInspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • responseInspection

        AWSManagedRulesATPRuleSet.Builder responseInspection​(ResponseInspection responseInspection)

        The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

        Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

        The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

        Parameters:
        responseInspection - The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

        Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

        The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

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

      • responseInspection

        default AWSManagedRulesATPRuleSet.Builder responseInspection​(Consumer<ResponseInspection.Builder> responseInspection)

        The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

        Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

        The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

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

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

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

      • enableRegexInPath

        AWSManagedRulesATPRuleSet.Builder enableRegexInPath​(Boolean enableRegexInPath)

        Allow the use of regular expressions in the login page path.

        Parameters:
        enableRegexInPath - Allow the use of regular expressions in the login page path.
        Returns:
        Returns a reference to this object so that method calls can be chained together.