Package 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.104.0 (build e79254c)",
           date="2024-12-06T14:43:27.888Z")
@Stability(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	Description
static final class	EmrAddStepProps.Builder	A builder for EmrAddStepProps
static final class	EmrAddStepProps.Jsii$Proxy	An implementation for EmrAddStepProps

Method Summary

Modifier and Type	Method	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.
default String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
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.jsii.JsiiSerializable

$jsii$toJson

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

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getClusterId

@Stability(Stable)
@NotNull
String getClusterId()

The ClusterId to add the Step to.

getJar

@Stability(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(Stable)
@NotNull
String getName()

The name of the Step.

See Also:

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

getActionOnFailure

@Stability(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(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

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

Default: - Uses EC2 instance profile role

See Also:

• https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html#API_AddJobFlowSteps_RequestSyntax

getMainClass

@Stability(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(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(Stable)
static EmrAddStepProps.Builder builder()

Returns:

a EmrAddStepProps.Builder of EmrAddStepProps