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

Class ActivatedRule

java.lang.Object

software.amazon.awssdk.services.waf.model.ActivatedRule

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ActivatedRule.Builder,ActivatedRule>

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

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActivatedRule.Builder

Method Summary

Modifier and Type	Method	Description
WafAction	action()	Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule.
static ActivatedRule.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Integer	priority()	Specifies the order in which the Rules in a WebACL are evaluated.
String	ruleId()	The RuleId for a Rule.
static Class<? extends ActivatedRule.Builder>	serializableBuilderClass()
ActivatedRule.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The rule type, either REGULAR, as defined by Rule, or RATE_BASED, as defined by RateBasedRule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

priority

public Integer priority()

Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

Returns:

Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

ruleId

public String ruleId()

The RuleId 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:

The RuleId 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.

action

public WafAction action()

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

• ALLOW: CloudFront responds with the requested object.

• BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

• COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

Returns:

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

• ALLOW: CloudFront responds with the requested object.

• BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

• COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

type

public String type()

The rule type, either REGULAR, as defined by Rule, or RATE_BASED, as defined by RateBasedRule. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

Returns:

The rule type, either REGULAR, as defined by Rule, or RATE_BASED, as defined by RateBasedRule. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

See Also:

WafRuleType

toBuilder

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

Returns:

a builder for type T

builder

public static ActivatedRule.Builder builder()

serializableBuilderClass

public static Class<? extends ActivatedRule.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.