You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFV2::Types::VisibilityConfig

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing VisibilityConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  sampled_requests_enabled: false, # required
  cloud_watch_metrics_enabled: false, # required
  metric_name: "MetricName", # required
}

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_metrics_enabled ⇒ Boolean

A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

Returns:

  • (Boolean) —

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

#metric_name ⇒ String

A name of the 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.\"

Returns:

  • (String) —

    A name of the CloudWatch metric.

#sampled_requests_enabled ⇒ Boolean

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.

Returns:

  • (Boolean) —

    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.