{-# 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.SageMaker.Types.BlueGreenUpdatePolicy
-- 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.SageMaker.Types.BlueGreenUpdatePolicy 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.SageMaker.Types.TrafficRoutingConfig

-- | Update policy for a blue\/green deployment. If this update policy is
-- specified, SageMaker creates a new fleet during the deployment while
-- maintaining the old fleet. SageMaker flips traffic to the new fleet
-- according to the specified traffic routing configuration. Only one
-- update policy should be used in the deployment configuration. If no
-- update policy is specified, SageMaker uses a blue\/green deployment
-- strategy with all at once traffic shifting by default.
--
-- /See:/ 'newBlueGreenUpdatePolicy' smart constructor.
data BlueGreenUpdatePolicy = BlueGreenUpdatePolicy'
  { -- | Maximum execution timeout for the deployment. Note that the timeout
    -- value should be larger than the total waiting time specified in
    -- @TerminationWaitInSeconds@ and @WaitIntervalInSeconds@.
    BlueGreenUpdatePolicy -> Maybe Natural
maximumExecutionTimeoutInSeconds :: Prelude.Maybe Prelude.Natural,
    -- | Additional waiting time in seconds after the completion of an endpoint
    -- deployment before terminating the old endpoint fleet. Default is 0.
    BlueGreenUpdatePolicy -> Maybe Natural
terminationWaitInSeconds :: Prelude.Maybe Prelude.Natural,
    -- | Defines the traffic routing strategy to shift traffic from the old fleet
    -- to the new fleet during an endpoint deployment.
    BlueGreenUpdatePolicy -> TrafficRoutingConfig
trafficRoutingConfiguration :: TrafficRoutingConfig
  }
  deriving (BlueGreenUpdatePolicy -> BlueGreenUpdatePolicy -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BlueGreenUpdatePolicy -> BlueGreenUpdatePolicy -> Bool
$c/= :: BlueGreenUpdatePolicy -> BlueGreenUpdatePolicy -> Bool
== :: BlueGreenUpdatePolicy -> BlueGreenUpdatePolicy -> Bool
$c== :: BlueGreenUpdatePolicy -> BlueGreenUpdatePolicy -> Bool
Prelude.Eq, ReadPrec [BlueGreenUpdatePolicy]
ReadPrec BlueGreenUpdatePolicy
Int -> ReadS BlueGreenUpdatePolicy
ReadS [BlueGreenUpdatePolicy]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BlueGreenUpdatePolicy]
$creadListPrec :: ReadPrec [BlueGreenUpdatePolicy]
readPrec :: ReadPrec BlueGreenUpdatePolicy
$creadPrec :: ReadPrec BlueGreenUpdatePolicy
readList :: ReadS [BlueGreenUpdatePolicy]
$creadList :: ReadS [BlueGreenUpdatePolicy]
readsPrec :: Int -> ReadS BlueGreenUpdatePolicy
$creadsPrec :: Int -> ReadS BlueGreenUpdatePolicy
Prelude.Read, Int -> BlueGreenUpdatePolicy -> ShowS
[BlueGreenUpdatePolicy] -> ShowS
BlueGreenUpdatePolicy -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BlueGreenUpdatePolicy] -> ShowS
$cshowList :: [BlueGreenUpdatePolicy] -> ShowS
show :: BlueGreenUpdatePolicy -> String
$cshow :: BlueGreenUpdatePolicy -> String
showsPrec :: Int -> BlueGreenUpdatePolicy -> ShowS
$cshowsPrec :: Int -> BlueGreenUpdatePolicy -> ShowS
Prelude.Show, forall x. Rep BlueGreenUpdatePolicy x -> BlueGreenUpdatePolicy
forall x. BlueGreenUpdatePolicy -> Rep BlueGreenUpdatePolicy x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BlueGreenUpdatePolicy x -> BlueGreenUpdatePolicy
$cfrom :: forall x. BlueGreenUpdatePolicy -> Rep BlueGreenUpdatePolicy x
Prelude.Generic)

