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

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

Overview

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

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][2

in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics [2]: docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html

Returns:

  • (Boolean) 


9737
9738
9739
9740
9741
9742
9743
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9737

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 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:

  • (String) 


9737
9738
9739
9740
9741
9742
9743
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9737

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

#sampled_requests_enabled ⇒ Boolean

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.

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

<note markdown=“1”> 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.

</note>

Returns:

  • (Boolean) 


9737
9738
9739
9740
9741
9742
9743
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9737

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