{-# 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.EMR.Types.StepConfig
-- 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.EMR.Types.StepConfig where

import qualified Amazonka.Core as Core
import Amazonka.EMR.Types.ActionOnFailure
import Amazonka.EMR.Types.HadoopJarStepConfig
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Specification for a cluster (job flow) step.
--
-- /See:/ 'newStepConfig' smart constructor.
data StepConfig = StepConfig'
  { -- | The action to take when the step fails. Use one of the following values:
    --
    -- -   @TERMINATE_CLUSTER@ - Shuts down the cluster.
    --
    -- -   @CANCEL_AND_WAIT@ - Cancels any pending steps and returns the
    --     cluster to the @WAITING@ state.
    --
    -- -   @CONTINUE@ - Continues to the next step in the queue.
    --
    -- -   @TERMINATE_JOB_FLOW@ - Shuts down the cluster. @TERMINATE_JOB_FLOW@
    --     is provided for backward compatibility. We recommend using
    --     @TERMINATE_CLUSTER@ instead.
    --
    -- If a cluster\'s @StepConcurrencyLevel@ is greater than @1@, do not use
    -- @AddJobFlowSteps@ to submit a step with this parameter set to
    -- @CANCEL_AND_WAIT@ or @TERMINATE_CLUSTER@. The step is not submitted and
    -- the action fails with a message that the @ActionOnFailure@ setting is
    -- not valid.
    --
    -- If you change a cluster\'s @StepConcurrencyLevel@ to be greater than 1
    -- while a step is running, the @ActionOnFailure@ parameter may not behave
    -- as you expect. In this case, for a step that fails with this parameter
    -- set to @CANCEL_AND_WAIT@, pending steps and the running step are not
    -- canceled; for a step that fails with this parameter set to
    -- @TERMINATE_CLUSTER@, the cluster does not terminate.
    StepConfig -> Maybe ActionOnFailure
actionOnFailure :: Prelude.Maybe ActionOnFailure,
    -- | The name of the step.
    StepConfig -> Text
name :: Prelude.Text,
    -- | The JAR file used for the step.
    StepConfig -> HadoopJarStepConfig
hadoopJarStep :: HadoopJarStepConfig
  }
  deriving (StepConfig -> StepConfig -> Bool
(StepConfig -> StepConfig -> Bool)
-> (StepConfig -> StepConfig -> Bool) -> Eq StepConfig
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StepConfig -> StepConfig -> Bool
$c/= :: StepConfig -> StepConfig -> Bool
== :: StepConfig -> StepConfig -> Bool
$c== :: StepConfig -> StepConfig -> Bool
Prelude.Eq, ReadPrec [StepConfig]
ReadPrec StepConfig
Int -> ReadS StepConfig
ReadS [StepConfig]
(Int -> ReadS StepConfig)
-> ReadS [StepConfig]
-> ReadPrec StepConfig
-> ReadPrec [StepConfig]
-> Read StepConfig
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StepConfig]
$creadListPrec :: ReadPrec [StepConfig]
readPrec :: ReadPrec StepConfig
$creadPrec :: ReadPrec StepConfig
readList :: ReadS [StepConfig]
$creadList :: ReadS [StepConfig]
readsPrec :: Int -> ReadS StepConfig
$creadsPrec :: Int -> ReadS StepConfig
Prelude.Read, Int -> StepConfig -> ShowS
[StepConfig] -> ShowS
StepConfig -> String
(Int -> StepConfig -> ShowS)
-> (StepConfig -> String)
-> ([StepConfig] -> ShowS)
-> Show StepConfig
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StepConfig] -> ShowS
$cshowList :: [StepConfig] -> ShowS
show :: StepConfig -> String
$cshow :: StepConfig -> String
showsPrec :: Int -> StepConfig -> ShowS
$cshowsPrec :: Int -> StepConfig -> ShowS
Prelude.Show, (forall x. StepConfig -> Rep StepConfig x)
-> (forall x. Rep StepConfig x -> StepConfig) -> Generic StepConfig
forall x. Rep StepConfig x -> StepConfig
forall x. StepConfig -> Rep StepConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StepConfig x -> StepConfig
$cfrom :: forall x. StepConfig -> Rep StepConfig x
Prelude.Generic)

