Class WebACL

java.lang.Object
software.amazon.awssdk.services.wafv2.model.WebACL
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WebACL.Builder,WebACL>
@Generated("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 resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance.

See Also:

  • Method Details

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

    • dataProtectionConfig

      public final DataProtectionConfig dataProtectionConfig()

      Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.

      The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.

      Returns:
      Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.

      The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.

    • 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 was created by Firewall Manager and is being 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. See also the properties RetrofittedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

      Returns:
      Indicates whether this web ACL was created by Firewall Manager and is being 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. See also the properties RetrofittedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

    • 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 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).

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

    • retrofittedByFirewallManager

      public final Boolean retrofittedByFirewallManager()

      Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties ManagedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

      Returns:
      Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties ManagedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

    • onSourceDDoSProtectionConfig

      public final OnSourceDDoSProtectionConfig onSourceDDoSProtectionConfig()

      Configures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.

      Returns:
      Configures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.

    • applicationConfig

      public final ApplicationConfig applicationConfig()

      Returns a list of ApplicationAttributes.

      Returns:
      Returns a list of ApplicationAttributes.

    • toBuilder

      public WebACL.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WebACL.Builder,WebACL>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.