AWS::WAFv2::RuleGroup VisibilityConfig

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "CloudWatchMetricsEnabled" : Boolean, "MetricName" : String, "SampledRequestsEnabled" : Boolean }

Properties

CloudWatchMetricsEnabled

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics.

Required: Yes

Type: Boolean

Update requires: No interruption

MetricName

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Pattern: ^[\w#:\.\-/]+$

Update requires: No interruption

SampledRequestsEnabled

A boolean indicating 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.

Required: Yes

Type: Boolean

Update requires: No interruption