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

Class EmrContainersStartJobRun.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.EmrContainersStartJobRun.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmrContainersStartJobRun>

Enclosing class:

EmrContainersStartJobRun

@Stability(Stable)
public static final class EmrContainersStartJobRun.Builder
extends Object
implements software.amazon.jsii.Builder<EmrContainersStartJobRun>

A fluent builder for EmrContainersStartJobRun.

Method Summary

Modifier and Type	Method	Description
EmrContainersStartJobRun.Builder	applicationConfig(List<? extends ApplicationConfiguration> applicationConfig)	The configurations for the application running in the job run.
EmrContainersStartJobRun	build()
EmrContainersStartJobRun.Builder	comment(String comment)	An optional description for this state.
static EmrContainersStartJobRun.Builder	create(software.constructs.Construct scope, String id)
EmrContainersStartJobRun.Builder	executionRole(IRole executionRole)	The execution role for the job run.
EmrContainersStartJobRun.Builder	heartbeat(Duration heartbeat)	Timeout for the heartbeat.
EmrContainersStartJobRun.Builder	inputPath(String inputPath)	JSONPath expression to select part of the state to be the input to this state.
EmrContainersStartJobRun.Builder	integrationPattern(IntegrationPattern integrationPattern)	AWS Step Functions integrates with services directly in the Amazon States Language.
EmrContainersStartJobRun.Builder	jobDriver(JobDriver jobDriver)	The job driver for the job run.
EmrContainersStartJobRun.Builder	jobName(String jobName)	The name of the job run.
EmrContainersStartJobRun.Builder	monitoring(Monitoring monitoring)	Configuration for monitoring the job run.
EmrContainersStartJobRun.Builder	outputPath(String outputPath)	JSONPath expression to select select a portion of the state output to pass to the next state.
EmrContainersStartJobRun.Builder	releaseLabel(ReleaseLabel releaseLabel)	The Amazon EMR release version to use for the job run.
EmrContainersStartJobRun.Builder	resultPath(String resultPath)	JSONPath expression to indicate where to inject the state's output.
EmrContainersStartJobRun.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.
EmrContainersStartJobRun.Builder	tags(Map<String,String> tags)	The tags assigned to job runs.
EmrContainersStartJobRun.Builder	timeout(Duration timeout)	Timeout for the state machine.
EmrContainersStartJobRun.Builder	virtualCluster(VirtualClusterInput virtualCluster)	The ID of the virtual cluster where the job will be run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static EmrContainersStartJobRun.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of EmrContainersStartJobRun.Builder.

comment

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

heartbeat

@Stability(Stable)
public EmrContainersStartJobRun.Builder heartbeat(Duration heartbeat)

Timeout for the heartbeat.

Default: - None

Parameters:

heartbeat - Timeout for the heartbeat. This parameter is required.

Returns:

this

inputPath

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

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

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

timeout

@Stability(Stable)
public EmrContainersStartJobRun.Builder timeout(Duration timeout)

Timeout for the state machine.

Default: - None

Parameters:

timeout - Timeout for the state machine. This parameter is required.

Returns:

this

jobDriver

@Stability(Stable)
public EmrContainersStartJobRun.Builder jobDriver(JobDriver jobDriver)

The job driver for the job run.

Parameters:

jobDriver - The job driver for the job run. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_JobDriver.html

releaseLabel

@Stability(Stable)
public EmrContainersStartJobRun.Builder releaseLabel(ReleaseLabel releaseLabel)

The Amazon EMR release version to use for the job run.

Parameters:

releaseLabel - The Amazon EMR release version to use for the job run. This parameter is required.

Returns:

this

virtualCluster

@Stability(Stable)
public EmrContainersStartJobRun.Builder virtualCluster(VirtualClusterInput virtualCluster)

The ID of the virtual cluster where the job will be run.

Parameters:

virtualCluster - The ID of the virtual cluster where the job will be run. This parameter is required.

Returns:

this

applicationConfig

@Stability(Stable)
public EmrContainersStartJobRun.Builder applicationConfig(List<? extends ApplicationConfiguration> applicationConfig)

The configurations for the application running in the job run.

Maximum of 100 items

Default: - No application config

Parameters:

applicationConfig - The configurations for the application running in the job run. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_Configuration.html

executionRole

@Stability(Stable)
public EmrContainersStartJobRun.Builder executionRole(IRole executionRole)

The execution role for the job run.

If virtualClusterId is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy.

Default: - Automatically generated only when the provided `virtualClusterId` is not an encoded JSON path

Parameters:

executionRole - The execution role for the job run. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-trust-policy.html

jobName

@Stability(Stable)
public EmrContainersStartJobRun.Builder jobName(String jobName)

The name of the job run.

Default: - No job run name

Parameters:

jobName - The name of the job run. This parameter is required.

Returns:

this

monitoring

@Stability(Stable)
public EmrContainersStartJobRun.Builder monitoring(Monitoring monitoring)

Configuration for monitoring the job run.

Default: - logging enabled and resources automatically generated if `monitoring.logging` is set to `true`

Parameters:

monitoring - Configuration for monitoring the job run. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_MonitoringConfiguration.html

tags

@Stability(Stable)
public EmrContainersStartJobRun.Builder tags(Map<String,String> tags)

The tags assigned to job runs.

Default: - None

Parameters:

tags - The tags assigned to job runs. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EmrContainersStartJobRun build()

Specified by:

build in interface software.amazon.jsii.Builder<EmrContainersStartJobRun>

Returns:

a newly built instance of EmrContainersStartJobRun.