Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFV2.Types.VisibilityConfig

Description

Documentation

data VisibilityConfig Source #

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

See: newVisibilityConfig smart constructor.

Constructors

VisibilityConfig'

Fields

sampledRequestsEnabled :: Bool
A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
cloudWatchMetricsEnabled :: Bool
A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.
metricName :: Text
A name of the Amazon 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 WAF, for example All and Default_Action.

Instances

Instances details

FromJSON VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods parseJSON :: Value -> Parser VisibilityConfig # parseJSONList :: Value -> Parser [VisibilityConfig] #
ToJSON VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods toJSON :: VisibilityConfig -> Value # toEncoding :: VisibilityConfig -> Encoding # toJSONList :: [VisibilityConfig] -> Value # toEncodingList :: [VisibilityConfig] -> Encoding #
Generic VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Associated Types type Rep VisibilityConfig :: Type -> Type # Methods from :: VisibilityConfig -> Rep VisibilityConfig x # to :: Rep VisibilityConfig x -> VisibilityConfig #
Read VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods readsPrec :: Int -> ReadS VisibilityConfig # readList :: ReadS [VisibilityConfig] # readPrec :: ReadPrec VisibilityConfig # readListPrec :: ReadPrec [VisibilityConfig] #
Show VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods showsPrec :: Int -> VisibilityConfig -> ShowS # show :: VisibilityConfig -> String # showList :: [VisibilityConfig] -> ShowS #
NFData VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods rnf :: VisibilityConfig -> () #
Eq VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods (==) :: VisibilityConfig -> VisibilityConfig -> Bool # (/=) :: VisibilityConfig -> VisibilityConfig -> Bool #
Hashable VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig Methods hashWithSalt :: Int -> VisibilityConfig -> Int # hash :: VisibilityConfig -> Int #
type Rep VisibilityConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.VisibilityConfig type Rep VisibilityConfig = D1 ('MetaData "VisibilityConfig" "Amazonka.WAFV2.Types.VisibilityConfig" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "VisibilityConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sampledRequestsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "cloudWatchMetricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newVisibilityConfig Source #

Arguments

:: Bool	`$sel:sampledRequestsEnabled:VisibilityConfig'`
-> Bool	`$sel:cloudWatchMetricsEnabled:VisibilityConfig'`
-> Text	`$sel:metricName:VisibilityConfig'`
-> VisibilityConfig

Create a value of VisibilityConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sampledRequestsEnabled:VisibilityConfig', visibilityConfig_sampledRequestsEnabled - A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

$sel:cloudWatchMetricsEnabled:VisibilityConfig', visibilityConfig_cloudWatchMetricsEnabled - A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

$sel:metricName:VisibilityConfig', visibilityConfig_metricName - A name of the Amazon 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 WAF, for example All and Default_Action.

visibilityConfig_sampledRequestsEnabled :: Lens' VisibilityConfig Bool Source #

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

visibilityConfig_cloudWatchMetricsEnabled :: Lens' VisibilityConfig Bool Source #

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

visibilityConfig_metricName :: Lens' VisibilityConfig Text Source #

A name of the Amazon 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 WAF, for example All and Default_Action.