Package software.amazon.awssdk.services.waf.model

Class Rule

java.lang.Object

software.amazon.awssdk.services.waf.model.Rule

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Rule.Builder,Rule>

@Generated("software.amazon.awssdk:codegen")
public class Rule
extends Object
implements StructuredPojo, ToCopyableBuilder<Rule.Builder,Rule>

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

• An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

• A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Rule.Builder

Method Summary

Modifier and Type	Method	Description
static Rule.Builder	builder()
boolean	equals(Object obj)
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 Rule.
String	name()	The friendly name or description for the Rule.
List<Predicate>	predicates()	The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
String	ruleId()	A unique identifier for a Rule.
static Class<? extends Rule.Builder>	serializableBuilderClass()
Rule.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

ruleId

public String ruleId()

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

name

public String name()

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Returns:

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

metricName

public String metricName()

A friendly name or description for the metrics for this Rule. 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 Rule.

Returns:

A friendly name or description for the metrics for this Rule. 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 Rule.

predicates

public List<Predicate> predicates()

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Returns:

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

toBuilder

public Rule.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<Rule.Builder,Rule>

Returns:

a builder for type T

builder

public static Rule.Builder builder()

serializableBuilderClass

public static Class<? extends Rule.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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