Package software.amazon.awscdk.services.emr

Class CfnStep

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.emr.CfnStep
All Implemented Interfaces:
IInspectable, IStepRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:36.796Z") @Stability(Stable) public class CfnStep extends CfnResource implements IInspectable, IStepRef
Use Step to specify a cluster (job flow) step, which runs only on the master node.

Steps are used to submit data processing jobs to a cluster.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emr.*;
 CfnStep cfnStep = CfnStep.Builder.create(this, "MyCfnStep")
         .actionOnFailure("actionOnFailure")
         .hadoopJarStep(HadoopJarStepConfigProperty.builder()
                 .jar("jar")
                 // the properties below are optional
                 .args(List.of("args"))
                 .mainClass("mainClass")
                 .stepProperties(List.of(KeyValueProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .jobFlowId("jobFlowId")
         .name("name")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStep

      protected CfnStep(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStep

      protected CfnStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStep

      @Stability(Stable) public CfnStep(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStepProps props)
      Create a new AWS::EMR::Step.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnStep

      @Stability(Stable) @NotNull public static Boolean isCfnStep(@NotNull Object x)
      Checks whether the given object is a CfnStep.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the cluster step.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStepRef

      @Stability(Stable) @NotNull public StepReference getStepRef()
      A reference to a Step resource.
      Specified by:
      getStepRef in interface IStepRef

    • getActionOnFailure

      @Stability(Stable) @NotNull public String getActionOnFailure()
      This specifies what action to take when the cluster step fails.

    • setActionOnFailure

      @Stability(Stable) public void setActionOnFailure(@NotNull String value)
      This specifies what action to take when the cluster step fails.

    • getHadoopJarStep

      @Stability(Stable) @NotNull public Object getHadoopJarStep()
      The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.

      Returns union: either IResolvable or CfnStep.HadoopJarStepConfigProperty

    • setHadoopJarStep

      @Stability(Stable) public void setHadoopJarStep(@NotNull IResolvable value)
      The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.

    • setHadoopJarStep

      @Stability(Stable) public void setHadoopJarStep(@NotNull CfnStep.HadoopJarStepConfigProperty value)
      The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.

    • getJobFlowId

      @Stability(Stable) @NotNull public String getJobFlowId()
      A string that uniquely identifies the cluster (job flow).

    • setJobFlowId

      @Stability(Stable) public void setJobFlowId(@NotNull String value)
      A string that uniquely identifies the cluster (job flow).

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the cluster step.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the cluster step.