AWSManagedRulesATPRuleSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.AWSManagedRulesATPRuleSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSManagedRulesATPRuleSet
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AWSManagedRulesATPRuleSet()

Constructors
Constructor and Description
`AWSManagedRulesATPRuleSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AWSManagedRulesATPRuleSet`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEnableRegexInPath()` Allow the use of regular expressions in the login page path.
`String`	`getLoginPath()` The path of the login endpoint for your application.
`RequestInspection`	`getRequestInspection()` The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
`ResponseInspection`	`getResponseInspection()` The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
`int`	`hashCode()`
`Boolean`	`isEnableRegexInPath()` Allow the use of regular expressions in the login page path.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEnableRegexInPath(Boolean enableRegexInPath)` Allow the use of regular expressions in the login page path.
`void`	`setLoginPath(String loginPath)` The path of the login endpoint for your application.
`void`	`setRequestInspection(RequestInspection requestInspection)` The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
`void`	`setResponseInspection(ResponseInspection responseInspection)` The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
`String`	`toString()` Returns a string representation of this object.
`AWSManagedRulesATPRuleSet`	`withEnableRegexInPath(Boolean enableRegexInPath)` Allow the use of regular expressions in the login page path.
`AWSManagedRulesATPRuleSet`	`withLoginPath(String loginPath)` The path of the login endpoint for your application.
`AWSManagedRulesATPRuleSet`	`withRequestInspection(RequestInspection requestInspection)` The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
`AWSManagedRulesATPRuleSet`	`withResponseInspection(ResponseInspection responseInspection)` The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AWSManagedRulesATPRuleSet
```
public AWSManagedRulesATPRuleSet()
```
- Method Detail
  - setLoginPath
```
public void setLoginPath(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.
  - getLoginPath
```
public String getLoginPath()
```
    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.
  - withLoginPath
```
public AWSManagedRulesATPRuleSet withLoginPath(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.
  - setRequestInspection
```
public void setRequestInspection(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.
  - getRequestInspection
```
public RequestInspection getRequestInspection()
```
    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.
  - withRequestInspection
```
public AWSManagedRulesATPRuleSet withRequestInspection(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.
  - setResponseInspection
```
public void setResponseInspection(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.
  - getResponseInspection
```
public ResponseInspection getResponseInspection()
```
    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.
  - withResponseInspection
```
public AWSManagedRulesATPRuleSet withResponseInspection(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.
  - setEnableRegexInPath
```
public void setEnableRegexInPath(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.
  - getEnableRegexInPath
```
public Boolean getEnableRegexInPath()
```
    Allow the use of regular expressions in the login page path.
    
    Returns:
    
    Allow the use of regular expressions in the login page path.
  - withEnableRegexInPath
```
public AWSManagedRulesATPRuleSet withEnableRegexInPath(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.
  - isEnableRegexInPath
```
public Boolean isEnableRegexInPath()
```
    Allow the use of regular expressions in the login page path.
    
    Returns:
    
    Allow the use of regular expressions in the login page path.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AWSManagedRulesATPRuleSet clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class AWSManagedRulesATPRuleSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AWSManagedRulesATPRuleSet

Method Detail

setLoginPath

getLoginPath

withLoginPath

setRequestInspection

getRequestInspection

withRequestInspection

setResponseInspection

getResponseInspection

withResponseInspection

setEnableRegexInPath

getEnableRegexInPath

withEnableRegexInPath

isEnableRegexInPath

toString

equals

hashCode

clone

marshall