software.amazon.awssdk.services.wafv2.model

Interface AWSManagedRulesACFPRuleSet.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>, SdkBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>, SdkPojo

Enclosing class:

AWSManagedRulesACFPRuleSet

public static interface AWSManagedRulesACFPRuleSet.Builder
extends SdkPojo, CopyableBuilder<AWSManagedRulesACFPRuleSet.Builder,AWSManagedRulesACFPRuleSet>

Method Summary

Modifier and Type	Method and Description
AWSManagedRulesACFPRuleSet.Builder	creationPath(String creationPath) The path of the account creation endpoint for your application.
AWSManagedRulesACFPRuleSet.Builder	enableRegexInPath(Boolean enableRegexInPath) Allow the use of regular expressions in the registration page path and the account creation path.
AWSManagedRulesACFPRuleSet.Builder	registrationPagePath(String registrationPagePath) The path of the account registration endpoint for your application.
default AWSManagedRulesACFPRuleSet.Builder	requestInspection(Consumer<RequestInspectionACFP.Builder> requestInspection) The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
AWSManagedRulesACFPRuleSet.Builder	requestInspection(RequestInspectionACFP requestInspection) The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
default AWSManagedRulesACFPRuleSet.Builder	responseInspection(Consumer<ResponseInspection.Builder> responseInspection) The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
AWSManagedRulesACFPRuleSet.Builder	responseInspection(ResponseInspection responseInspection) The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

creationPath

AWSManagedRulesACFPRuleSet.Builder creationPath(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

registrationPagePath

AWSManagedRulesACFPRuleSet.Builder registrationPagePath(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

requestInspection

AWSManagedRulesACFPRuleSet.Builder requestInspection(RequestInspectionACFP requestInspection)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requestInspection

default AWSManagedRulesACFPRuleSet.Builder requestInspection(Consumer<RequestInspectionACFP.Builder> requestInspection)

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

This is a convenience method that creates an instance of the RequestInspectionACFP.Builder avoiding the need to create one manually via RequestInspectionACFP.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requestInspection(RequestInspectionACFP).

Parameters:

requestInspection - a consumer that will call methods on RequestInspectionACFP.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

requestInspection(RequestInspectionACFP)

responseInspection

AWSManagedRulesACFPRuleSet.Builder responseInspection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

responseInspection

default AWSManagedRulesACFPRuleSet.Builder responseInspection(Consumer<ResponseInspection.Builder> 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.

This is a convenience method that creates an instance of the ResponseInspection.Builder avoiding the need to create one manually via ResponseInspection.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to responseInspection(ResponseInspection).

Parameters:

responseInspection - a consumer that will call methods on ResponseInspection.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

responseInspection(ResponseInspection)

enableRegexInPath

AWSManagedRulesACFPRuleSet.Builder enableRegexInPath(Boolean enableRegexInPath)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.