{-# 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.CanaryScheduleOutput
-- 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.CanaryScheduleOutput 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

-- | How long, in seconds, for the canary to continue making regular runs
-- according to the schedule in the @Expression@ value.
--
-- /See:/ 'newCanaryScheduleOutput' smart constructor.
data CanaryScheduleOutput = CanaryScheduleOutput'
  { -- | How long, in seconds, for the canary to continue making regular runs
    -- after it was created. The runs are performed according to the schedule
    -- in the @Expression@ value.
    CanaryScheduleOutput -> Maybe Natural
durationInSeconds :: Prelude.Maybe Prelude.Natural,
    -- | A @rate@ expression or a @cron@ expression that defines how often the
    -- canary is to run.
    --
    -- For a rate expression, The syntax is @rate(@/@number unit@/@)@. /unit/
    -- can be @minute@, @minutes@, or @hour@.
    --
    -- For example, @rate(1 minute)@ runs the canary once a minute,
    -- @rate(10 minutes)@ runs it once every 10 minutes, and @rate(1 hour)@
    -- runs it once every hour. You can specify a frequency between
    -- @rate(1 minute)@ and @rate(1 hour)@.
    --
    -- Specifying @rate(0 minute)@ or @rate(0 hour)@ is a special value that
    -- causes the canary to run only once when it is started.
    --
    -- Use @cron(@/@expression@/@)@ to specify a cron expression. For
    -- information about the syntax for cron expressions, see
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html Scheduling canary runs using cron>.
    CanaryScheduleOutput -> Maybe Text
expression :: Prelude.Maybe Prelude.Text
  }
  deriving (CanaryScheduleOutput -> CanaryScheduleOutput -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool
$c/= :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool
== :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool
$c== :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool
Prelude.Eq, ReadPrec [CanaryScheduleOutput]
ReadPrec CanaryScheduleOutput
Int -> ReadS CanaryScheduleOutput
ReadS [CanaryScheduleOutput]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CanaryScheduleOutput]
$creadListPrec :: ReadPrec [CanaryScheduleOutput]
readPrec :: ReadPrec CanaryScheduleOutput
$creadPrec :: ReadPrec CanaryScheduleOutput
readList :: ReadS [CanaryScheduleOutput]
$creadList :: ReadS [CanaryScheduleOutput]
readsPrec :: Int -> ReadS CanaryScheduleOutput
$creadsPrec :: Int -> ReadS CanaryScheduleOutput
Prelude.Read, Int -> CanaryScheduleOutput -> ShowS
[CanaryScheduleOutput] -> ShowS
CanaryScheduleOutput -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CanaryScheduleOutput] -> ShowS
$cshowList :: [CanaryScheduleOutput] -> ShowS
show :: CanaryScheduleOutput -> String
$cshow :: CanaryScheduleOutput -> String
showsPrec :: Int -> CanaryScheduleOutput -> ShowS
$cshowsPrec :: Int -> CanaryScheduleOutput -> ShowS
Prelude.Show, forall x. Rep CanaryScheduleOutput x -> CanaryScheduleOutput
forall x. CanaryScheduleOutput -> Rep CanaryScheduleOutput x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CanaryScheduleOutput x -> CanaryScheduleOutput
$cfrom :: forall x. CanaryScheduleOutput -> Rep CanaryScheduleOutput x
Prelude.Generic)

-- |
-- Create a value of 'CanaryScheduleOutput' 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:
--
-- 'durationInSeconds', 'canaryScheduleOutput_durationInSeconds' - How long, in seconds, for the canary to continue making regular runs
-- after it was created. The runs are performed according to the schedule
-- in the @Expression@ value.
--
-- 'expression', 'canaryScheduleOutput_expression' - A @rate@ expression or a @cron@ expression that defines how often the
-- canary is to run.
--
-- For a rate expression, The syntax is @rate(@/@number unit@/@)@. /unit/
-- can be @minute@, @minutes@, or @hour@.
--
-- For example, @rate(1 minute)@ runs the canary once a minute,
-- @rate(10 minutes)@ runs it once every 10 minutes, and @rate(1 hour)@
-- runs it once every hour. You can specify a frequency between
-- @rate(1 minute)@ and @rate(1 hour)@.
--
-- Specifying @rate(0 minute)@ or @rate(0 hour)@ is a special value that
-- causes the canary to run only once when it is started.
--
-- Use @cron(@/@expression@/@)@ to specify a cron expression. For
-- information about the syntax for cron expressions, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html Scheduling canary runs using cron>.
newCanaryScheduleOutput ::
  CanaryScheduleOutput
