software.amazon.awscdk.services.stepfunctions.tasks

Interface EmrAddStepProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

EmrAddStepProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:50.958Z")
 @Stability(value=Stable)
public interface EmrAddStepProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for EmrAddStep.

Example:

 EmrAddStep.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .name("StepName")
         .jar("Jar")
         .actionOnFailure(ActionOnFailure.CONTINUE)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EmrAddStepProps.Builder A builder for EmrAddStepProps
static class	EmrAddStepProps.Jsii$Proxy An implementation for EmrAddStepProps

Method Summary

Modifier and Type	Method and Description
static EmrAddStepProps.Builder	builder()
default ActionOnFailure	getActionOnFailure() The action to take when the cluster step fails.
default List<String>	getArgs() A list of command line arguments passed to the JAR file's main function when executed.
String	getClusterId() The ClusterId to add the Step to.
String	getJar() A path to a JAR file run during the step.
default String	getMainClass() The name of the main class in the specified Java file.
String	getName() The name of the Step.
default Map<String,String>	getProperties() A list of Java properties that are set when the step runs.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterId

@Stability(value=Stable)
 @NotNull
String getClusterId()

The ClusterId to add the Step to.

getJar

@Stability(value=Stable)
 @NotNull
String getJar()

A path to a JAR file run during the step.

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the Step.

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html

getActionOnFailure

@Stability(value=Stable)
 @Nullable
default ActionOnFailure getActionOnFailure()

The action to take when the cluster step fails.

Default: ActionOnFailure.CONTINUE

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html

getArgs

@Stability(value=Stable)
 @Nullable
default List<String> getArgs()

A list of command line arguments passed to the JAR file's main function when executed.

Default: - No args

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

getMainClass

@Stability(value=Stable)
 @Nullable
default String getMainClass()

The name of the main class in the specified Java file.

If not specified, the JAR file should specify a Main-Class in its manifest file.

Default: - No mainClass

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

getProperties

@Stability(value=Stable)
 @Nullable
default Map<String,String> getProperties()

A list of Java properties that are set when the step runs.

You can use these properties to pass key value pairs to your main function.

Default: - No properties

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

builder

@Stability(value=Stable)
static EmrAddStepProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a EmrAddStepProps.Builder of EmrAddStepProps