{-# 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.Synthetics.Types.CanaryStatus
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Synthetics.Types.CanaryStatus where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.Synthetics.Types.CanaryState
import Amazonka.Synthetics.Types.CanaryStateReasonCode

-- | A structure that contains the current state of the canary.
--
-- /See:/ 'newCanaryStatus' smart constructor.
data CanaryStatus = CanaryStatus'
  { -- | The current state of the canary.
    CanaryStatus -> Maybe CanaryState
state :: Prelude.Maybe CanaryState,
    -- | If the canary has insufficient permissions to run, this field provides
    -- more details.
    CanaryStatus -> Maybe Text
stateReason :: Prelude.Maybe Prelude.Text,
    -- | If the canary cannot run or has failed, this field displays the reason.
    CanaryStatus -> Maybe CanaryStateReasonCode
stateReasonCode :: Prelude.Maybe CanaryStateReasonCode
  }
  deriving (CanaryStatus -> CanaryStatus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CanaryStatus -> CanaryStatus -> Bool
$c/= :: CanaryStatus -> CanaryStatus -> Bool
== :: CanaryStatus -> CanaryStatus -> Bool
$c== :: CanaryStatus -> CanaryStatus -> Bool
Prelude.Eq, ReadPrec [CanaryStatus]
ReadPrec CanaryStatus
Int -> ReadS CanaryStatus
ReadS [CanaryStatus]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CanaryStatus]
$creadListPrec :: ReadPrec [CanaryStatus]
readPrec :: ReadPrec CanaryStatus
$creadPrec :: ReadPrec CanaryStatus
readList :: ReadS [CanaryStatus]
$creadList :: ReadS [CanaryStatus]
readsPrec :: Int -> ReadS CanaryStatus
$creadsPrec :: Int -> ReadS CanaryStatus
Prelude.Read, Int -> CanaryStatus -> ShowS
[CanaryStatus] -> ShowS
CanaryStatus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CanaryStatus] -> ShowS
$cshowList :: [CanaryStatus] -> ShowS
show :: CanaryStatus -> String
$cshow :: CanaryStatus -> String
showsPrec :: Int -> CanaryStatus -> ShowS
$cshowsPrec :: Int -> CanaryStatus -> ShowS
Prelude.Show, forall x. Rep CanaryStatus x -> CanaryStatus
forall x. CanaryStatus -> Rep CanaryStatus x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CanaryStatus x -> CanaryStatus
$cfrom :: forall x. CanaryStatus -> Rep CanaryStatus x
Prelude.Generic)

-- |
-- Create a value of 'CanaryStatus' 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:
--
-- 'state', 'canaryStatus_state' - The current state of the canary.
--
-- 'stateReason', 'canaryStatus_stateReason' - If the canary has insufficient permissions to run, this field provides
-- more details.
--
-- 'stateReasonCode', 'canaryStatus_stateReasonCode' - If the canary cannot run or has failed, this field displays the reason.
newCanaryStatus ::
  CanaryStatus
newCanaryStatus :: CanaryStatus
newCanaryStatus =
  CanaryStatus'
    { $sel:state:CanaryStatus' :: Maybe CanaryState
state = forall a. Maybe a
Prelude.Nothing,
      $sel:stateReason:CanaryStatus' :: Maybe Text
stateReason = forall a. Maybe a
Prelude.Nothing,
      $sel:stateReasonCode:CanaryStatus' :: Maybe CanaryStateReasonCode
stateReasonCode = forall a. Maybe a
Prelude.Nothing
    }

-- | The current state of the canary.
canaryStatus_state :: Lens.Lens' CanaryStatus (Prelude.Maybe CanaryState)
canaryStatus_state :: Lens' CanaryStatus (Maybe CanaryState)
canaryStatus_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanaryStatus' {Maybe CanaryState
state :: Maybe CanaryState
$sel:state:CanaryStatus' :: CanaryStatus -> Maybe CanaryState
state} -> Maybe CanaryState
state) (\s :: CanaryStatus
s@CanaryStatus' {} Maybe CanaryState
a -> CanaryStatus
s {$sel:state:CanaryStatus' :: Maybe CanaryState
state = Maybe CanaryState
a} :: CanaryStatus)

