WebACL (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.WebACL

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WebACL.Builder,WebACL>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class WebACL
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebACL.Builder,WebACL>
```
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 Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WebACL.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WebACL.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
`AssociationConfig`	`associationConfig()` Specifies custom configurations for the associations between the web ACL and protected resources.
`static WebACL.Builder`	`builder()`
`Long`	`capacity()` The web ACL capacity units (WCUs) currently being used by this web ACL.
`CaptchaConfig`	`captchaConfig()` Specifies how WAF should handle `CAPTCHA` evaluations for rules that don't have their own `CaptchaConfig` settings.
`ChallengeConfig`	`challengeConfig()` Specifies how WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings.
`Map<String,CustomResponseBody>`	`customResponseBodies()` A map of custom response keys and content bodies.
`DefaultAction`	`defaultAction()` The action to perform if none of the `Rules` contained in the `WebACL` match.
`String`	`description()` A description of the web ACL that helps with identification.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomResponseBodies()` For responses, this returns true if the service returned a value for the CustomResponseBodies property.
`int`	`hashCode()`
`boolean`	`hasPostProcessFirewallManagerRuleGroups()` For responses, this returns true if the service returned a value for the PostProcessFirewallManagerRuleGroups property.
`boolean`	`hasPreProcessFirewallManagerRuleGroups()` For responses, this returns true if the service returned a value for the PreProcessFirewallManagerRuleGroups property.
`boolean`	`hasRules()` For responses, this returns true if the service returned a value for the Rules property.
`boolean`	`hasTokenDomains()` For responses, this returns true if the service returned a value for the TokenDomains property.
`String`	`id()` A unique identifier for the `WebACL`.
`String`	`labelNamespace()` The label namespace prefix for this web ACL.
`Boolean`	`managedByFirewallManager()` Indicates whether this web ACL is managed by Firewall Manager.
`String`	`name()` The name of the web ACL.
`List<FirewallManagerRuleGroup>`	`postProcessFirewallManagerRuleGroups()` The last set of rules for WAF to process in the web ACL.
`List<FirewallManagerRuleGroup>`	`preProcessFirewallManagerRuleGroups()` The first set of rules for WAF to process in the web ACL.
`List<Rule>`	`rules()` The Rule statements used to identify the web requests that you want to manage.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WebACL.Builder>`	`serializableBuilderClass()`
`WebACL.Builder`	`toBuilder()`
`List<String>`	`tokenDomains()` Specifies the domains that WAF should accept in a web request token.
`String`	`toString()` Returns a string representation of this object.
`VisibilityConfig`	`visibilityConfig()` Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the web ACL. You cannot change the name of a web ACL after you create it.
    
    Returns:
    
    The name of the web ACL. You cannot change the name of a web ACL after you create it.
  - id
```
public final 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.
    
    Returns:
    
    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.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
  - defaultAction
```
public final DefaultAction defaultAction()
```
    The action to perform if none of the Rules contained in the WebACL match.
    
    Returns:
    
    The action to perform if none of the Rules contained in the WebACL match.
  - description
```
public final String description()
```
    A description of the web ACL that helps with identification.
    
    Returns:
    
    A description of the web ACL that helps with identification.
  - hasRules
```
public final boolean hasRules()
```
    For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - rules
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRules() method.
    
    Returns:
    
    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.
  - visibilityConfig
```
public final VisibilityConfig visibilityConfig()
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Returns:
    
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - capacity
```
public final 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.
    
    Returns:
    
    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.
  - hasPreProcessFirewallManagerRuleGroups
```
public final boolean hasPreProcessFirewallManagerRuleGroups()
```
    For responses, this returns true if the service returned a value for the PreProcessFirewallManagerRuleGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - preProcessFirewallManagerRuleGroups
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPreProcessFirewallManagerRuleGroups() method.
    
    Returns:
    
    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.
  - hasPostProcessFirewallManagerRuleGroups
```
public final boolean hasPostProcessFirewallManagerRuleGroups()
```
    For responses, this returns true if the service returned a value for the PostProcessFirewallManagerRuleGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - postProcessFirewallManagerRuleGroups
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPostProcessFirewallManagerRuleGroups() method.
    
    Returns:
    
    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.
  - managedByFirewallManager
```
public final 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.
    
    Returns:
    
    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.
  - labelNamespace
```
public final 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>
    Returns:
    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>
  - hasCustomResponseBodies
```
public final boolean hasCustomResponseBodies()
```
    For responses, this returns true if the service returned a value for the CustomResponseBodies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - customResponseBodies
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomResponseBodies() method.
    
    Returns:
    
    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.
  - captchaConfig
```
public final 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.
    
    Returns:
    
    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.
  - challengeConfig
```
public final 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.
    
    Returns:
    
    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.
  - hasTokenDomains
```
public final boolean hasTokenDomains()
```
    For responses, this returns true if the service returned a value for the TokenDomains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tokenDomains
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTokenDomains() method.
    
    Returns:
    
    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.
  - associationConfig
```
public final 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 CloudFront distributions forward to WAF for inspection. The default 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.
    
    Returns:
    
    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 CloudFront distributions forward to WAF for inspection. The default 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.
  - toBuilder
```
public WebACL.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WebACL.Builder,WebACL>
  - builder
```
public static WebACL.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WebACL.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class WebACL

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

id

arn

defaultAction

description

hasRules

rules

visibilityConfig

capacity

hasPreProcessFirewallManagerRuleGroups

preProcessFirewallManagerRuleGroups

hasPostProcessFirewallManagerRuleGroups

postProcessFirewallManagerRuleGroups

managedByFirewallManager

labelNamespace

hasCustomResponseBodies

customResponseBodies

captchaConfig

challengeConfig

hasTokenDomains

tokenDomains

associationConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields