{-# 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.ImageBuilder.Types.Schedule
-- 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.ImageBuilder.Types.Schedule where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.ImageBuilder.Types.PipelineExecutionStartCondition
import qualified Amazonka.Prelude as Prelude

-- | A schedule configures how often and when a pipeline will automatically
-- create a new image.
--
-- /See:/ 'newSchedule' smart constructor.
data Schedule = Schedule'
  { -- | The condition configures when the pipeline should trigger a new image
    -- build. When the @pipelineExecutionStartCondition@ is set to
    -- @EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE@, and you use
    -- semantic version filters on the base image or components in your image
    -- recipe, EC2 Image Builder will build a new image only when there are new
    -- versions of the image or components in your recipe that match the
    -- semantic version filter. When it is set to @EXPRESSION_MATCH_ONLY@, it
    -- will build a new image every time the CRON expression matches the
    -- current time. For semantic version syntax, see
    -- <https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html CreateComponent>
    -- in the /EC2 Image Builder API Reference/.
    Schedule -> Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition :: Prelude.Maybe PipelineExecutionStartCondition,
    -- | The cron expression determines how often EC2 Image Builder evaluates
    -- your @pipelineExecutionStartCondition@.
    --
    -- For information on how to format a cron expression in Image Builder, see
    -- <https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html Use cron expressions in EC2 Image Builder>.
    Schedule -> Maybe Text
scheduleExpression :: Prelude.Maybe Prelude.Text,
    -- | The timezone that applies to the scheduling expression. For example,
    -- \"Etc\/UTC\", \"America\/Los_Angeles\" in the
    -- <https://www.joda.org/joda-time/timezones.html IANA timezone format>. If
    -- not specified this defaults to UTC.
    Schedule -> Maybe Text
timezone :: Prelude.Maybe Prelude.Text
  }
  deriving (Schedule -> Schedule -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Schedule -> Schedule -> Bool
$c/= :: Schedule -> Schedule -> Bool
== :: Schedule -> Schedule -> Bool
$c== :: Schedule -> Schedule -> Bool
Prelude.Eq, ReadPrec [Schedule]
ReadPrec Schedule
Int -> ReadS Schedule
ReadS [Schedule]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Schedule]
$creadListPrec :: ReadPrec [Schedule]
readPrec :: ReadPrec Schedule
$creadPrec :: ReadPrec Schedule
readList :: ReadS [Schedule]
$creadList :: ReadS [Schedule]
readsPrec :: Int -> ReadS Schedule
$creadsPrec :: Int -> ReadS Schedule
Prelude.Read, Int -> Schedule -> ShowS
[Schedule] -> ShowS
Schedule -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Schedule] -> ShowS
$cshowList :: [Schedule] -> ShowS
show :: Schedule -> String
$cshow :: Schedule -> String
showsPrec :: Int -> Schedule -> ShowS
$cshowsPrec :: Int -> Schedule -> ShowS
Prelude.Show, forall x. Rep Schedule x -> Schedule
forall x. Schedule -> Rep Schedule x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Schedule x -> Schedule
$cfrom :: forall x. Schedule -> Rep Schedule x
Prelude.Generic)

-- |
-- Create a value of 'Schedule' 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:
--
-- 'pipelineExecutionStartCondition', 'schedule_pipelineExecutionStartCondition' - The condition configures when the pipeline should trigger a new image
-- build. When the @pipelineExecutionStartCondition@ is set to
-- @EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE@, and you use
-- semantic version filters on the base image or components in your image
-- recipe, EC2 Image Builder will build a new image only when there are new
-- versions of the image or components in your recipe that match the
-- semantic version filter. When it is set to @EXPRESSION_MATCH_ONLY@, it
-- will build a new image every time the CRON expression matches the
-- current time. For semantic version syntax, see
-- <https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html CreateComponent>
-- in the /EC2 Image Builder API Reference/.
--
-- 'scheduleExpression', 'schedule_scheduleExpression' - The cron expression determines how often EC2 Image Builder evaluates
-- your @pipelineExecutionStartCondition@.
--
-- For information on how to format a cron expression in Image Builder, see
-- <https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html Use cron expressions in EC2 Image Builder>.
--
-- 'timezone', 'schedule_timezone' - The timezone that applies to the scheduling expression. For example,
-- \"Etc\/UTC\", \"America\/Los_Angeles\" in the
-- <https://www.joda.org/joda-time/timezones.html IANA timezone format>. If
-- not specified this defaults to UTC.
newSchedule ::
  Schedule
newSchedule :: Schedule
newSchedule =
  Schedule'
    { $sel:pipelineExecutionStartCondition:Schedule' :: Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition =
        forall a. Maybe a
Prelude.Nothing,
      $sel:scheduleExpression:Schedule' :: Maybe Text
scheduleExpression = forall a. Maybe a
Prelude.Nothing,
      $sel:timezone:Schedule' :: Maybe Text
timezone = forall a. Maybe a
Prelude.Nothing
    }

-- | The condition configures when the pipeline should trigger a new image
-- build. When the @pipelineExecutionStartCondition@ is set to
-- @EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE@, and you use
-- semantic version filters on the base image or components in your image
-- recipe, EC2 Image Builder will build a new image only when there are new
-- versions of the image or components in your recipe that match the
-- semantic version filter. When it is set to @EXPRESSION_MATCH_ONLY@, it
-- will build a new image every time the CRON expression matches the
-- current time. For semantic version syntax, see
-- <https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html CreateComponent>
-- in the /EC2 Image Builder API Reference/.
schedule_pipelineExecutionStartCondition :: Lens.Lens' Schedule (Prelude.Maybe PipelineExecutionStartCondition)
schedule_pipelineExecutionStartCondition :: Lens' Schedule (Maybe PipelineExecutionStartCondition)
schedule_pipelineExecutionStartCondition = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Schedule' {Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition :: Maybe PipelineExecutionStartCondition
$sel:pipelineExecutionStartCondition:Schedule' :: Schedule -> Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition} -> Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition) (\s :: Schedule
s@Schedule' {} Maybe PipelineExecutionStartCondition
a -> Schedule
s {$sel:pipelineExecutionStartCondition:Schedule' :: Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition = Maybe PipelineExecutionStartCondition
a} :: Schedule)

-- | The cron expression determines how often EC2 Image Builder evaluates
-- your @pipelineExecutionStartCondition@.
--
-- For information on how to format a cron expression in Image Builder, see
-- <https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html Use cron expressions in EC2 Image Builder>.
schedule_scheduleExpression :: Lens.Lens' Schedule (Prelude.Maybe Prelude.Text)
schedule_scheduleExpression :: Lens' Schedule (Maybe Text)
schedule_scheduleExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Schedule' {Maybe Text
scheduleExpression :: Maybe Text
$sel:scheduleExpression:Schedule' :: Schedule -> Maybe Text
scheduleExpression} -> Maybe Text
scheduleExpression) (\s :: Schedule
s@Schedule' {} Maybe Text
a -> Schedule
s {$sel:scheduleExpression:Schedule' :: Maybe Text
scheduleExpression = Maybe Text
a} :: Schedule)

-- | The timezone that applies to the scheduling expression. For example,
-- \"Etc\/UTC\", \"America\/Los_Angeles\" in the
-- <https://www.joda.org/joda-time/timezones.html IANA timezone format>. If
-- not specified this defaults to UTC.
schedule_timezone :: Lens.Lens' Schedule (Prelude.Maybe Prelude.Text)
schedule_timezone :: Lens' Schedule (Maybe Text)
schedule_timezone = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Schedule' {Maybe Text
timezone :: Maybe Text
$sel:timezone:Schedule' :: Schedule -> Maybe Text
timezone} -> Maybe Text
timezone) (\s :: Schedule
s@Schedule' {} Maybe Text
a -> Schedule
s {$sel:timezone:Schedule' :: Maybe Text
timezone = Maybe Text
a} :: Schedule)

instance Data.FromJSON Schedule where
  parseJSON :: Value -> Parser Schedule
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Schedule"
      ( \Object
x ->
          Maybe PipelineExecutionStartCondition
-> Maybe Text -> Maybe Text -> Schedule
Schedule'
            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
"pipelineExecutionStartCondition")
            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
"scheduleExpression")
            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
"timezone")
      )

instance Prelude.Hashable Schedule where
  hashWithSalt :: Int -> Schedule -> Int
hashWithSalt Int
_salt Schedule' {Maybe Text
Maybe PipelineExecutionStartCondition
timezone :: Maybe Text
scheduleExpression :: Maybe Text
pipelineExecutionStartCondition :: Maybe PipelineExecutionStartCondition
$sel:timezone:Schedule' :: Schedule -> Maybe Text
$sel:scheduleExpression:Schedule' :: Schedule -> Maybe Text
$sel:pipelineExecutionStartCondition:Schedule' :: Schedule -> Maybe PipelineExecutionStartCondition
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
scheduleExpression
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
timezone

instance Prelude.NFData Schedule where
  rnf :: Schedule -> ()
rnf Schedule' {Maybe Text
Maybe PipelineExecutionStartCondition
timezone :: Maybe Text
scheduleExpression :: Maybe Text
pipelineExecutionStartCondition :: Maybe PipelineExecutionStartCondition
$sel:timezone:Schedule' :: Schedule -> Maybe Text
$sel:scheduleExpression:Schedule' :: Schedule -> Maybe Text
$sel:pipelineExecutionStartCondition:Schedule' :: Schedule -> Maybe PipelineExecutionStartCondition
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
scheduleExpression
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
timezone

instance Data.ToJSON Schedule where
  toJSON :: Schedule -> Value
toJSON Schedule' {Maybe Text
Maybe PipelineExecutionStartCondition
timezone :: Maybe Text
scheduleExpression :: Maybe Text
pipelineExecutionStartCondition :: Maybe PipelineExecutionStartCondition
$sel:timezone:Schedule' :: Schedule -> Maybe Text
$sel:scheduleExpression:Schedule' :: Schedule -> Maybe Text
$sel:pipelineExecutionStartCondition:Schedule' :: Schedule -> Maybe PipelineExecutionStartCondition
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"pipelineExecutionStartCondition" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe PipelineExecutionStartCondition
pipelineExecutionStartCondition,
            (Key
"scheduleExpression" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
scheduleExpression,
            (Key
"timezone" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
timezone
          ]
      )