-- | If the canary has insufficient permissions to run, this field provides
-- more details.
canaryStatus_stateReason :: Lens.Lens' CanaryStatus (Prelude.Maybe Prelude.Text)
canaryStatus_stateReason :: Lens' CanaryStatus (Maybe Text)
canaryStatus_stateReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanaryStatus' {Maybe Text
stateReason :: Maybe Text
$sel:stateReason:CanaryStatus' :: CanaryStatus -> Maybe Text
stateReason} -> Maybe Text
stateReason) (\s :: CanaryStatus
s@CanaryStatus' {} Maybe Text
a -> CanaryStatus
s {$sel:stateReason:CanaryStatus' :: Maybe Text
stateReason = Maybe Text
a} :: CanaryStatus)

-- | If the canary cannot run or has failed, this field displays the reason.
canaryStatus_stateReasonCode :: Lens.Lens' CanaryStatus (Prelude.Maybe CanaryStateReasonCode)
canaryStatus_stateReasonCode :: Lens' CanaryStatus (Maybe CanaryStateReasonCode)
canaryStatus_stateReasonCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanaryStatus' {Maybe CanaryStateReasonCode
stateReasonCode :: Maybe CanaryStateReasonCode
$sel:stateReasonCode:CanaryStatus' :: CanaryStatus -> Maybe CanaryStateReasonCode
stateReasonCode} -> Maybe CanaryStateReasonCode
stateReasonCode) (\s :: CanaryStatus
s@CanaryStatus' {} Maybe CanaryStateReasonCode
a -> CanaryStatus
s {$sel:stateReasonCode:CanaryStatus' :: Maybe CanaryStateReasonCode
stateReasonCode = Maybe CanaryStateReasonCode
a} :: CanaryStatus)

instance Data.FromJSON CanaryStatus where
  parseJSON :: Value -> Parser CanaryStatus
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CanaryStatus"
      ( \Object
x ->
          Maybe CanaryState
-> Maybe Text -> Maybe CanaryStateReasonCode -> CanaryStatus
CanaryStatus'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"State")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"StateReason")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"StateReasonCode")
      )

instance Prelude.Hashable CanaryStatus where
  hashWithSalt :: Int -> CanaryStatus -> Int
hashWithSalt Int
_salt CanaryStatus' {Maybe Text
Maybe CanaryState
Maybe CanaryStateReasonCode
stateReasonCode :: Maybe CanaryStateReasonCode
stateReason :: Maybe Text
state :: Maybe CanaryState
$sel:stateReasonCode:CanaryStatus' :: CanaryStatus -> Maybe CanaryStateReasonCode
$sel:stateReason:CanaryStatus' :: CanaryStatus -> Maybe Text
$sel:state:CanaryStatus' :: CanaryStatus -> Maybe CanaryState
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CanaryState
state
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stateReason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CanaryStateReasonCode
stateReasonCode

instance Prelude.NFData CanaryStatus where
  rnf :: CanaryStatus -> ()
rnf CanaryStatus' {Maybe Text
Maybe CanaryState
Maybe CanaryStateReasonCode
stateReasonCode :: Maybe CanaryStateReasonCode
stateReason :: Maybe Text
state :: Maybe CanaryState
$sel:stateReasonCode:CanaryStatus' :: CanaryStatus -> Maybe CanaryStateReasonCode
$sel:stateReason:CanaryStatus' :: CanaryStatus -> Maybe Text
$sel:state:CanaryStatus' :: CanaryStatus -> Maybe CanaryState
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CanaryState
state
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stateReason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CanaryStateReasonCode
stateReasonCode