/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace WAFV2 { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class VisibilityConfig { public: AWS_WAFV2_API VisibilityConfig(); AWS_WAFV2_API VisibilityConfig(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API VisibilityConfig& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline bool GetSampledRequestsEnabled() const{ return m_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.

*/ inline bool SampledRequestsEnabledHasBeenSet() const { return m_sampledRequestsEnabledHasBeenSet; } /** *

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.

*/ inline void SetSampledRequestsEnabled(bool value) { m_sampledRequestsEnabledHasBeenSet = true; m_sampledRequestsEnabled = value; } /** *

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.

*/ inline VisibilityConfig& WithSampledRequestsEnabled(bool value) { SetSampledRequestsEnabled(value); return *this;} /** *

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.

*/ inline bool GetCloudWatchMetricsEnabled() const{ return m_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.

*/ inline bool CloudWatchMetricsEnabledHasBeenSet() const { return m_cloudWatchMetricsEnabledHasBeenSet; } /** *

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.

*/ inline void SetCloudWatchMetricsEnabled(bool value) { m_cloudWatchMetricsEnabledHasBeenSet = true; m_cloudWatchMetricsEnabled = value; } /** *

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.

*/ inline VisibilityConfig& WithCloudWatchMetricsEnabled(bool value) { SetCloudWatchMetricsEnabled(value); return *this;} /** *

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.

*/ inline const Aws::String& GetMetricName() const{ return m_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.

*/ inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; } /** *

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.

*/ inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; } /** *

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.

*/ inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); } /** *

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.

*/ inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); } /** *

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.

*/ inline VisibilityConfig& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;} /** *

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.

*/ inline VisibilityConfig& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;} /** *

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.

*/ inline VisibilityConfig& WithMetricName(const char* value) { SetMetricName(value); return *this;} private: bool m_sampledRequestsEnabled; bool m_sampledRequestsEnabledHasBeenSet = false; bool m_cloudWatchMetricsEnabled; bool m_cloudWatchMetricsEnabledHasBeenSet = false; Aws::String m_metricName; bool m_metricNameHasBeenSet = false; }; } // namespace Model } // namespace WAFV2 } // namespace Aws