@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WebACL extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
WebACL() |
Modifier and Type | Method and Description |
---|---|
WebACL |
addCustomResponseBodiesEntry(String key,
CustomResponseBody value)
Add a single CustomResponseBodies entry
|
WebACL |
clearCustomResponseBodiesEntries()
Removes all the entries added into CustomResponseBodies.
|
WebACL |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
|
AssociationConfig |
getAssociationConfig()
Specifies custom configurations for the associations between the web ACL and protected resources.
|
Long |
getCapacity()
The web ACL capacity units (WCUs) currently being used by this web ACL.
|
CaptchaConfig |
getCaptchaConfig()
Specifies how WAF should handle
CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. |
ChallengeConfig |
getChallengeConfig()
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig settings. |
Map<String,CustomResponseBody> |
getCustomResponseBodies()
A map of custom response keys and content bodies.
|
DefaultAction |
getDefaultAction()
The action to perform if none of the
Rules contained in the WebACL match. |
String |
getDescription()
A description of the web ACL that helps with identification.
|
String |
getId()
A unique identifier for the
WebACL . |
String |
getLabelNamespace()
The label namespace prefix for this web ACL.
|
Boolean |
getManagedByFirewallManager()
Indicates whether this web ACL is managed by Firewall Manager.
|
String |
getName()
The name of the web ACL.
|
List<FirewallManagerRuleGroup> |
getPostProcessFirewallManagerRuleGroups()
The last set of rules for WAF to process in the web ACL.
|
List<FirewallManagerRuleGroup> |
getPreProcessFirewallManagerRuleGroups()
The first set of rules for WAF to process in the web ACL.
|
List<Rule> |
getRules()
The Rule statements used to identify the web requests that you want to manage.
|
List<String> |
getTokenDomains()
Specifies the domains that WAF should accept in a web request token.
|
VisibilityConfig |
getVisibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
int |
hashCode() |
Boolean |
isManagedByFirewallManager()
Indicates whether this web ACL is managed by Firewall Manager.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
|
void |
setAssociationConfig(AssociationConfig associationConfig)
Specifies custom configurations for the associations between the web ACL and protected resources.
|
void |
setCapacity(Long capacity)
The web ACL capacity units (WCUs) currently being used by this web ACL.
|
void |
setCaptchaConfig(CaptchaConfig captchaConfig)
Specifies how WAF should handle
CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. |
void |
setChallengeConfig(ChallengeConfig challengeConfig)
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig settings. |
void |
setCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
A map of custom response keys and content bodies.
|
void |
setDefaultAction(DefaultAction defaultAction)
The action to perform if none of the
Rules contained in the WebACL match. |
void |
setDescription(String description)
A description of the web ACL that helps with identification.
|
void |
setId(String id)
A unique identifier for the
WebACL . |
void |
setLabelNamespace(String labelNamespace)
The label namespace prefix for this web ACL.
|
void |
setManagedByFirewallManager(Boolean managedByFirewallManager)
Indicates whether this web ACL is managed by Firewall Manager.
|
void |
setName(String name)
The name of the web ACL.
|
void |
setPostProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> postProcessFirewallManagerRuleGroups)
The last set of rules for WAF to process in the web ACL.
|
void |
setPreProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> preProcessFirewallManagerRuleGroups)
The first set of rules for WAF to process in the web ACL.
|
void |
setRules(Collection<Rule> rules)
The Rule statements used to identify the web requests that you want to manage.
|
void |
setTokenDomains(Collection<String> tokenDomains)
Specifies the domains that WAF should accept in a web request token.
|
void |
setVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
String |
toString()
Returns a string representation of this object.
|
WebACL |
withARN(String aRN)
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
|
WebACL |
withAssociationConfig(AssociationConfig associationConfig)
Specifies custom configurations for the associations between the web ACL and protected resources.
|
WebACL |
withCapacity(Long capacity)
The web ACL capacity units (WCUs) currently being used by this web ACL.
|
WebACL |
withCaptchaConfig(CaptchaConfig captchaConfig)
Specifies how WAF should handle
CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. |
WebACL |
withChallengeConfig(ChallengeConfig challengeConfig)
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig settings. |
WebACL |
withCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
A map of custom response keys and content bodies.
|
WebACL |
withDefaultAction(DefaultAction defaultAction)
The action to perform if none of the
Rules contained in the WebACL match. |
WebACL |
withDescription(String description)
A description of the web ACL that helps with identification.
|
WebACL |
withId(String id)
A unique identifier for the
WebACL . |
WebACL |
withLabelNamespace(String labelNamespace)
The label namespace prefix for this web ACL.
|
WebACL |
withManagedByFirewallManager(Boolean managedByFirewallManager)
Indicates whether this web ACL is managed by Firewall Manager.
|
WebACL |
withName(String name)
The name of the web ACL.
|
WebACL |
withPostProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> postProcessFirewallManagerRuleGroups)
The last set of rules for WAF to process in the web ACL.
|
WebACL |
withPostProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... postProcessFirewallManagerRuleGroups)
The last set of rules for WAF to process in the web ACL.
|
WebACL |
withPreProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> preProcessFirewallManagerRuleGroups)
The first set of rules for WAF to process in the web ACL.
|
WebACL |
withPreProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... preProcessFirewallManagerRuleGroups)
The first set of rules for WAF to process in the web ACL.
|
WebACL |
withRules(Collection<Rule> rules)
The Rule statements used to identify the web requests that you want to manage.
|
WebACL |
withRules(Rule... rules)
The Rule statements used to identify the web requests that you want to manage.
|
WebACL |
withTokenDomains(Collection<String> tokenDomains)
Specifies the domains that WAF should accept in a web request token.
|
WebACL |
withTokenDomains(String... tokenDomains)
Specifies the domains that WAF should accept in a web request token.
|
WebACL |
withVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
public void setName(String name)
The name of the web ACL. You cannot change the name of a web ACL after you create it.
name
- The name of the web ACL. You cannot change the name of a web ACL after you create it.public String getName()
The name of the web ACL. You cannot change the name of a web ACL after you create it.
public WebACL withName(String name)
The name of the web ACL. You cannot change the name of a web ACL after you create it.
name
- The name of the web ACL. You cannot change the name of a web ACL after you create it.public void setId(String 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
.
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 String getId()
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
.
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 WebACL withId(String 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
.
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 setARN(String aRN)
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
aRN
- The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.public String getARN()
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
public WebACL withARN(String aRN)
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
aRN
- The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.public void setDefaultAction(DefaultAction defaultAction)
The action to perform if none of the Rules
contained in the WebACL
match.
defaultAction
- The action to perform if none of the Rules
contained in the WebACL
match.public DefaultAction getDefaultAction()
The action to perform if none of the Rules
contained in the WebACL
match.
Rules
contained in the WebACL
match.public WebACL withDefaultAction(DefaultAction defaultAction)
The action to perform if none of the Rules
contained in the WebACL
match.
defaultAction
- The action to perform if none of the Rules
contained in the WebACL
match.public void setDescription(String description)
A description of the web ACL that helps with identification.
description
- A description of the web ACL that helps with identification.public String getDescription()
A description of the web ACL that helps with identification.
public WebACL withDescription(String description)
A description of the web ACL that helps with identification.
description
- A description of the web ACL that helps with identification.public List<Rule> getRules()
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(Collection<Rule> 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.
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 WebACL withRules(Rule... 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
setRules(java.util.Collection)
or withRules(java.util.Collection)
if you want to override the
existing values.
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 WebACL withRules(Collection<Rule> 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.
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 setVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
visibilityConfig
- Defines and enables Amazon CloudWatch metrics and web request sample collection.public VisibilityConfig getVisibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
public WebACL withVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
visibilityConfig
- Defines and enables Amazon CloudWatch metrics and web request sample collection.public void setCapacity(Long 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.
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 Long getCapacity()
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.
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 WebACL withCapacity(Long 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.
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 List<FirewallManagerRuleGroup> getPreProcessFirewallManagerRuleGroups()
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.
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(Collection<FirewallManagerRuleGroup> 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.
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 WebACL withPreProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... 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
setPreProcessFirewallManagerRuleGroups(java.util.Collection)
or
withPreProcessFirewallManagerRuleGroups(java.util.Collection)
if you want to override the existing
values.
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 WebACL withPreProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> 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.
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 List<FirewallManagerRuleGroup> getPostProcessFirewallManagerRuleGroups()
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.
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(Collection<FirewallManagerRuleGroup> 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.
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 WebACL withPostProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... 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
setPostProcessFirewallManagerRuleGroups(java.util.Collection)
or
withPostProcessFirewallManagerRuleGroups(java.util.Collection)
if you want to override the existing
values.
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 WebACL withPostProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> 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.
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 setManagedByFirewallManager(Boolean 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.
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 Boolean getManagedByFirewallManager()
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 WebACL withManagedByFirewallManager(Boolean 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.
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 Boolean isManagedByFirewallManager()
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 setLabelNamespace(String 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>
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 String getLabelNamespace()
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>
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 WebACL withLabelNamespace(String 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>
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 Map<String,CustomResponseBody> getCustomResponseBodies()
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.
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(Map<String,CustomResponseBody> 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.
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 WebACL withCustomResponseBodies(Map<String,CustomResponseBody> 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.
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 WebACL addCustomResponseBodiesEntry(String key, CustomResponseBody value)
public WebACL clearCustomResponseBodiesEntries()
public void setCaptchaConfig(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
.
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 CaptchaConfig getCaptchaConfig()
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
.
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 WebACL withCaptchaConfig(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
.
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 setChallengeConfig(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
.
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 ChallengeConfig getChallengeConfig()
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
.
ChallengeConfig
settings. If you don't specify this, WAF uses its default settings for
ChallengeConfig
.public WebACL withChallengeConfig(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
.
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 List<String> getTokenDomains()
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(Collection<String> 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.
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 WebACL withTokenDomains(String... 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
setTokenDomains(java.util.Collection)
or withTokenDomains(java.util.Collection)
if you want to
override the existing values.
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 WebACL withTokenDomains(Collection<String> 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.
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 setAssociationConfig(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).
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 AssociationConfig getAssociationConfig()
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).
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 WebACL withAssociationConfig(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).
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 String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.