-- |
-- Create a value of 'BlueGreenUpdatePolicy' 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:
--
-- 'maximumExecutionTimeoutInSeconds', 'blueGreenUpdatePolicy_maximumExecutionTimeoutInSeconds' - Maximum execution timeout for the deployment. Note that the timeout
-- value should be larger than the total waiting time specified in
-- @TerminationWaitInSeconds@ and @WaitIntervalInSeconds@.
--
-- 'terminationWaitInSeconds', 'blueGreenUpdatePolicy_terminationWaitInSeconds' - Additional waiting time in seconds after the completion of an endpoint
-- deployment before terminating the old endpoint fleet. Default is 0.
--
-- 'trafficRoutingConfiguration', 'blueGreenUpdatePolicy_trafficRoutingConfiguration' - Defines the traffic routing strategy to shift traffic from the old fleet
-- to the new fleet during an endpoint deployment.
newBlueGreenUpdatePolicy ::
  -- | 'trafficRoutingConfiguration'
  TrafficRoutingConfig ->
  BlueGreenUpdatePolicy
newBlueGreenUpdatePolicy :: TrafficRoutingConfig -> BlueGreenUpdatePolicy
newBlueGreenUpdatePolicy
  TrafficRoutingConfig
pTrafficRoutingConfiguration_ =
    BlueGreenUpdatePolicy'
      { $sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: Maybe Natural
maximumExecutionTimeoutInSeconds =
          forall a. Maybe a
Prelude.Nothing,
        $sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: Maybe Natural
terminationWaitInSeconds = forall a. Maybe a
Prelude.Nothing,
        $sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: TrafficRoutingConfig
trafficRoutingConfiguration =
          TrafficRoutingConfig
pTrafficRoutingConfiguration_
      }

-- | Maximum execution timeout for the deployment. Note that the timeout
-- value should be larger than the total waiting time specified in
-- @TerminationWaitInSeconds@ and @WaitIntervalInSeconds@.
blueGreenUpdatePolicy_maximumExecutionTimeoutInSeconds :: Lens.Lens' BlueGreenUpdatePolicy (Prelude.Maybe Prelude.Natural)
blueGreenUpdatePolicy_maximumExecutionTimeoutInSeconds :: Lens' BlueGreenUpdatePolicy (Maybe Natural)
blueGreenUpdatePolicy_maximumExecutionTimeoutInSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlueGreenUpdatePolicy' {Maybe Natural
maximumExecutionTimeoutInSeconds :: Maybe Natural
$sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
maximumExecutionTimeoutInSeconds} -> Maybe Natural
maximumExecutionTimeoutInSeconds) (\s :: BlueGreenUpdatePolicy
s@BlueGreenUpdatePolicy' {} Maybe Natural
a -> BlueGreenUpdatePolicy
s {$sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: Maybe Natural
maximumExecutionTimeoutInSeconds = Maybe Natural
a} :: BlueGreenUpdatePolicy)

-- | Additional waiting time in seconds after the completion of an endpoint
-- deployment before terminating the old endpoint fleet. Default is 0.
blueGreenUpdatePolicy_terminationWaitInSeconds :: Lens.Lens' BlueGreenUpdatePolicy (Prelude.Maybe Prelude.Natural)
blueGreenUpdatePolicy_terminationWaitInSeconds :: Lens' BlueGreenUpdatePolicy (Maybe Natural)
blueGreenUpdatePolicy_terminationWaitInSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlueGreenUpdatePolicy' {Maybe Natural
terminationWaitInSeconds :: Maybe Natural
$sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
terminationWaitInSeconds} -> Maybe Natural
terminationWaitInSeconds) (\s :: BlueGreenUpdatePolicy
s@BlueGreenUpdatePolicy' {} Maybe Natural
a -> BlueGreenUpdatePolicy
s {$sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: Maybe Natural
terminationWaitInSeconds = Maybe Natural
a} :: BlueGreenUpdatePolicy)

