AWS::WAFv2::RuleGroup VisibilityConfig

Note

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

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
}

YAML

  CloudWatchMetricsEnabled: Boolean
  MetricName: String
  SampledRequestsEnabled: Boolean

Properties

CloudWatchMetricsEnabled

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

Required: Yes

Type: Boolean

Update requires: No interruption

MetricName

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

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