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

Class AWSManagedRulesACFPRuleSet

java.lang.Object

software.amazon.awssdk.services.wafv2.model.AWSManagedRulesACFPRuleSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>

@Generated("software.amazon.awssdk:codegen")
public final class AWSManagedRulesACFPRuleSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>

Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AWSManagedRulesACFPRuleSet.Builder

Method Summary

Modifier and Type	Method	Description
static AWSManagedRulesACFPRuleSet.Builder	builder()
String	creationPath()	The path of the account creation endpoint for your application.
Boolean	enableRegexInPath()	Allow the use of regular expressions in the registration page path and the account creation path.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	registrationPagePath()	The path of the account registration endpoint for your application.
RequestInspectionACFP	requestInspection()	The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
ResponseInspection	responseInspection()	The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
List<SdkField<?>>	sdkFields()
static Class<? extends AWSManagedRulesACFPRuleSet.Builder>	serializableBuilderClass()
AWSManagedRulesACFPRuleSet.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

creationPath

public final String creationPath()

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

For example, for the URL https://example.com/web/newaccount, you would provide the path /web/newaccount. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount matches the account creation paths /web/newaccount, /web/newaccount/, /web/newaccountPage, and /web/newaccount/thisPage, but doesn't match the path /home/web/newaccount or /website/newaccount.

Returns:

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

For example, for the URL https://example.com/web/newaccount, you would provide the path /web/newaccount. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount matches the account creation paths /web/newaccount, /web/newaccount/, /web/newaccountPage, and /web/newaccount/thisPage, but doesn't match the path /home/web/newaccount or /website/newaccount.

registrationPagePath

public final String registrationPagePath()

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

This page must accept GET text/html requests.

For example, for the URL https://example.com/web/registration, you would provide the path /web/registration. Registration page paths that start with the path that you provide are considered a match. For example /web/registration matches the registration paths /web/registration, /web/registration/, /web/registrationPage, and /web/registration/thisPage, but doesn't match the path /home/web/registration or /website/registration.

Returns:

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

This page must accept GET text/html requests.

For example, for the URL https://example.com/web/registration, you would provide the path /web/registration. Registration page paths that start with the path that you provide are considered a match. For example /web/registration matches the registration paths /web/registration, /web/registration/, /web/registrationPage, and /web/registration/thisPage, but doesn't match the path /home/web/registration or /website/registration.

requestInspection

public final RequestInspectionACFP requestInspection()

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

Returns:

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

responseInspection

public final ResponseInspection responseInspection()

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

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

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from 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 successful account creation attempts in a short amount of time.

Returns:

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

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

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from 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 successful account creation attempts in a short amount of time.

enableRegexInPath

public final Boolean enableRegexInPath()

Allow the use of regular expressions in the registration page path and the account creation path.

Returns:

Allow the use of regular expressions in the registration page path and the account creation path.

toBuilder

public AWSManagedRulesACFPRuleSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>

builder

public static AWSManagedRulesACFPRuleSet.Builder builder()

serializableBuilderClass

public static Class<? extends AWSManagedRulesACFPRuleSet.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