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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AWSManagedRulesATPRuleSet.Builder

Method Summary

Modifier and Type	Method	Description
static AWSManagedRulesATPRuleSet.Builder	builder()
Boolean	enableRegexInPath()	Allow the use of regular expressions in the login page path.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	loginPath()	The path of the login endpoint for your application.
RequestInspection	requestInspection()	The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
ResponseInspection	responseInspection()	The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AWSManagedRulesATPRuleSet.Builder>	serializableBuilderClass()
AWSManagedRulesATPRuleSet.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AWSManagedRulesATPRuleSet.Builder,AWSManagedRulesATPRuleSet>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo