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)
Safe Haskell	None

Amazonka.EMR.Types.StepConfig

Description

Synopsis

Documentation

data StepConfig Source #

Specification for a cluster (job flow) step.

See: newStepConfig smart constructor.

Constructors

StepConfig'

Fields

actionOnFailure :: Maybe 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 :: Text
The name of the step.
hadoopJarStep :: HadoopJarStepConfig
The JAR file used for the step.

Instances

Instances details

Eq StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods (==) :: StepConfig -> StepConfig -> Bool # (/=) :: StepConfig -> StepConfig -> Bool #
Read StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods readsPrec :: Int -> ReadS StepConfig # readList :: ReadS [StepConfig] # readPrec :: ReadPrec StepConfig # readListPrec :: ReadPrec [StepConfig] #
Show StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods showsPrec :: Int -> StepConfig -> ShowS # show :: StepConfig -> String # showList :: [StepConfig] -> ShowS #
Generic StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Associated Types type Rep StepConfig :: Type -> Type # Methods from :: StepConfig -> Rep StepConfig x # to :: Rep StepConfig x -> StepConfig #
NFData StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods rnf :: StepConfig -> () #
Hashable StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods hashWithSalt :: Int -> StepConfig -> Int # hash :: StepConfig -> Int #
ToJSON StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig Methods toJSON :: StepConfig -> Value # toEncoding :: StepConfig -> Encoding # toJSONList :: [StepConfig] -> Value # toEncodingList :: [StepConfig] -> Encoding #
type Rep StepConfig Source #
Instance details Defined in Amazonka.EMR.Types.StepConfig type Rep StepConfig = D1 ('MetaData "StepConfig" "Amazonka.EMR.Types.StepConfig" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "StepConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "actionOnFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionOnFailure)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "hadoopJarStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HadoopJarStepConfig))))

newStepConfig Source #

Arguments

:: Text	`$sel:name:StepConfig'`
-> HadoopJarStepConfig	`$sel:hadoopJarStep:StepConfig'`
-> StepConfig

Create a value of StepConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:actionOnFailure:StepConfig', 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.

$sel:name:StepConfig', stepConfig_name - The name of the step.

$sel:hadoopJarStep:StepConfig', stepConfig_hadoopJarStep - The JAR file used for the step.

stepConfig_actionOnFailure :: Lens' StepConfig (Maybe ActionOnFailure) Source #

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_name :: Lens' StepConfig Text Source #

The name of the step.

stepConfig_hadoopJarStep :: Lens' StepConfig HadoopJarStepConfig Source #

The JAR file used for the step.