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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Note:

When making an API call, you may pass VisibilityConfig data as a 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


8291
8292
8293
8294
8295
8296
8297
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 8291

class VisibilityConfig < Struct.new(
  :sampled_requests_enabled,
  :cloud_watch_metrics_enabled,
  :metric_name)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

A name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig.

Returns:

  • (String) 


8291
8292
8293
8294
8295
8296
8297
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 8291

class VisibilityConfig < Struct.new(
  :sampled_requests_enabled,
  :cloud_watch_metrics_enabled,
  :metric_name)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


8291
8292
8293
8294
8295
8296
8297
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 8291

class VisibilityConfig < Struct.new(
  :sampled_requests_enabled,
  :cloud_watch_metrics_enabled,
  :metric_name)
  SENSITIVE = []
  include Aws::Structure
end