Package software.amazon.awscdk.services.emr

Class CfnStep

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.emr.CfnStep
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.657Z") @Stability(Stable) public class CfnStep extends CfnResource implements IInspectable
A CloudFormation AWS::EMR::Step.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getCfnProperties

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

    • getActionOnFailure

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

      Possible values are CANCEL_AND_WAIT and CONTINUE .

    • setActionOnFailure

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

      Possible values are CANCEL_AND_WAIT and CONTINUE .

    • 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.

      The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.

    • 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.

      The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.

    • 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.

      The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.

    • 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.