aws-cdk-lib.aws_wafv2.CfnWebACL.VisibilityConfigProperty

interface VisibilityConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.WAFv2.CfnWebACL.VisibilityConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnWebACL_VisibilityConfigProperty
Javasoftware.amazon.awscdk.services.wafv2.CfnWebACL.VisibilityConfigProperty
Pythonaws_cdk.aws_wafv2.CfnWebACL.VisibilityConfigProperty
TypeScript aws-cdk-lib » aws_wafv2 » CfnWebACL » VisibilityConfigProperty

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';
const visibilityConfigProperty: wafv2.CfnWebACL.VisibilityConfigProperty = {
  cloudWatchMetricsEnabled: false,
  metricName: 'metricName',
  sampledRequestsEnabled: false,
};

Properties

NameTypeDescription
cloudWatchMetricsEnabledboolean | IResolvableIndicates whether the associated resource sends metrics to Amazon CloudWatch.
metricNamestringA name of the Amazon CloudWatch metric dimension.
sampledRequestsEnabledboolean | IResolvableIndicates whether AWS WAF should store a sampling of the web requests that match the rules.

cloudWatchMetricsEnabled

Type: boolean | IResolvable

Indicates whether the associated resource sends metrics to Amazon CloudWatch.

For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .

For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .


metricName

Type: string

A name of the Amazon CloudWatch metric dimension.

The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example All and Default_Action .


sampledRequestsEnabled

Type: boolean | IResolvable

Indicates whether AWS WAF should store a sampling of the web requests that match the rules.

You can view the sampled requests through the AWS WAF console.