EmrAddStepProps

class aws_cdk.aws_stepfunctions_tasks.EmrAddStepProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, cluster_id, jar, name, action_on_failure=None, args=None, main_class=None, properties=None)

Bases: TaskStateBaseProps

Properties for EmrAddStep.

Parameters:

  • comment (Optional[str]) – An optional description for this state. Default: - No comment

  • heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None

  • input_path (Optional[str]) – JSONPath expression to select part of the state to be the input to this state. 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 ‘$’)

  • integration_pattern (Optional[IntegrationPattern]) – AWS Step Functions integrates with services directly in the Amazon States Language. 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.

  • output_path (Optional[str]) – JSONPath expression to select select a portion of the state output to pass to the next state. 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 ‘$’)

  • result_path (Optional[str]) – JSONPath expression to indicate where to inject the state’s output. 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 ‘$’)

  • result_selector (Optional[Mapping[str, Any]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - None

  • timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

  • cluster_id (str) – The ClusterId to add the Step to.

  • jar (str) – A path to a JAR file run during the step.

  • name (str) – The name of the Step.

  • action_on_failure (Optional[ActionOnFailure]) – The action to take when the cluster step fails. Default: ActionOnFailure.CONTINUE

  • args (Optional[Sequence[str]]) – A list of command line arguments passed to the JAR file’s main function when executed. Default: - No args

  • main_class (Optional[str]) – 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

  • properties (Optional[Mapping[str, str]]) – 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

ExampleMetadata:

infused

Example:

tasks.EmrAddStep(self, "Task",
    cluster_id="ClusterId",
    name="StepName",
    jar="Jar",
    action_on_failure=tasks.ActionOnFailure.CONTINUE
)

Attributes

action_on_failure

The action to take when the cluster step fails.

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.

Default:

  • No args

See:

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

cluster_id

The ClusterId to add the Step to.

comment

An optional description for this state.

Default:

  • No comment

heartbeat

Timeout for the heartbeat.

Default:

  • None

input_path

JSONPath expression to select part of the state to be the input to this state.

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 ‘$’)

integration_pattern

AWS Step Functions integrates with services directly in the Amazon States Language.

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.

See:

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

main_class

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:

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

name

The name of the Step.

See:

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

output_path

JSONPath expression to select select a portion of the state output to pass to the next state.

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.

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

result_path

JSONPath expression to indicate where to inject the state’s output.

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 ‘$’)

result_selector

The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.

Default:

  • None

See:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

timeout

Timeout for the state machine.

Default:

  • None