-- |
-- Create a value of 'StepConfig' 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:
--
-- 'actionOnFailure', 'stepConfig_actionOnFailure' - The action to take when the step fails. Use one of the following values:
--
-- -   @TERMINATE_CLUSTER@ - Shuts down the cluster.
--
-- -   @CANCEL_AND_WAIT@ - Cancels any pending steps and returns the
--     cluster to the @WAITING@ state.
--
-- -   @CONTINUE@ - Continues to the next step in the queue.
--
-- -   @TERMINATE_JOB_FLOW@ - Shuts down the cluster. @TERMINATE_JOB_FLOW@
--     is provided for backward compatibility. We recommend using
--     @TERMINATE_CLUSTER@ instead.
--
-- If a cluster\'s @StepConcurrencyLevel@ is greater than @1@, do not use
-- @AddJobFlowSteps@ to submit a step with this parameter set to
-- @CANCEL_AND_WAIT@ or @TERMINATE_CLUSTER@. The step is not submitted and
-- the action fails with a message that the @ActionOnFailure@ setting is
-- not valid.
--
-- If you change a cluster\'s @StepConcurrencyLevel@ to be greater than 1
-- while a step is running, the @ActionOnFailure@ parameter may not behave
-- as you expect. In this case, for a step that fails with this parameter
-- set to @CANCEL_AND_WAIT@, pending steps and the running step are not
-- canceled; for a step that fails with this parameter set to
-- @TERMINATE_CLUSTER@, the cluster does not terminate.
--
-- 'name', 'stepConfig_name' - The name of the step.
--
-- 'hadoopJarStep', 'stepConfig_hadoopJarStep' - The JAR file used for the step.
newStepConfig ::
  -- | 'name'
  Prelude.Text ->
  -- | 'hadoopJarStep'
  HadoopJarStepConfig ->
  StepConfig
newStepConfig :: Text -> HadoopJarStepConfig -> StepConfig
newStepConfig Text
pName_ HadoopJarStepConfig
pHadoopJarStep_ =
  StepConfig' :: Maybe ActionOnFailure -> Text -> HadoopJarStepConfig -> StepConfig
StepConfig'
    { $sel:actionOnFailure:StepConfig' :: Maybe ActionOnFailure
actionOnFailure = Maybe ActionOnFailure
forall a. Maybe a
Prelude.Nothing,
      $sel:name:StepConfig' :: Text
name = Text
pName_,
      $sel:hadoopJarStep:StepConfig' :: HadoopJarStepConfig
hadoopJarStep = HadoopJarStepConfig
pHadoopJarStep_
    }

-- | The action to take when the step fails. Use one of the following values:
--
-- -   @TERMINATE_CLUSTER@ - Shuts down the cluster.
--
-- -   @CANCEL_AND_WAIT@ - Cancels any pending steps and returns the
--     cluster to the @WAITING@ state.
--
-- -   @CONTINUE@ - Continues to the next step in the queue.
--
-- -   @TERMINATE_JOB_FLOW@ - Shuts down the cluster. @TERMINATE_JOB_FLOW@
--     is provided for backward compatibility. We recommend using
--     @TERMINATE_CLUSTER@ instead.
--
-- If a cluster\'s @StepConcurrencyLevel@ is greater than @1@, do not use
-- @AddJobFlowSteps@ to submit a step with this parameter set to
-- @CANCEL_AND_WAIT@ or @TERMINATE_CLUSTER@. The step is not submitted and
-- the action fails with a message that the @ActionOnFailure@ setting is
-- not valid.
--
-- If you change a cluster\'s @StepConcurrencyLevel@ to be greater than 1
-- while a step is running, the @ActionOnFailure@ parameter may not behave
-- as you expect. In this case, for a step that fails with this parameter
-- set to @CANCEL_AND_WAIT@, pending steps and the running step are not
-- canceled; for a step that fails with this parameter set to
-- @TERMINATE_CLUSTER@, the cluster does not terminate.
stepConfig_actionOnFailure :: Lens.Lens' StepConfig (Prelude.Maybe ActionOnFailure)
stepConfig_actionOnFailure :: (Maybe ActionOnFailure -> f (Maybe ActionOnFailure))
-> StepConfig -> f StepConfig
stepConfig_actionOnFailure = (StepConfig -> Maybe ActionOnFailure)
-> (StepConfig -> Maybe ActionOnFailure -> StepConfig)
-> Lens
     StepConfig
     StepConfig
     (Maybe ActionOnFailure)
     (Maybe ActionOnFailure)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StepConfig' {Maybe ActionOnFailure
