Package software.amazon.awscdk.services.stepfunctions.tasks

Class EmrAddStep.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.EmrAddStep.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<EmrAddStep>
Enclosing class:
EmrAddStep
@Stability(Stable) public static final class EmrAddStep.Builder extends Object implements software.amazon.jsii.Builder<EmrAddStep>
A fluent builder for EmrAddStep.

  • Method Details

    • create

      @Stability(Stable) public static EmrAddStep.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of EmrAddStep.Builder.

    • comment

      @Stability(Stable) public EmrAddStep.Builder comment(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

    • credentials

      @Stability(Stable) public EmrAddStep.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public EmrAddStep.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public EmrAddStep.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(Stable) public EmrAddStep.Builder inputPath(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

      @Stability(Stable) 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.

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      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:

    • outputPath

      @Stability(Stable) public EmrAddStep.Builder outputPath(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

      @Stability(Stable) public EmrAddStep.Builder resultPath(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

      @Stability(Stable) public EmrAddStep.Builder resultSelector(Map<String,? extends 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:

    • stateName

      @Stability(Stable) public EmrAddStep.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public EmrAddStep.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public EmrAddStep.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • clusterId

      @Stability(Stable) public EmrAddStep.Builder clusterId(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

      @Stability(Stable) public EmrAddStep.Builder jar(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:

    • name

      @Stability(Stable) public EmrAddStep.Builder name(String name)
      The name of the Step.

      Parameters:
      name - The name of the Step. This parameter is required.
      Returns:
      this
      See Also:

    • actionOnFailure

      @Stability(Stable) 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:

    • args

      @Stability(Stable) public EmrAddStep.Builder args(List<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:

    • executionRoleArn

      @Stability(Stable) public EmrAddStep.Builder executionRoleArn(String executionRoleArn)
      The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

      Default: - Uses EC2 instance profile role

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. This parameter is required.
      Returns:
      this
      See Also:

    • mainClass

      @Stability(Stable) public EmrAddStep.Builder mainClass(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:

    • properties

      @Stability(Stable) public EmrAddStep.Builder properties(Map<String,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:

    • build

      @Stability(Stable) public EmrAddStep build()
      Specified by:
      build in interface software.amazon.jsii.Builder<EmrAddStep>
      Returns:
      a newly built instance of EmrAddStep.