Interface CfnRuleGroup.IVisibilityConfigProperty

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

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnRuleGroup.IVisibilityConfigProperty

Syntax (vb)

Public Interface CfnRuleGroup.IVisibilityConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html

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

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.

Properties

CloudWatchMetricsEnabled

Indicates whether the associated resource sends metrics to Amazon CloudWatch.

object CloudWatchMetricsEnabled { get; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-cloudwatchmetricsenabled

Type union: either bool or IResolvable

MetricName

A name of the Amazon CloudWatch metric dimension.

string MetricName { get; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-metricname

SampledRequestsEnabled

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

object SampledRequestsEnabled { get; }

Property Value

object

Remarks

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

If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.

Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-sampledrequestsenabled

Type union: either bool or IResolvable