interface RuleProperty

Language	Type name
.NET	Amazon.CDK.AWS.WAFRegional.CfnWebACL.RuleProperty
Java	software.amazon.awscdk.services.waf.regional.CfnWebACL.RuleProperty
Python	aws_cdk.aws_wafregional.CfnWebACL.RuleProperty
TypeScript	@aws-cdk/aws-wafregional » CfnWebACL » RuleProperty

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 * as wafregional from '@aws-cdk/aws-wafregional';
const ruleProperty: wafregional.CfnWebACL.RuleProperty = {
  action: {
    type: 'type',
  },
  priority: 123,
  ruleId: 'ruleId',
};

Properties

Name	Type	Description
action	IResolvable | ActionProperty	The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.
priority	number	The order in which AWS WAF evaluates the rules in a web ACL.
ruleId	string	The ID of an AWS WAF Regional rule to associate with a web ACL.

---

action

Type: IResolvable | ActionProperty

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

---

priority

Type: number

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.

---

ruleId

Type: string

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