Class EmrAddStepProps
Properties for EmrAddStep.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class EmrAddStepProps : Object, IEmrAddStepProps, ITaskStateBasePropsSyntax (vb)
Public Class EmrAddStepProps
Inherits Object
Implements IEmrAddStepProps, ITaskStateBasePropsRemarks
ExampleMetadata: infused
Examples
new EmrAddStep(this, "Task", new EmrAddStepProps {
ClusterId = "ClusterId",
Name = "StepName",
Jar = "Jar",
ActionOnFailure = ActionOnFailure.CONTINUE
});Synopsis
Constructors
| EmrAddStepProps() |
Properties
| ActionOnFailure | The action to take when the cluster step fails. |
| Args | A list of command line arguments passed to the JAR file's main function when executed. |
| ClusterId | The ClusterId to add the Step to. |
| Comment | An optional description for this state. |
| Heartbeat | Timeout for the heartbeat. |
| InputPath | JSONPath expression to select part of the state to be the input to this state. |
| IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
| Jar | A path to a JAR file run during the step. |
| MainClass | The name of the main class in the specified Java file. |
| Name | The name of the Step. |
| OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
| Properties | A list of Java properties that are set when the step runs. |
| ResultPath | JSONPath expression to indicate where to inject the state's output. |
| ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
| Timeout | Timeout for the state machine. |
Constructors
EmrAddStepProps()
public EmrAddStepProps()Properties
ActionOnFailure
The action to take when the cluster step fails.
public Nullable<ActionOnFailure> ActionOnFailure { get; set; }Property Value
System.Nullable<ActionOnFailure>
Remarks
Default: ActionOnFailure.CONTINUE
See: https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html
Args
A list of command line arguments passed to the JAR file's main function when executed.
public string[] Args { get; set; }Property Value
System.String[]
Remarks
Default: - No args
See: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
ClusterId
The ClusterId to add the Step to.
public string ClusterId { get; set; }Property Value
System.String
Comment
An optional description for this state.
public string Comment { get; set; }Property Value
System.String
Remarks
Default: - No comment
Heartbeat
Timeout for the heartbeat.
public Duration Heartbeat { get; set; }Property Value
Remarks
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }Property Value
System.Nullable<IntegrationPattern>
Remarks
You can control these AWS services using service integration patterns
Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks.
IntegrationPattern.RUN_JOB for the following exceptions:
BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
Jar
A path to a JAR file run during the step.
public string Jar { get; set; }Property Value
System.String
Remarks
MainClass
The name of the main class in the specified Java file.
public string MainClass { get; set; }Property Value
System.String
Remarks
If not specified, the JAR file should specify a Main-Class in its manifest file.
Default: - No mainClass
See: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
Name
The name of the Step.
public string Name { get; set; }Property Value
System.String
Remarks
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
Properties
A list of Java properties that are set when the step runs.
public IDictionary<string, string> Properties { get; set; }Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
You can use these properties to pass key value pairs to your main function.
Default: - No properties
See: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }Property Value
Remarks
Default: - None