/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSManagedRulesACFPRuleSet implements Serializable, Cloneable, StructuredPojo { /** *

* 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/signup, you would provide the path * /web/signup. *

*/ private String creationPath; /** *

* 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/register, you would provide the path * /web/register. *

*/ private String registrationPagePath; /** *

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

*/ private RequestInspectionACFP requestInspection; /** *

* 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. *

*/ private ResponseInspection responseInspection; /** *

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

*/ private Boolean enableRegexInPath; /** *

* 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/signup, you would provide the path * /web/signup. *

* * @param 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/signup, you would provide the path * /web/signup. */ public void setCreationPath(String creationPath) { this.creationPath = 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/signup, you would provide the path * /web/signup. *

* * @return 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/signup, you would provide the path * /web/signup. */ public String getCreationPath() { return this.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/signup, you would provide the path * /web/signup. *

* * @param 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/signup, you would provide the path * /web/signup. * @return Returns a reference to this object so that method calls can be chained together. */ public AWSManagedRulesACFPRuleSet withCreationPath(String creationPath) { setCreationPath(creationPath); return this; } /** *

* 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/register, you would provide the path * /web/register. *

* * @param 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/register, you would provide the path * /web/register. */ public void setRegistrationPagePath(String registrationPagePath) { this.registrationPagePath = 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/register, you would provide the path * /web/register. *

* * @return 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/register, you would provide the path * /web/register. */ public String getRegistrationPagePath() { return this.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/register, you would provide the path * /web/register. *

* * @param 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/register, you would provide the path * /web/register. * @return Returns a reference to this object so that method calls can be chained together. */ public AWSManagedRulesACFPRuleSet withRegistrationPagePath(String registrationPagePath) { setRegistrationPagePath(registrationPagePath); return this; } /** *

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

* * @param requestInspection * The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track * account creation attempts. */ public void setRequestInspection(RequestInspectionACFP requestInspection) { this.requestInspection = requestInspection; } /** *

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

* * @return The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track * account creation attempts. */ public RequestInspectionACFP getRequestInspection() { return this.requestInspection; } /** *

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

* * @param requestInspection * The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track * account creation attempts. * @return Returns a reference to this object so that method calls can be chained together. */ public AWSManagedRulesACFPRuleSet withRequestInspection(RequestInspectionACFP requestInspection) { setRequestInspection(requestInspection); return this; } /** *

* 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. *

* * @param 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. */ public void setResponseInspection(ResponseInspection responseInspection) { this.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. *

* * @return 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. */ public ResponseInspection getResponseInspection() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public AWSManagedRulesACFPRuleSet withResponseInspection(ResponseInspection responseInspection) { setResponseInspection(responseInspection); return this; } /** *

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

* * @param enableRegexInPath * Allow the use of regular expressions in the registration page path and the account creation path. */ public void setEnableRegexInPath(Boolean enableRegexInPath) { this.enableRegexInPath = enableRegexInPath; } /** *

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

* * @return Allow the use of regular expressions in the registration page path and the account creation path. */ public Boolean getEnableRegexInPath() { return this.enableRegexInPath; } /** *

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

* * @param enableRegexInPath * Allow the use of regular expressions in the registration page path and the account creation path. * @return Returns a reference to this object so that method calls can be chained together. */ public AWSManagedRulesACFPRuleSet withEnableRegexInPath(Boolean enableRegexInPath) { setEnableRegexInPath(enableRegexInPath); return this; } /** *

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

* * @return Allow the use of regular expressions in the registration page path and the account creation path. */ public Boolean isEnableRegexInPath() { return this.enableRegexInPath; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getCreationPath() != null) sb.append("CreationPath: ").append(getCreationPath()).append(","); if (getRegistrationPagePath() != null) sb.append("RegistrationPagePath: ").append(getRegistrationPagePath()).append(","); if (getRequestInspection() != null) sb.append("RequestInspection: ").append(getRequestInspection()).append(","); if (getResponseInspection() != null) sb.append("ResponseInspection: ").append(getResponseInspection()).append(","); if (getEnableRegexInPath() != null) sb.append("EnableRegexInPath: ").append(getEnableRegexInPath()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AWSManagedRulesACFPRuleSet == false) return false; AWSManagedRulesACFPRuleSet other = (AWSManagedRulesACFPRuleSet) obj; if (other.getCreationPath() == null ^ this.getCreationPath() == null) return false; if (other.getCreationPath() != null && other.getCreationPath().equals(this.getCreationPath()) == false) return false; if (other.getRegistrationPagePath() == null ^ this.getRegistrationPagePath() == null) return false; if (other.getRegistrationPagePath() != null && other.getRegistrationPagePath().equals(this.getRegistrationPagePath()) == false) return false; if (other.getRequestInspection() == null ^ this.getRequestInspection() == null) return false; if (other.getRequestInspection() != null && other.getRequestInspection().equals(this.getRequestInspection()) == false) return false; if (other.getResponseInspection() == null ^ this.getResponseInspection() == null) return false; if (other.getResponseInspection() != null && other.getResponseInspection().equals(this.getResponseInspection()) == false) return false; if (other.getEnableRegexInPath() == null ^ this.getEnableRegexInPath() == null) return false; if (other.getEnableRegexInPath() != null && other.getEnableRegexInPath().equals(this.getEnableRegexInPath()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCreationPath() == null) ? 0 : getCreationPath().hashCode()); hashCode = prime * hashCode + ((getRegistrationPagePath() == null) ? 0 : getRegistrationPagePath().hashCode()); hashCode = prime * hashCode + ((getRequestInspection() == null) ? 0 : getRequestInspection().hashCode()); hashCode = prime * hashCode + ((getResponseInspection() == null) ? 0 : getResponseInspection().hashCode()); hashCode = prime * hashCode + ((getEnableRegexInPath() == null) ? 0 : getEnableRegexInPath().hashCode()); return hashCode; } @Override public AWSManagedRulesACFPRuleSet clone() { try { return (AWSManagedRulesACFPRuleSet) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.wafv2.model.transform.AWSManagedRulesACFPRuleSetMarshaller.getInstance().marshall(this, protocolMarshaller); } }