EmrAddStep.Builder

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.EmrAddStep.Builder

Enclosing class:: EmrAddStep

public static final class EmrAddStep.Builder
extends java.lang.Object

A fluent builder for EmrAddStep.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EmrAddStep.Builder`	`actionOnFailure(ActionOnFailure actionOnFailure)` The action to take when the cluster step fails.
`EmrAddStep.Builder`	`args(java.util.List<java.lang.String> args)` A list of command line arguments passed to the JAR file's main function when executed.
`EmrAddStep`	`build()`
`EmrAddStep.Builder`	`clusterId(java.lang.String clusterId)` The ClusterId to add the Step to.
`EmrAddStep.Builder`	`comment(java.lang.String comment)` An optional description for this state.
`static EmrAddStep.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`EmrAddStep.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`EmrAddStep.Builder`	`inputPath(java.lang.String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`EmrAddStep.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`EmrAddStep.Builder`	`jar(java.lang.String jar)` A path to a JAR file run during the step.
`EmrAddStep.Builder`	`mainClass(java.lang.String mainClass)` The name of the main class in the specified Java file.
`EmrAddStep.Builder`	`name(java.lang.String name)` The name of the Step.
`EmrAddStep.Builder`	`outputPath(java.lang.String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`EmrAddStep.Builder`	`properties(java.util.Map<java.lang.String,java.lang.String> properties)` A list of Java properties that are set when the step runs.
`EmrAddStep.Builder`	`resultPath(java.lang.String resultPath)` JSONPath expression to indicate where to inject the state's output.
`EmrAddStep.Builder`	`resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`EmrAddStep.Builder`	`timeout(Duration timeout)` Timeout for the state machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static EmrAddStep.Builder create(software.constructs.Construct scope,
                                        java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of EmrAddStep.Builder.
  - comment
```
public EmrAddStep.Builder comment(java.lang.String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
public EmrAddStep.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
public EmrAddStep.Builder inputPath(java.lang.String inputPath)
```
    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 '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
public EmrAddStep.Builder integrationPattern(IntegrationPattern 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`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
public EmrAddStep.Builder outputPath(java.lang.String outputPath)
```
    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 '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
public EmrAddStep.Builder resultPath(java.lang.String resultPath)
```
    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 '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
public EmrAddStep.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
```
    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
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
public EmrAddStep.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - clusterId
```
public EmrAddStep.Builder clusterId(java.lang.String clusterId)
```
    The ClusterId to add the Step to.
    
    Parameters:
    
    clusterId - The ClusterId to add the Step to. This parameter is required.
    
    Returns:
    
    this
  - jar
```
public EmrAddStep.Builder jar(java.lang.String jar)
```
    A path to a JAR file run during the step.
    
    Parameters:
    
    jar - A path to a JAR file run during the step. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
  - name
```
public EmrAddStep.Builder name(java.lang.String name)
```
    The name of the Step.
    
    Parameters:
    
    name - The name of the Step. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html
  - actionOnFailure
```
public EmrAddStep.Builder actionOnFailure(ActionOnFailure actionOnFailure)
```
    The action to take when the cluster step fails.
    Default: ActionOnFailure.CONTINUE
    
    Parameters:
    
    actionOnFailure - The action to take when the cluster step fails. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html
  - args
```
public EmrAddStep.Builder args(java.util.List<java.lang.String> args)
```
    A list of command line arguments passed to the JAR file's main function when executed.
    Default: - No args
    
    Parameters:
    
    args - A list of command line arguments passed to the JAR file's main function when executed. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
  - mainClass
```
public EmrAddStep.Builder mainClass(java.lang.String mainClass)
```
    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
    
    Parameters:
    
    mainClass - The name of the main class in the specified Java file. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
  - properties
```
public EmrAddStep.Builder properties(java.util.Map<java.lang.String,java.lang.String> 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
    
    Parameters:
    
    properties - A list of Java properties that are set when the step runs. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html
  - build
```
public EmrAddStep build()
```

Class EmrAddStep.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

clusterId

jar

name

actionOnFailure

args

mainClass

properties

build