newCanaryScheduleOutput :: CanaryScheduleOutput
newCanaryScheduleOutput =
  CanaryScheduleOutput'
    { $sel:durationInSeconds:CanaryScheduleOutput' :: Maybe Natural
durationInSeconds =
        forall a. Maybe a
Prelude.Nothing,
      $sel:expression:CanaryScheduleOutput' :: Maybe Text
expression = forall a. Maybe a
Prelude.Nothing
    }

-- | How long, in seconds, for the canary to continue making regular runs
-- after it was created. The runs are performed according to the schedule
-- in the @Expression@ value.
canaryScheduleOutput_durationInSeconds :: Lens.Lens' CanaryScheduleOutput (Prelude.Maybe Prelude.Natural)
canaryScheduleOutput_durationInSeconds :: Lens' CanaryScheduleOutput (Maybe Natural)
canaryScheduleOutput_durationInSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanaryScheduleOutput' {Maybe Natural
durationInSeconds :: Maybe Natural
$sel:durationInSeconds:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Natural
durationInSeconds} -> Maybe Natural
durationInSeconds) (\s :: CanaryScheduleOutput
s@CanaryScheduleOutput' {} Maybe Natural
a -> CanaryScheduleOutput
s {$sel:durationInSeconds:CanaryScheduleOutput' :: Maybe Natural
durationInSeconds = Maybe Natural
a} :: CanaryScheduleOutput)

-- | A @rate@ expression or a @cron@ expression that defines how often the
-- canary is to run.
--
-- For a rate expression, The syntax is @rate(@/@number unit@/@)@. /unit/
-- can be @minute@, @minutes@, or @hour@.
--
-- For example, @rate(1 minute)@ runs the canary once a minute,
-- @rate(10 minutes)@ runs it once every 10 minutes, and @rate(1 hour)@
-- runs it once every hour. You can specify a frequency between
-- @rate(1 minute)@ and @rate(1 hour)@.
--
-- Specifying @rate(0 minute)@ or @rate(0 hour)@ is a special value that
-- causes the canary to run only once when it is started.
--
-- Use @cron(@/@expression@/@)@ to specify a cron expression. For
-- information about the syntax for cron expressions, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html Scheduling canary runs using cron>.
canaryScheduleOutput_expression :: Lens.Lens' CanaryScheduleOutput (Prelude.Maybe Prelude.Text)
canaryScheduleOutput_expression :: Lens' CanaryScheduleOutput (Maybe Text)
canaryScheduleOutput_expression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanaryScheduleOutput' {Maybe Text
expression :: Maybe Text
$sel:expression:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Text
expression} -> Maybe Text
expression) (\s :: CanaryScheduleOutput
s@CanaryScheduleOutput' {} Maybe Text
a -> CanaryScheduleOutput
s {$sel:expression:CanaryScheduleOutput' :: Maybe Text
expression = Maybe Text
a} :: CanaryScheduleOutput)

instance Data.FromJSON CanaryScheduleOutput where
  parseJSON :: Value -> Parser CanaryScheduleOutput
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CanaryScheduleOutput"
      ( \Object
x ->
          Maybe Natural -> Maybe Text -> CanaryScheduleOutput
CanaryScheduleOutput'
            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
"DurationInSeconds")
            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
"Expression")
      )

instance Prelude.Hashable CanaryScheduleOutput where
  hashWithSalt :: Int -> CanaryScheduleOutput -> Int
hashWithSalt Int
_salt CanaryScheduleOutput' {Maybe Natural
Maybe Text
expression :: Maybe Text
durationInSeconds :: Maybe Natural
$sel:expression:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Text
$sel:durationInSeconds:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
durationInSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
expression

instance Prelude.NFData CanaryScheduleOutput where
  rnf :: CanaryScheduleOutput -> ()
rnf CanaryScheduleOutput' {Maybe Natural
Maybe Text
expression :: Maybe Text
durationInSeconds :: Maybe Natural
$sel:expression:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Text
$sel:durationInSeconds:CanaryScheduleOutput' :: CanaryScheduleOutput -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
durationInSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
expression