@Generated(value="software.amazon.awssdk:codegen") public class WebACL extends Object implements StructuredPojo, ToCopyableBuilder<WebACL.Builder,WebACL>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
WebACL.Builder |
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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 . |
static Class<? extends WebACL.Builder> |
serializableBuilderClass() |
WebACL.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
webACLId()
A unique identifier for a
WebACL . |
copy
public 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.
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.
public String name()
A friendly name or description of the WebACL
. You can't change the name of a WebACL
after you create it.
WebACL
. You can't change the name of a
WebACL
after you create it.public 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); the name can't contain whitespace. You can't change
MetricName
after you create the WebACL
.
WebACL
. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change
MetricName
after you create the WebACL
.public WafAction defaultAction()
The action to perform if none of the Rules
contained in the WebACL
match. The action is
specified by the WafAction object.
Rules
contained in the WebACL
match. The
action is specified by the WafAction object.public 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.
Rule
in a WebACL
, the priority of
the Rule
, and the ID of the Rule
.public WebACL.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<WebACL.Builder,WebACL>
public static WebACL.Builder builder()
public static Class<? extends WebACL.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.