actionOnFailure :: Maybe ActionOnFailure
$sel:actionOnFailure:StepConfig' :: StepConfig -> Maybe ActionOnFailure
actionOnFailure} -> Maybe ActionOnFailure
actionOnFailure) (\s :: StepConfig
s@StepConfig' {} Maybe ActionOnFailure
a -> StepConfig
s {$sel:actionOnFailure:StepConfig' :: Maybe ActionOnFailure
actionOnFailure = Maybe ActionOnFailure
a} :: StepConfig)

-- | The name of the step.
stepConfig_name :: Lens.Lens' StepConfig Prelude.Text
stepConfig_name :: (Text -> f Text) -> StepConfig -> f StepConfig
stepConfig_name = (StepConfig -> Text)
-> (StepConfig -> Text -> StepConfig)
-> Lens StepConfig StepConfig Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StepConfig' {Text
name :: Text
$sel:name:StepConfig' :: StepConfig -> Text
name} -> Text
name) (\s :: StepConfig
s@StepConfig' {} Text
a -> StepConfig
s {$sel:name:StepConfig' :: Text
name = Text
a} :: StepConfig)

-- | The JAR file used for the step.
stepConfig_hadoopJarStep :: Lens.Lens' StepConfig HadoopJarStepConfig
stepConfig_hadoopJarStep :: (HadoopJarStepConfig -> f HadoopJarStepConfig)
-> StepConfig -> f StepConfig
stepConfig_hadoopJarStep = (StepConfig -> HadoopJarStepConfig)
-> (StepConfig -> HadoopJarStepConfig -> StepConfig)
-> Lens
     StepConfig StepConfig HadoopJarStepConfig HadoopJarStepConfig
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StepConfig' {HadoopJarStepConfig
hadoopJarStep :: HadoopJarStepConfig
$sel:hadoopJarStep:StepConfig' :: StepConfig -> HadoopJarStepConfig
hadoopJarStep} -> HadoopJarStepConfig
hadoopJarStep) (\s :: StepConfig
s@StepConfig' {} HadoopJarStepConfig
a -> StepConfig
s {$sel:hadoopJarStep:StepConfig' :: HadoopJarStepConfig
hadoopJarStep = HadoopJarStepConfig
a} :: StepConfig)

instance Prelude.Hashable StepConfig

instance Prelude.NFData StepConfig

instance Core.ToJSON StepConfig where
  toJSON :: StepConfig -> Value
toJSON StepConfig' {Maybe ActionOnFailure
Text
HadoopJarStepConfig
hadoopJarStep :: HadoopJarStepConfig
name :: Text
actionOnFailure :: Maybe ActionOnFailure
$sel:hadoopJarStep:StepConfig' :: StepConfig -> HadoopJarStepConfig
$sel:name:StepConfig' :: StepConfig -> Text
$sel:actionOnFailure:StepConfig' :: StepConfig -> Maybe ActionOnFailure
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"ActionOnFailure" Text -> ActionOnFailure -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (ActionOnFailure -> Pair) -> Maybe ActionOnFailure -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ActionOnFailure
actionOnFailure,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Name" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
name),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"HadoopJarStep" Text -> HadoopJarStepConfig -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= HadoopJarStepConfig
hadoopJarStep)
          ]
      )