com.amazonaws.services.wafv2.model.WebACL Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that
* defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the
* web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The
* rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can
* associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon
* CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an
* Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WebACL implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
*
*/
private String name;
/**
*
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*
*/
private String aRN;
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*/
private DefaultAction defaultAction;
/**
*
* A description of the web ACL that helps with identification.
*
*/
private String description;
/**
*
* The Rule statements used to identify the web requests that you want to manage. Each rule includes one
* top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles
* them.
*
*/
private java.util.List rules;
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*/
private VisibilityConfig visibilityConfig;
/**
*
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and
* web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule.
* Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule
* group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group.
* For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*/
private Long capacity;
/**
*
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized after these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*/
private java.util.List preProcessFirewallManagerRuleGroups;
/**
*
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized before these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*/
private java.util.List postProcessFirewallManagerRuleGroups;
/**
*
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the
* web ACL or any Firewall Manager rule groups in the web ACL.
*
*/
private Boolean managedByFirewallManager;
/**
*
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and
* the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*
*/
private String labelNamespace;
/**
*
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send a
* custom response to the web request. You define these for the web ACL, and then use them in the rules and default
* actions that you define in the web ACL.
*
*
* For information about customizing web requests and responses, see Customizing web
* requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*/
private java.util.Map customResponseBodies;
/**
*
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*
*/
private CaptchaConfig captchaConfig;
/**
*
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*
*/
private ChallengeConfig challengeConfig;
/**
*
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource
* that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
* domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all
* domains in the token domain list, including their prefixed subdomains.
*
*/
private java.util.List tokenDomains;
/**
*
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF for
* inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified
* Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*
*/
private AssociationConfig associationConfig;
/**
*
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
*
*
* @param name
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
*
*
* @return The name of the web ACL. You cannot change the name of a web ACL after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
*
*
* @param name
* The name of the web ACL. You cannot change the name of a web ACL after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withName(String name) {
setName(name);
return this;
}
/**
*
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*
*
* @param id
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*
*
* @return A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*/
public String getId() {
return this.id;
}
/**
*
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
*
*
* @param id
* A unique identifier for the WebACL. This ID is returned in the responses to create and list
* commands. You use this ID to do things like get, update, and delete a WebACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withId(String id) {
setId(id);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*
*
* @param aRN
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*/
public void setARN(String aRN) {
this.aRN = aRN;
}
/**
*
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*
*
* @return The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*/
public String getARN() {
return this.aRN;
}
/**
*
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
*
*
* @param aRN
* The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withARN(String aRN) {
setARN(aRN);
return this;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @param defaultAction
* The action to perform if none of the Rules contained in the WebACL match.
*/
public void setDefaultAction(DefaultAction defaultAction) {
this.defaultAction = defaultAction;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @return The action to perform if none of the Rules contained in the WebACL match.
*/
public DefaultAction getDefaultAction() {
return this.defaultAction;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @param defaultAction
* The action to perform if none of the Rules contained in the WebACL match.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withDefaultAction(DefaultAction defaultAction) {
setDefaultAction(defaultAction);
return this;
}
/**
*
* A description of the web ACL that helps with identification.
*
*
* @param description
* A description of the web ACL that helps with identification.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the web ACL that helps with identification.
*
*
* @return A description of the web ACL that helps with identification.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the web ACL that helps with identification.
*
*
* @param description
* A description of the web ACL that helps with identification.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to manage. Each rule includes one
* top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles
* them.
*
*
* @return The Rule statements used to identify the web requests that you want to manage. Each rule includes
* one top-level statement that WAF uses to identify matching web requests, and parameters that govern how
* WAF handles them.
*/
public java.util.List getRules() {
return rules;
}
/**
*
* The Rule statements used to identify the web requests that you want to manage. Each rule includes one
* top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles
* them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to manage. Each rule includes
* one top-level statement that WAF uses to identify matching web requests, and parameters that govern how
* WAF handles them.
*/
public void setRules(java.util.Collection rules) {
if (rules == null) {
this.rules = null;
return;
}
this.rules = new java.util.ArrayList(rules);
}
/**
*
* The Rule statements used to identify the web requests that you want to manage. Each rule includes one
* top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles
* them.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to manage. Each rule includes
* one top-level statement that WAF uses to identify matching web requests, and parameters that govern how
* WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withRules(Rule... rules) {
if (this.rules == null) {
setRules(new java.util.ArrayList(rules.length));
}
for (Rule ele : rules) {
this.rules.add(ele);
}
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to manage. Each rule includes one
* top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles
* them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to manage. Each rule includes
* one top-level statement that WAF uses to identify matching web requests, and parameters that govern how
* WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withRules(java.util.Collection rules) {
setRules(rules);
return this;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public void setVisibilityConfig(VisibilityConfig visibilityConfig) {
this.visibilityConfig = visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig getVisibilityConfig() {
return this.visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withVisibilityConfig(VisibilityConfig visibilityConfig) {
setVisibilityConfig(visibilityConfig);
return this;
}
/**
*
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and
* web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule.
* Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule
* group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group.
* For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*
* @param capacity
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost
* of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more
* processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage
* when they use a rule group. For more information, see WAF web ACL
* capacity units (WCU) in the WAF Developer Guide.
*/
public void setCapacity(Long capacity) {
this.capacity = capacity;
}
/**
*
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and
* web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule.
* Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule
* group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group.
* For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*
* @return The web ACL capacity units (WCUs) currently being used by this web ACL.
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative
* cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use
* more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU
* usage when they use a rule group. For more information, see WAF web ACL
* capacity units (WCU) in the WAF Developer Guide.
*/
public Long getCapacity() {
return this.capacity;
}
/**
*
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and
* web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule.
* Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule
* group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group.
* For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*
* @param capacity
* The web ACL capacity units (WCUs) currently being used by this web ACL.
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost
* of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more
* processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage
* when they use a rule group. For more information, see WAF web ACL
* capacity units (WCU) in the WAF Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withCapacity(Long capacity) {
setCapacity(capacity);
return this;
}
/**
*
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized after these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @return The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF
* policy and contains only rule group references. You can't alter these. Any rules and rule groups that you
* define for the web ACL are prioritized after these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
*/
public java.util.List getPreProcessFirewallManagerRuleGroups() {
return preProcessFirewallManagerRuleGroups;
}
/**
*
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized after these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @param preProcessFirewallManagerRuleGroups
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF
* policy and contains only rule group references. You can't alter these. Any rules and rule groups that you
* define for the web ACL are prioritized after these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
*/
public void setPreProcessFirewallManagerRuleGroups(java.util.Collection preProcessFirewallManagerRuleGroups) {
if (preProcessFirewallManagerRuleGroups == null) {
this.preProcessFirewallManagerRuleGroups = null;
return;
}
this.preProcessFirewallManagerRuleGroups = new java.util.ArrayList(preProcessFirewallManagerRuleGroups);
}
/**
*
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized after these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPreProcessFirewallManagerRuleGroups(java.util.Collection)} or
* {@link #withPreProcessFirewallManagerRuleGroups(java.util.Collection)} if you want to override the existing
* values.
*
*
* @param preProcessFirewallManagerRuleGroups
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF
* policy and contains only rule group references. You can't alter these. Any rules and rule groups that you
* define for the web ACL are prioritized after these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withPreProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... preProcessFirewallManagerRuleGroups) {
if (this.preProcessFirewallManagerRuleGroups == null) {
setPreProcessFirewallManagerRuleGroups(new java.util.ArrayList(preProcessFirewallManagerRuleGroups.length));
}
for (FirewallManagerRuleGroup ele : preProcessFirewallManagerRuleGroups) {
this.preProcessFirewallManagerRuleGroups.add(ele);
}
return this;
}
/**
*
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized after these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @param preProcessFirewallManagerRuleGroups
* The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF
* policy and contains only rule group references. You can't alter these. Any rules and rule groups that you
* define for the web ACL are prioritized after these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withPreProcessFirewallManagerRuleGroups(java.util.Collection preProcessFirewallManagerRuleGroups) {
setPreProcessFirewallManagerRuleGroups(preProcessFirewallManagerRuleGroups);
return this;
}
/**
*
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized before these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @return The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF
* policy and contains only rule group references. You can't alter these. Any rules and rule groups that you
* define for the web ACL are prioritized before these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
*/
public java.util.List getPostProcessFirewallManagerRuleGroups() {
return postProcessFirewallManagerRuleGroups;
}
/**
*
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized before these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @param postProcessFirewallManagerRuleGroups
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy
* and contains only rule group references. You can't alter these. Any rules and rule groups that you define
* for the web ACL are prioritized before these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
*/
public void setPostProcessFirewallManagerRuleGroups(java.util.Collection postProcessFirewallManagerRuleGroups) {
if (postProcessFirewallManagerRuleGroups == null) {
this.postProcessFirewallManagerRuleGroups = null;
return;
}
this.postProcessFirewallManagerRuleGroups = new java.util.ArrayList(postProcessFirewallManagerRuleGroups);
}
/**
*
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized before these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPostProcessFirewallManagerRuleGroups(java.util.Collection)} or
* {@link #withPostProcessFirewallManagerRuleGroups(java.util.Collection)} if you want to override the existing
* values.
*
*
* @param postProcessFirewallManagerRuleGroups
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy
* and contains only rule group references. You can't alter these. Any rules and rule groups that you define
* for the web ACL are prioritized before these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withPostProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... postProcessFirewallManagerRuleGroups) {
if (this.postProcessFirewallManagerRuleGroups == null) {
setPostProcessFirewallManagerRuleGroups(new java.util.ArrayList(postProcessFirewallManagerRuleGroups.length));
}
for (FirewallManagerRuleGroup ele : postProcessFirewallManagerRuleGroups) {
this.postProcessFirewallManagerRuleGroups.add(ele);
}
return this;
}
/**
*
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and
* contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web
* ACL are prioritized before these.
*
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run
* first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the
* rule groups, to determine their relative processing order.
*
*
* @param postProcessFirewallManagerRuleGroups
* The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy
* and contains only rule group references. You can't alter these. Any rules and rule groups that you define
* for the web ACL are prioritized before these.
*
* In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to
* run first in the web ACL and a set of rule groups to run last. Within each set, the administrator
* prioritizes the rule groups, to determine their relative processing order.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withPostProcessFirewallManagerRuleGroups(java.util.Collection postProcessFirewallManagerRuleGroups) {
setPostProcessFirewallManagerRuleGroups(postProcessFirewallManagerRuleGroups);
return this;
}
/**
*
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the
* web ACL or any Firewall Manager rule groups in the web ACL.
*
*
* @param managedByFirewallManager
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can
* delete the web ACL or any Firewall Manager rule groups in the web ACL.
*/
public void setManagedByFirewallManager(Boolean managedByFirewallManager) {
this.managedByFirewallManager = managedByFirewallManager;
}
/**
*
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the
* web ACL or any Firewall Manager rule groups in the web ACL.
*
*
* @return Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can
* delete the web ACL or any Firewall Manager rule groups in the web ACL.
*/
public Boolean getManagedByFirewallManager() {
return this.managedByFirewallManager;
}
/**
*
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the
* web ACL or any Firewall Manager rule groups in the web ACL.
*
*
* @param managedByFirewallManager
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can
* delete the web ACL or any Firewall Manager rule groups in the web ACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withManagedByFirewallManager(Boolean managedByFirewallManager) {
setManagedByFirewallManager(managedByFirewallManager);
return this;
}
/**
*
* Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the
* web ACL or any Firewall Manager rule groups in the web ACL.
*
*
* @return Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can
* delete the web ACL or any Firewall Manager rule groups in the web ACL.
*/
public Boolean isManagedByFirewallManager() {
return this.managedByFirewallManager;
}
/**
*
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and
* the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*
*
* @param labelNamespace
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined
* and the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*/
public void setLabelNamespace(String labelNamespace) {
this.labelNamespace = labelNamespace;
}
/**
*
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and
* the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*
*
* @return The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A
* fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is
* defined and the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*/
public String getLabelNamespace() {
return this.labelNamespace;
}
/**
*
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and
* the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
*
*
* @param labelNamespace
* The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
*
*
* -
*
* The syntax for the label namespace prefix for a web ACL is the following:
*
*
* awswaf:<account ID>:webacl:<web ACL name>:
*
*
* -
*
* When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully
* qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined
* and the label from the rule, separated by a colon:
*
*
* <label namespace>:<label from rule>
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withLabelNamespace(String labelNamespace) {
setLabelNamespace(labelNamespace);
return this;
}
/**
*
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send a
* custom response to the web request. You define these for the web ACL, and then use them in the rules and default
* actions that you define in the web ACL.
*
*
* For information about customizing web requests and responses, see Customizing web
* requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @return A map of custom response keys and content bodies. When you create a rule with a block action, you can
* send a custom response to the web request. You define these for the web ACL, and then use them in the
* rules and default actions that you define in the web ACL.
*
* For information about customizing web requests and responses, see Customizing
* web requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
*/
public java.util.Map getCustomResponseBodies() {
return customResponseBodies;
}
/**
*
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send a
* custom response to the web request. You define these for the web ACL, and then use them in the rules and default
* actions that you define in the web ACL.
*
*
* For information about customizing web requests and responses, see Customizing web
* requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @param customResponseBodies
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send
* a custom response to the web request. You define these for the web ACL, and then use them in the rules and
* default actions that you define in the web ACL.
*
* For information about customizing web requests and responses, see Customizing
* web requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
*/
public void setCustomResponseBodies(java.util.Map customResponseBodies) {
this.customResponseBodies = customResponseBodies;
}
/**
*
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send a
* custom response to the web request. You define these for the web ACL, and then use them in the rules and default
* actions that you define in the web ACL.
*
*
* For information about customizing web requests and responses, see Customizing web
* requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @param customResponseBodies
* A map of custom response keys and content bodies. When you create a rule with a block action, you can send
* a custom response to the web request. You define these for the web ACL, and then use them in the rules and
* default actions that you define in the web ACL.
*
* For information about customizing web requests and responses, see Customizing
* web requests and responses in WAF in the WAF Developer Guide.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withCustomResponseBodies(java.util.Map customResponseBodies) {
setCustomResponseBodies(customResponseBodies);
return this;
}
/**
* Add a single CustomResponseBodies entry
*
* @see WebACL#withCustomResponseBodies
* @returns a reference to this object so that method calls can be chained together.
*/
public WebACL addCustomResponseBodiesEntry(String key, CustomResponseBody value) {
if (null == this.customResponseBodies) {
this.customResponseBodies = new java.util.HashMap();
}
if (this.customResponseBodies.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.customResponseBodies.put(key, value);
return this;
}
/**
* Removes all the entries added into CustomResponseBodies.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL clearCustomResponseBodiesEntries() {
this.customResponseBodies = null;
return this;
}
/**
*
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*
*
* @param captchaConfig
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*/
public void setCaptchaConfig(CaptchaConfig captchaConfig) {
this.captchaConfig = captchaConfig;
}
/**
*
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*
*
* @return Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*/
public CaptchaConfig getCaptchaConfig() {
return this.captchaConfig;
}
/**
*
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
*
*
* @param captchaConfig
* Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
* CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
* CaptchaConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withCaptchaConfig(CaptchaConfig captchaConfig) {
setCaptchaConfig(captchaConfig);
return this;
}
/**
*
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*
*
* @param challengeConfig
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*/
public void setChallengeConfig(ChallengeConfig challengeConfig) {
this.challengeConfig = challengeConfig;
}
/**
*
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*
*
* @return Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*/
public ChallengeConfig getChallengeConfig() {
return this.challengeConfig;
}
/**
*
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
*
*
* @param challengeConfig
* Specifies how WAF should handle challenge evaluations for rules that don't have their own
* ChallengeConfig settings. If you don't specify this, WAF uses its default settings for
* ChallengeConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withChallengeConfig(ChallengeConfig challengeConfig) {
setChallengeConfig(challengeConfig);
return this;
}
/**
*
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource
* that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
* domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all
* domains in the token domain list, including their prefixed subdomains.
*
*
* @return Specifies the domains that WAF should accept in a web request token. This enables the use of tokens
* across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web
* Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF
* accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the
* resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
*/
public java.util.List getTokenDomains() {
return tokenDomains;
}
/**
*
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource
* that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
* domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all
* domains in the token domain list, including their prefixed subdomains.
*
*
* @param tokenDomains
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services
* resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens
* only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host
* domain plus all domains in the token domain list, including their prefixed subdomains.
*/
public void setTokenDomains(java.util.Collection tokenDomains) {
if (tokenDomains == null) {
this.tokenDomains = null;
return;
}
this.tokenDomains = new java.util.ArrayList(tokenDomains);
}
/**
*
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource
* that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
* domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all
* domains in the token domain list, including their prefixed subdomains.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTokenDomains(java.util.Collection)} or {@link #withTokenDomains(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param tokenDomains
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services
* resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens
* only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host
* domain plus all domains in the token domain list, including their prefixed subdomains.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withTokenDomains(String... tokenDomains) {
if (this.tokenDomains == null) {
setTokenDomains(new java.util.ArrayList(tokenDomains.length));
}
for (String ele : tokenDomains) {
this.tokenDomains.add(ele);
}
return this;
}
/**
*
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource
* that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
* domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all
* domains in the token domain list, including their prefixed subdomains.
*
*
* @param tokenDomains
* Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across
* multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services
* resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens
* only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host
* domain plus all domains in the token domain list, including their prefixed subdomains.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withTokenDomains(java.util.Collection tokenDomains) {
setTokenDomains(tokenDomains);
return this;
}
/**
*
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF for
* inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified
* Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*
*
* @param associationConfig
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF
* for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or
* Verified Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*/
public void setAssociationConfig(AssociationConfig associationConfig) {
this.associationConfig = associationConfig;
}
/**
*
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF for
* inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified
* Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*
*
* @return Specifies custom configurations for the associations between the web ACL and protected resources.
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF
* for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner,
* or Verified Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*/
public AssociationConfig getAssociationConfig() {
return this.associationConfig;
}
/**
*
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF for
* inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified
* Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
*
*
* @param associationConfig
* Specifies custom configurations for the associations between the web ACL and protected resources.
*
* Use this to customize the maximum size of the request body that your protected resources forward to WAF
* for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or
* Verified Access resources. The default setting is 16 KB (16,384 bytes).
*
*
*
* You are charged additional fees when your protected resources forward body sizes that are larger than the
* default. For more information, see WAF Pricing.
*
*
*
* For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WebACL withAssociationConfig(AssociationConfig associationConfig) {
setAssociationConfig(associationConfig);
return this;
}
/**
* 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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getARN() != null)
sb.append("ARN: ").append(getARN()).append(",");
if (getDefaultAction() != null)
sb.append("DefaultAction: ").append(getDefaultAction()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRules() != null)
sb.append("Rules: ").append(getRules()).append(",");
if (getVisibilityConfig() != null)
sb.append("VisibilityConfig: ").append(getVisibilityConfig()).append(",");
if (getCapacity() != null)
sb.append("Capacity: ").append(getCapacity()).append(",");
if (getPreProcessFirewallManagerRuleGroups() != null)
sb.append("PreProcessFirewallManagerRuleGroups: ").append(getPreProcessFirewallManagerRuleGroups()).append(",");
if (getPostProcessFirewallManagerRuleGroups() != null)
sb.append("PostProcessFirewallManagerRuleGroups: ").append(getPostProcessFirewallManagerRuleGroups()).append(",");
if (getManagedByFirewallManager() != null)
sb.append("ManagedByFirewallManager: ").append(getManagedByFirewallManager()).append(",");
if (getLabelNamespace() != null)
sb.append("LabelNamespace: ").append(getLabelNamespace()).append(",");
if (getCustomResponseBodies() != null)
sb.append("CustomResponseBodies: ").append(getCustomResponseBodies()).append(",");
if (getCaptchaConfig() != null)
sb.append("CaptchaConfig: ").append(getCaptchaConfig()).append(",");
if (getChallengeConfig() != null)
sb.append("ChallengeConfig: ").append(getChallengeConfig()).append(",");
if (getTokenDomains() != null)
sb.append("TokenDomains: ").append(getTokenDomains()).append(",");
if (getAssociationConfig() != null)
sb.append("AssociationConfig: ").append(getAssociationConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof WebACL == false)
return false;
WebACL other = (WebACL) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getARN() == null ^ this.getARN() == null)
return false;
if (other.getARN() != null && other.getARN().equals(this.getARN()) == false)
return false;
if (other.getDefaultAction() == null ^ this.getDefaultAction() == null)
return false;
if (other.getDefaultAction() != null && other.getDefaultAction().equals(this.getDefaultAction()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getRules() == null ^ this.getRules() == null)
return false;
if (other.getRules() != null && other.getRules().equals(this.getRules()) == false)
return false;
if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null)
return false;
if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false)
return false;
if (other.getCapacity() == null ^ this.getCapacity() == null)
return false;
if (other.getCapacity() != null && other.getCapacity().equals(this.getCapacity()) == false)
return false;
if (other.getPreProcessFirewallManagerRuleGroups() == null ^ this.getPreProcessFirewallManagerRuleGroups() == null)
return false;
if (other.getPreProcessFirewallManagerRuleGroups() != null
&& other.getPreProcessFirewallManagerRuleGroups().equals(this.getPreProcessFirewallManagerRuleGroups()) == false)
return false;
if (other.getPostProcessFirewallManagerRuleGroups() == null ^ this.getPostProcessFirewallManagerRuleGroups() == null)
return false;
if (other.getPostProcessFirewallManagerRuleGroups() != null
&& other.getPostProcessFirewallManagerRuleGroups().equals(this.getPostProcessFirewallManagerRuleGroups()) == false)
return false;
if (other.getManagedByFirewallManager() == null ^ this.getManagedByFirewallManager() == null)
return false;
if (other.getManagedByFirewallManager() != null && other.getManagedByFirewallManager().equals(this.getManagedByFirewallManager()) == false)
return false;
if (other.getLabelNamespace() == null ^ this.getLabelNamespace() == null)
return false;
if (other.getLabelNamespace() != null && other.getLabelNamespace().equals(this.getLabelNamespace()) == false)
return false;
if (other.getCustomResponseBodies() == null ^ this.getCustomResponseBodies() == null)
return false;
if (other.getCustomResponseBodies() != null && other.getCustomResponseBodies().equals(this.getCustomResponseBodies()) == false)
return false;
if (other.getCaptchaConfig() == null ^ this.getCaptchaConfig() == null)
return false;
if (other.getCaptchaConfig() != null && other.getCaptchaConfig().equals(this.getCaptchaConfig()) == false)
return false;
if (other.getChallengeConfig() == null ^ this.getChallengeConfig() == null)
return false;
if (other.getChallengeConfig() != null && other.getChallengeConfig().equals(this.getChallengeConfig()) == false)
return false;
if (other.getTokenDomains() == null ^ this.getTokenDomains() == null)
return false;
if (other.getTokenDomains() != null && other.getTokenDomains().equals(this.getTokenDomains()) == false)
return false;
if (other.getAssociationConfig() == null ^ this.getAssociationConfig() == null)
return false;
if (other.getAssociationConfig() != null && other.getAssociationConfig().equals(this.getAssociationConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getARN() == null) ? 0 : getARN().hashCode());
hashCode = prime * hashCode + ((getDefaultAction() == null) ? 0 : getDefaultAction().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode());
hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode());
hashCode = prime * hashCode + ((getCapacity() == null) ? 0 : getCapacity().hashCode());
hashCode = prime * hashCode + ((getPreProcessFirewallManagerRuleGroups() == null) ? 0 : getPreProcessFirewallManagerRuleGroups().hashCode());
hashCode = prime * hashCode + ((getPostProcessFirewallManagerRuleGroups() == null) ? 0 : getPostProcessFirewallManagerRuleGroups().hashCode());
hashCode = prime * hashCode + ((getManagedByFirewallManager() == null) ? 0 : getManagedByFirewallManager().hashCode());
hashCode = prime * hashCode + ((getLabelNamespace() == null) ? 0 : getLabelNamespace().hashCode());
hashCode = prime * hashCode + ((getCustomResponseBodies() == null) ? 0 : getCustomResponseBodies().hashCode());
hashCode = prime * hashCode + ((getCaptchaConfig() == null) ? 0 : getCaptchaConfig().hashCode());
hashCode = prime * hashCode + ((getChallengeConfig() == null) ? 0 : getChallengeConfig().hashCode());
hashCode = prime * hashCode + ((getTokenDomains() == null) ? 0 : getTokenDomains().hashCode());
hashCode = prime * hashCode + ((getAssociationConfig() == null) ? 0 : getAssociationConfig().hashCode());
return hashCode;
}
@Override
public WebACL clone() {
try {
return (WebACL) 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.WebACLMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}