aws-cdk-lib.aws_waf.CfnRuleProps

CfnRuleProps Struct

Properties for defining a CfnRule.

CfnRuleProps

used as props by

• CfnRule

Source

Generated code

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_waf as waf } from 'aws-cdk-lib';
const cfnRuleProps: waf.CfnRuleProps = {
  metricName: 'metricName',
  name: 'name',

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

Properties

metricNamestringmetric_namestrmetricNameStringMetricNamestringMetricName*stringrequired#

The name of the metrics for this `Rule` .

notes

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 .

namestringnamestrnameStringNamestringName*stringrequired#

The friendly name or description for the `Rule` .

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

predicates?optionalIResolvable | IResolvable | CfnRule.PredicateProperty[]predicates?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PredicateProperty]]]predicates?optionalIResolvablePredicates?optionalIResolvablePredicates?optionalinterface{}#

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