-- | Defines the traffic routing strategy to shift traffic from the old fleet
-- to the new fleet during an endpoint deployment.
blueGreenUpdatePolicy_trafficRoutingConfiguration :: Lens.Lens' BlueGreenUpdatePolicy TrafficRoutingConfig
blueGreenUpdatePolicy_trafficRoutingConfiguration :: Lens' BlueGreenUpdatePolicy TrafficRoutingConfig
blueGreenUpdatePolicy_trafficRoutingConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlueGreenUpdatePolicy' {TrafficRoutingConfig
trafficRoutingConfiguration :: TrafficRoutingConfig
$sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> TrafficRoutingConfig
trafficRoutingConfiguration} -> TrafficRoutingConfig
trafficRoutingConfiguration) (\s :: BlueGreenUpdatePolicy
s@BlueGreenUpdatePolicy' {} TrafficRoutingConfig
a -> BlueGreenUpdatePolicy
s {$sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: TrafficRoutingConfig
trafficRoutingConfiguration = TrafficRoutingConfig
a} :: BlueGreenUpdatePolicy)

instance Data.FromJSON BlueGreenUpdatePolicy where
  parseJSON :: Value -> Parser BlueGreenUpdatePolicy
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"BlueGreenUpdatePolicy"
      ( \Object
x ->
          Maybe Natural
-> Maybe Natural -> TrafficRoutingConfig -> BlueGreenUpdatePolicy
BlueGreenUpdatePolicy'
            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
"MaximumExecutionTimeoutInSeconds")
            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
"TerminationWaitInSeconds")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"TrafficRoutingConfiguration")
      )

instance Prelude.Hashable BlueGreenUpdatePolicy where
  hashWithSalt :: Int -> BlueGreenUpdatePolicy -> Int
hashWithSalt Int
_salt BlueGreenUpdatePolicy' {Maybe Natural
TrafficRoutingConfig
trafficRoutingConfiguration :: TrafficRoutingConfig
terminationWaitInSeconds :: Maybe Natural
maximumExecutionTimeoutInSeconds :: Maybe Natural
$sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> TrafficRoutingConfig
$sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
$sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maximumExecutionTimeoutInSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
terminationWaitInSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TrafficRoutingConfig
trafficRoutingConfiguration

instance Prelude.NFData BlueGreenUpdatePolicy where
  rnf :: BlueGreenUpdatePolicy -> ()
rnf BlueGreenUpdatePolicy' {Maybe Natural
TrafficRoutingConfig
trafficRoutingConfiguration :: TrafficRoutingConfig
terminationWaitInSeconds :: Maybe Natural
maximumExecutionTimeoutInSeconds :: Maybe Natural
$sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> TrafficRoutingConfig
$sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
$sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maximumExecutionTimeoutInSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
terminationWaitInSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf TrafficRoutingConfig
trafficRoutingConfiguration

instance Data.ToJSON BlueGreenUpdatePolicy where
  toJSON :: BlueGreenUpdatePolicy -> Value
toJSON BlueGreenUpdatePolicy' {Maybe Natural
TrafficRoutingConfig
trafficRoutingConfiguration :: TrafficRoutingConfig
terminationWaitInSeconds :: Maybe Natural
maximumExecutionTimeoutInSeconds :: Maybe Natural
$sel:trafficRoutingConfiguration:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> TrafficRoutingConfig
$sel:terminationWaitInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
$sel:maximumExecutionTimeoutInSeconds:BlueGreenUpdatePolicy' :: BlueGreenUpdatePolicy -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"MaximumExecutionTimeoutInSeconds" 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 Natural
maximumExecutionTimeoutInSeconds,
            (Key
"TerminationWaitInSeconds" 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 Natural
terminationWaitInSeconds,
            forall a. a -> Maybe a
Prelude.Just
              ( Key
"TrafficRoutingConfiguration"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TrafficRoutingConfig
trafficRoutingConfiguration
              )
          ]
      )