software.amazon.awssdk.services.wafv2.model

Interface VisibilityConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<VisibilityConfig.Builder,VisibilityConfig>, SdkBuilder<VisibilityConfig.Builder,VisibilityConfig>, SdkPojo

Enclosing class:

VisibilityConfig

public static interface VisibilityConfig.Builder
extends SdkPojo, CopyableBuilder<VisibilityConfig.Builder,VisibilityConfig>

Method Summary

Modifier and Type	Method and Description
VisibilityConfig.Builder	cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled) Indicates whether the associated resource sends metrics to Amazon CloudWatch.
VisibilityConfig.Builder	metricName(String metricName) A name of the Amazon CloudWatch metric dimension.
VisibilityConfig.Builder	sampledRequestsEnabled(Boolean sampledRequestsEnabled) Indicates whether WAF should store a sampling of the web requests that match the rules.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

sampledRequestsEnabled

VisibilityConfig.Builder sampledRequestsEnabled(Boolean sampledRequestsEnabled)

Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

Parameters:

sampledRequestsEnabled - Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchMetricsEnabled

VisibilityConfig.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

For web ACLs, the metrics are for web requests that have the web ACL default action applied. 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 WAF Developer Guide.

Parameters:

cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

For web ACLs, the metrics are for web requests that have the web ACL default action applied. 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 WAF Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricName

VisibilityConfig.Builder metricName(String 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 WAF, for example All and Default_Action.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.