WebACL (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.waf.model

Class WebACL

java.lang.Object
- com.amazonaws.services.waf.model.WebACL

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WebACL
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WebACL ()

Constructors
Constructor and Description
`WebACL ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`WebACL`	`clone ()`
`boolean`	`equals (Object obj)`
`WafAction`	`getDefaultAction ()` The action to perform if none of the `Rules` contained in the `WebACL` match.
`String`	`getMetricName ()` A friendly name or description for the metrics for this `WebACL`.
`String`	`getName ()` A friendly name or description of the `WebACL`.
`List<ActivatedRule>`	`getRules ()` An array that contains the action for each `Rule` in a `WebACL`, the priority of the `Rule`, and the ID of the `Rule`.
`String`	`getWebACLArn ()` Tha Amazon Resource Name (ARN) of the web ACL.
`String`	`getWebACLId ()` A unique identifier for a `WebACL`.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultAction (WafAction defaultAction)` The action to perform if none of the `Rules` contained in the `WebACL` match.
`void`	`setMetricName (String metricName)` A friendly name or description for the metrics for this `WebACL`.
`void`	`setName (String name)` A friendly name or description of the `WebACL`.
`void`	`setRules (Collection<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`.
`void`	`setWebACLArn (String webACLArn)` Tha Amazon Resource Name (ARN) of the web ACL.
`void`	`setWebACLId (String webACLId)` A unique identifier for a `WebACL`.
`String`	`toString ()` Returns a string representation of this object.
`WebACL`	`withDefaultAction (WafAction defaultAction)` The action to perform if none of the `Rules` contained in the `WebACL` match.
`WebACL`	`withMetricName (String metricName)` A friendly name or description for the metrics for this `WebACL`.
`WebACL`	`withName (String name)` A friendly name or description of the `WebACL`.
`WebACL`	`withRules (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`.
`WebACL`	`withRules (Collection<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`.
`WebACL`	`withWebACLArn (String webACLArn)` Tha Amazon Resource Name (ARN) of the web ACL.
`WebACL`	`withWebACLId (String webACLId)` A unique identifier for a `WebACL`.

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

- Constructor Detail
  - WebACL
```
public WebACL()
```
- Method Detail
  - setWebACLId
```
public void setWebACLId(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.
    
    Parameters:
    
    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.
  - getWebACLId
```
public String getWebACLId()
```
    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.
  - withWebACLId
```
public WebACL withWebACLId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
    
    Parameters:
    
    name - A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
  - getName
```
public String getName()
```
    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.
  - withName
```
public WebACL withName(String name)
```
    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
    
    Parameters:
    
    name - A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricName
```
public void setMetricName(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.
    
    Parameters:
    
    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.
  - getMetricName
```
public String getMetricName()
```
    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.
  - withMetricName
```
public WebACL withMetricName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultAction
```
public void setDefaultAction(WafAction defaultAction)
```
    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
    
    Parameters:
    
    defaultAction - The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
  - getDefaultAction
```
public WafAction getDefaultAction()
```
    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.
  - withDefaultAction
```
public WebACL withDefaultAction(WafAction defaultAction)
```
    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
    
    Parameters:
    
    defaultAction - The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<ActivatedRule> getRules()
```
    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
    
    Returns:
    
    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
  - setRules
```
public void setRules(Collection<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.
    
    Parameters:
    
    rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
  - withRules
```
public WebACL withRules(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.
    
    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.
    
    Parameters:
    
    rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public WebACL withRules(Collection<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.
    
    Parameters:
    
    rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWebACLArn
```
public void setWebACLArn(String webACLArn)
```
    Tha Amazon Resource Name (ARN) of the web ACL.
    
    Parameters:
    
    webACLArn - Tha Amazon Resource Name (ARN) of the web ACL.
  - getWebACLArn
```
public String getWebACLArn()
```
    Tha Amazon Resource Name (ARN) of the web ACL.
    
    Returns:
    
    Tha Amazon Resource Name (ARN) of the web ACL.
  - withWebACLArn
```
public WebACL withWebACLArn(String webACLArn)
```
    Tha Amazon Resource Name (ARN) of the web ACL.
    
    Parameters:
    
    webACLArn - Tha Amazon Resource Name (ARN) of the web ACL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WebACL clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class WebACL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebACL

Method Detail

setWebACLId

getWebACLId

withWebACLId

setName

getName

withName

setMetricName

getMetricName

withMetricName

setDefaultAction

getDefaultAction

withDefaultAction

getRules

setRules

withRules

withRules

setWebACLArn

getWebACLArn

withWebACLArn

toString

equals

hashCode

clone

marshall