interface CfnWebACLProps

Language	Type name
.NET	`Amazon.CDK.AWS.WAFRegional.CfnWebACLProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswafregional#CfnWebACLProps`
Java	`software.amazon.awscdk.services.waf.regional.CfnWebACLProps`
Python	`aws_cdk.aws_wafregional.CfnWebACLProps`
TypeScript	`aws-cdk-lib` » `aws_wafregional` » `CfnWebACLProps`

Properties for defining a CfnWebACL.

Example

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

  // the properties below are optional
  rules: [{
    action: {
      type: 'type',
    },
    priority: 123,
    ruleId: 'ruleId',
  }],
};

Properties

Name	Type	Description
defaultAction	`IResolvable` `\|` `ActionProperty`	The action to perform if none of the `Rules` contained in the `WebACL` match.
metricName	`string`	A name for the metrics for this `WebACL` .
name	`string`	A friendly name or description of the `WebACL` .
rules?	`IResolvable` `\| (IResolvable` `\|` `RuleProperty)[]`	An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .

defaultAction

Type: IResolvable | ActionProperty

The action to perform if none of the Rules contained in the WebACL match.

The action is specified by the WafAction object.

metricName

Type: string

A name for the metrics for this WebACL .

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 WebACL .

name

Type: string

A friendly name or description of the WebACL .

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

rules?

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

An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .