Struct aws_sdk_wafv2::types::VisibilityConfig

#[non_exhaustive]
pub struct VisibilityConfig {
    pub sampled_requests_enabled: bool,
    pub cloud_watch_metrics_enabled: bool,
    pub metric_name: String,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sampled_requests_enabled: bool

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.

cloud_watch_metrics_enabled: bool

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.

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.

Implementations

impl VisibilityConfig

pub fn sampled_requests_enabled(&self) -> bool

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.

pub fn cloud_watch_metrics_enabled(&self) -> bool

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.

pub fn metric_name(&self) -> &str

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.

impl VisibilityConfig

pub fn builder() -> VisibilityConfigBuilder

Creates a new builder-style object to manufacture VisibilityConfig.

Trait Implementations

impl Clone for VisibilityConfig

fn clone(&self) -> VisibilityConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VisibilityConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VisibilityConfig

fn eq(&self, other: &VisibilityConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VisibilityConfig