software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.VisibilityConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.VisibilityConfigProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(value=Stable)
public static interface CfnRuleGroup.VisibilityConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 VisibilityConfigProperty visibilityConfigProperty = VisibilityConfigProperty.builder()
         .cloudWatchMetricsEnabled(false)
         .metricName("metricName")
         .sampledRequestsEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRuleGroup.VisibilityConfigProperty.Builder A builder for CfnRuleGroup.VisibilityConfigProperty
static class	CfnRuleGroup.VisibilityConfigProperty.Jsii$Proxy An implementation for CfnRuleGroup.VisibilityConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnRuleGroup.VisibilityConfigProperty.Builder	builder()
Object	getCloudWatchMetricsEnabled() A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch.
String	getMetricName() A name of the Amazon CloudWatch metric.
Object	getSampledRequestsEnabled() A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudWatchMetricsEnabled

@Stability(value=Stable)
 @NotNull
Object getCloudWatchMetricsEnabled()

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch.

For the list of available metrics, see AWS WAF Metrics .

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

A name of the Amazon CloudWatch metric.

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 reserved for AWS WAF , for example "All" and "Default_Action."

getSampledRequestsEnabled

@Stability(value=Stable)
 @NotNull
Object getSampledRequestsEnabled()

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.

builder

@Stability(value=Stable)
static CfnRuleGroup.VisibilityConfigProperty.Builder builder()

Returns:

a CfnRuleGroup.VisibilityConfigProperty.Builder of CfnRuleGroup.VisibilityConfigProperty