Class: Aws::EMR::Types::StepConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb

Overview

Note:

When making an API call, you may pass StepConfig data as a hash:

{
  name: "XmlStringMaxLen256", # required
  action_on_failure: "TERMINATE_JOB_FLOW", # accepts TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
  hadoop_jar_step: { # required
    properties: [
      {
        key: "XmlString",
        value: "XmlString",
      },
    ],
    jar: "XmlString", # required
    main_class: "XmlString",
    args: ["XmlString"],
  },
}

Specification for a cluster (job flow) step.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_on_failure ⇒ String

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.

Returns:

  • (String) 


7468
7469
7470
7471
7472
7473
7474
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7468

class StepConfig < Struct.new(
  :name,
  :action_on_failure,
  :hadoop_jar_step)
  SENSITIVE = []
  include Aws::Structure
end

#hadoop_jar_step ⇒ Types::HadoopJarStepConfig

The JAR file used for the step.

Returns:



7468
7469
7470
7471
7472
7473
7474
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7468

class StepConfig < Struct.new(
  :name,
  :action_on_failure,
  :hadoop_jar_step)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the step.

Returns:

  • (String) 


7468
7469
7470
7471
7472
7473
7474
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7468

class StepConfig < Struct.new(
  :name,
  :action_on_failure,
  :hadoop_jar_step)
  SENSITIVE = []
  include Aws::Structure
end