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

Class EmrContainersStartJobRunProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EmrContainersStartJobRunProps>

Enclosing interface:

EmrContainersStartJobRunProps

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

A builder for EmrContainersStartJobRunProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmrContainersStartJobRunProps.Builder	applicationConfig(List<? extends ApplicationConfiguration> applicationConfig)	Sets the value of EmrContainersStartJobRunProps.getApplicationConfig()
EmrContainersStartJobRunProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
EmrContainersStartJobRunProps	build()	Builds the configured instance.
EmrContainersStartJobRunProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
EmrContainersStartJobRunProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
EmrContainersStartJobRunProps.Builder	executionRole(IRole executionRole)	Sets the value of EmrContainersStartJobRunProps.getExecutionRole()
EmrContainersStartJobRunProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
EmrContainersStartJobRunProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
EmrContainersStartJobRunProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
EmrContainersStartJobRunProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
EmrContainersStartJobRunProps.Builder	jobDriver(JobDriver jobDriver)	Sets the value of EmrContainersStartJobRunProps.getJobDriver()
EmrContainersStartJobRunProps.Builder	jobName(String jobName)	Sets the value of EmrContainersStartJobRunProps.getJobName()
EmrContainersStartJobRunProps.Builder	monitoring(Monitoring monitoring)	Sets the value of EmrContainersStartJobRunProps.getMonitoring()
EmrContainersStartJobRunProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
EmrContainersStartJobRunProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
EmrContainersStartJobRunProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
EmrContainersStartJobRunProps.Builder	releaseLabel(ReleaseLabel releaseLabel)	Sets the value of EmrContainersStartJobRunProps.getReleaseLabel()
EmrContainersStartJobRunProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
EmrContainersStartJobRunProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
EmrContainersStartJobRunProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
EmrContainersStartJobRunProps.Builder	tags(Map<String,String> tags)	Sets the value of EmrContainersStartJobRunProps.getTags()
EmrContainersStartJobRunProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
EmrContainersStartJobRunProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
EmrContainersStartJobRunProps.Builder	virtualCluster(VirtualClusterInput virtualCluster)	Sets the value of EmrContainersStartJobRunProps.getVirtualCluster()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobDriver

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

Sets the value of EmrContainersStartJobRunProps.getJobDriver()

Parameters:

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

Returns:

this

releaseLabel

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

Sets the value of EmrContainersStartJobRunProps.getReleaseLabel()

Parameters:

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

Returns:

this

virtualCluster

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

Sets the value of EmrContainersStartJobRunProps.getVirtualCluster()

Parameters:

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

Returns:

this

applicationConfig

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

Sets the value of EmrContainersStartJobRunProps.getApplicationConfig()

Parameters:

applicationConfig - The configurations for the application running in the job run. Maximum of 100 items

Returns:

this

executionRole

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

Sets the value of EmrContainersStartJobRunProps.getExecutionRole()

Parameters:

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.

Returns:

this

jobName

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

Sets the value of EmrContainersStartJobRunProps.getJobName()

Parameters:

jobName - The name of the job run.

Returns:

this

monitoring

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

Sets the value of EmrContainersStartJobRunProps.getMonitoring()

Parameters:

monitoring - Configuration for monitoring the job run.

Returns:

this

tags

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

Sets the value of EmrContainersStartJobRunProps.getTags()

Parameters:

tags - The tags assigned to job runs.

Returns:

this

resultPath

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

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.

Returns:

this

resultSelector

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

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.

Returns:

this

comment

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public EmrContainersStartJobRunProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

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.

Returns:

this

taskTimeout

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public EmrContainersStartJobRunProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

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 {}.

Returns:

this

outputPath

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

outputs

@Stability(Stable)
public EmrContainersStartJobRunProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

build

@Stability(Stable)
public EmrContainersStartJobRunProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EmrContainersStartJobRunProps

Throws:

NullPointerException - if any required attribute was not provided