WebACL (AWS Java SDK :: Services :: AWS WAF 2.20.149 API)

java.lang.Object
- software.amazon.awssdk.services.waf.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>
```
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

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
`static WebACL.Builder`	`builder()`
`WafAction`	`defaultAction()` The action to perform if none of the `Rules` contained in the `WebACL` match.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRules()` For responses, this returns true if the service returned a value for the Rules property.
`String`	`metricName()` A friendly name or description for the metrics for this `WebACL`.
`String`	`name()` A friendly name or description of the `WebACL`.
`List<ActivatedRule>`	`rules()` An array that contains the action for each `Rule` in a `WebACL`, the priority of the `Rule`, and the ID of the `Rule`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WebACL.Builder>`	`serializableBuilderClass()`
`WebACL.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`webACLArn()` Tha Amazon Resource Name (ARN) of the web ACL.
`String`	`webACLId()` A unique identifier for a `WebACL`.

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
  - webACLId
```
public final String webACLId()
```
    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
    
    WebACLId is returned by CreateWebACL and by ListWebACLs.
    
    Returns:
    
    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
    
    WebACLId is returned by CreateWebACL and by ListWebACLs.
  - name
```
public final String name()
```
    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
    
    Returns:
    
    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
  - metricName
```
public final String metricName()
```
    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
    
    Returns:
    
    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
  - defaultAction
```
public final WafAction defaultAction()
```
    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
    
    Returns:
    
    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
  - 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<ActivatedRule> rules()
```
    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
    
    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:
    
    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
  - webACLArn
```
public final String webACLArn()
```
    Tha Amazon Resource Name (ARN) of the web ACL.
    
    Returns:
    
    Tha Amazon Resource Name (ARN) of the web ACL.
  - 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

webACLId

name

metricName

defaultAction

hasRules

rules

webACLArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields