Class CfnRuleGroup.VisibilityConfigProperty
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VisibilityConfigProperty : Object, CfnRuleGroup.IVisibilityConfigProperty
Syntax (vb)
Public Class VisibilityConfigProperty
Inherits Object
Implements CfnRuleGroup.IVisibilityConfigProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var visibilityConfigProperty = new VisibilityConfigProperty {
CloudWatchMetricsEnabled = false,
MetricName = "metricName",
SampledRequestsEnabled = false
};
Synopsis
Constructors
VisibilityConfigProperty() |
Properties
CloudWatchMetricsEnabled | Indicates whether the associated resource sends metrics to Amazon CloudWatch. |
MetricName | A name of the Amazon CloudWatch metric dimension. |
SampledRequestsEnabled | Indicates whether AWS WAF should store a sampling of the web requests that match the rules. |
Constructors
VisibilityConfigProperty()
public VisibilityConfigProperty()
Properties
CloudWatchMetricsEnabled
Indicates whether the associated resource sends metrics to Amazon CloudWatch.
public object CloudWatchMetricsEnabled { get; set; }
Property Value
System.Object
Remarks
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
A name of the Amazon CloudWatch metric dimension.
public string MetricName { get; set; }
Property Value
System.String
Remarks
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
Indicates whether AWS WAF should store a sampling of the web requests that match the rules.
public object SampledRequestsEnabled { get; set; }
Property Value
System.Object
Remarks
You can view the sampled requests through the AWS WAF console.
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.