VisibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Contents
- CloudWatchMetricsEnabled
-
Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see Amazon WAF Metrics in the Amazon WAF Developer Guide.
For web ACLs, the metrics are for web requests that have the web ACL default action applied. Amazon 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 Amazon WAF Developer Guide.
Type: Boolean
Required: Yes
- 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 Amazon WAF, for example
AllandDefault_Action.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[\w#:\.\-/]+$Required: Yes
- SampledRequestsEnabled
-
Indicates whether Amazon WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the Amazon WAF console.
Note
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
Type: Boolean
Required: Yes
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: