Class AWSManagedRulesATPRuleSet

java.lang.Object
software.amazon.awssdk.services.wafv2.model.AWSManagedRulesATPRuleSet
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AWSManagedRulesATPRuleSet.Builder,AWSManagedRulesATPRuleSet>
@Generated("software.amazon.awssdk:codegen") public final class AWSManagedRulesATPRuleSet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AWSManagedRulesATPRuleSet.Builder,AWSManagedRulesATPRuleSet>

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

See Also:

  • Method Details

    • loginPath

      public final 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.

      Returns:
      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.

    • requestInspection

      public final RequestInspection requestInspection()

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

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

    • responseInspection

      public final 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.

      Returns:
      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.

    • enableRegexInPath

      public final Boolean enableRegexInPath()

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

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

    • toBuilder

      public AWSManagedRulesATPRuleSet.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AWSManagedRulesATPRuleSet.Builder,AWSManagedRulesATPRuleSet>
      Returns:
      a builder for type T

    • builder

      public static AWSManagedRulesATPRuleSet.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AWSManagedRulesATPRuleSet.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.