Class AWSManagedRulesATPRuleSet
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
Allow the use of regular expressions in the login page path.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The path of the login endpoint for your application.final RequestInspection
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.final ResponseInspection
The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.static Class
<? extends AWSManagedRulesATPRuleSet.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
Allow the use of regular expressions in the login page path.
- Returns:
- Allow the use of regular expressions in the login page path.
-
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 interfaceToCopyableBuilder<AWSManagedRulesATPRuleSet.Builder,
AWSManagedRulesATPRuleSet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-