interface CfnRuleProps

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

Properties for defining a CfnRule.

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 cfnRuleProps: wafregional.CfnRuleProps = {
  metricName: 'metricName',
  name: 'name',

  // the properties below are optional
  predicates: [{
    dataId: 'dataId',
    negated: false,
    type: 'type',
  }],
};

Properties

Name	Type	Description
metricName	string	A name for the metrics for this Rule .
name	string	The friendly name or description for the Rule .
predicates?	IResolvable | IResolvable | PredicateProperty[]	The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet object that you want to include in a Rule .

---

metricName

Type: string

A name for the metrics for this Rule .

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule .

---

name

Type: string

The friendly name or description for the Rule .

You can't change the name of a Rule after you create it.

---

predicates?

Type: IResolvable | IResolvable | PredicateProperty[] (optional)

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