{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.NetworkFirewall.Types.Dimension
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.NetworkFirewall.Types.Dimension where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | The value to use in an Amazon CloudWatch custom metric dimension. This
-- is used in the @PublishMetrics@ CustomAction. A CloudWatch custom metric
-- dimension is a name\/value pair that\'s part of the identity of a
-- metric.
--
-- AWS Network Firewall sets the dimension name to @CustomAction@ and you
-- provide the dimension value.
--
-- For more information about CloudWatch custom metric dimensions, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions Publishing Custom Metrics>
-- in the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Amazon CloudWatch User Guide>.
--
-- /See:/ 'newDimension' smart constructor.
data Dimension = Dimension'
  { -- | The value to use in the custom metric dimension.
    Dimension -> Text
value :: Prelude.Text
  }
  deriving (Dimension -> Dimension -> Bool
(Dimension -> Dimension -> Bool)
-> (Dimension -> Dimension -> Bool) -> Eq Dimension
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Dimension -> Dimension -> Bool
$c/= :: Dimension -> Dimension -> Bool
== :: Dimension -> Dimension -> Bool
$c== :: Dimension -> Dimension -> Bool
Prelude.Eq, ReadPrec [Dimension]
ReadPrec Dimension
Int -> ReadS Dimension
ReadS [Dimension]
(Int -> ReadS Dimension)
-> ReadS [Dimension]
-> ReadPrec Dimension
-> ReadPrec [Dimension]
-> Read Dimension
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Dimension]
$creadListPrec :: ReadPrec [Dimension]
readPrec :: ReadPrec Dimension
$creadPrec :: ReadPrec Dimension
readList :: ReadS [Dimension]
$creadList :: ReadS [Dimension]
readsPrec :: Int -> ReadS Dimension
$creadsPrec :: Int -> ReadS Dimension
Prelude.Read, Int -> Dimension -> ShowS
[Dimension] -> ShowS
Dimension -> String
(Int -> Dimension -> ShowS)
-> (Dimension -> String)
-> ([Dimension] -> ShowS)
-> Show Dimension
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Dimension] -> ShowS
$cshowList :: [Dimension] -> ShowS
show :: Dimension -> String
$cshow :: Dimension -> String
showsPrec :: Int -> Dimension -> ShowS
$cshowsPrec :: Int -> Dimension -> ShowS
Prelude.Show, (forall x. Dimension -> Rep Dimension x)
-> (forall x. Rep Dimension x -> Dimension) -> Generic Dimension
forall x. Rep Dimension x -> Dimension
forall x. Dimension -> Rep Dimension x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Dimension x -> Dimension
$cfrom :: forall x. Dimension -> Rep Dimension x
Prelude.Generic)

-- |
-- Create a value of 'Dimension' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'value', 'dimension_value' - The value to use in the custom metric dimension.
newDimension ::
  -- | 'value'
  Prelude.Text ->
  Dimension
newDimension :: Text -> Dimension
newDimension Text
pValue_ = Dimension' :: Text -> Dimension
Dimension' {$sel:value:Dimension' :: Text
value = Text
pValue_}

-- | The value to use in the custom metric dimension.
dimension_value :: Lens.Lens' Dimension Prelude.Text
dimension_value :: (Text -> f Text) -> Dimension -> f Dimension
dimension_value = (Dimension -> Text)
-> (Dimension -> Text -> Dimension)
-> Lens Dimension Dimension Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dimension' {Text
value :: Text
$sel:value:Dimension' :: Dimension -> Text
value} -> Text
value) (\s :: Dimension
s@Dimension' {} Text
a -> Dimension
s {$sel:value:Dimension' :: Text
value = Text
a} :: Dimension)

instance Core.FromJSON Dimension where
  parseJSON :: Value -> Parser Dimension
parseJSON =
    String -> (Object -> Parser Dimension) -> Value -> Parser Dimension
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"Dimension"
      (\Object
x -> Text -> Dimension
Dimension' (Text -> Dimension) -> Parser Text -> Parser Dimension
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"Value"))

instance Prelude.Hashable Dimension

instance Prelude.NFData Dimension

instance Core.ToJSON Dimension where
  toJSON :: Dimension -> Value
toJSON Dimension' {Text
value :: Text
$sel:value:Dimension' :: Dimension -> Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Value" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
value)]
      )