Package software.amazon.awscdk.services.waf.regional

Interface CfnWebACL.RuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.RuleProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.RuleProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.waf.regional.*;
 RuleProperty ruleProperty = RuleProperty.builder()
         .action(ActionProperty.builder()
                 .type("type")
                 .build())
         .priority(123)
         .ruleId("ruleId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACL.RuleProperty.Builder	A builder for CfnWebACL.RuleProperty
static final class	CfnWebACL.RuleProperty.Jsii$Proxy	An implementation for CfnWebACL.RuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.RuleProperty.Builder	builder()
Object	getAction()	The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.
Number	getPriority()	The order in which AWS WAF evaluates the rules in a web ACL.
String	getRuleId()	The ID of an AWS WAF Regional rule to associate with a web ACL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
Object getAction()

The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-action

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

The order in which AWS WAF evaluates the rules in a web ACL.

AWS WAF evaluates rules with a lower value before rules with a higher value. The value must be a unique integer. If you have multiple rules in a web ACL, the priority numbers do not need to be consecutive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-priority

getRuleId

@Stability(Stable)
@NotNull
String getRuleId()

The ID of an AWS WAF Regional rule to associate with a web ACL.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-ruleid

builder

@Stability(Stable)
static CfnWebACL.RuleProperty.Builder builder()

Returns:

a CfnWebACL.RuleProperty.Builder of CfnWebACL.RuleProperty