aws-cdk-lib.aws_stepfunctions_tasks.EmrContainersStartJobRunProps

interface EmrContainersStartJobRunProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.EmrContainersStartJobRunProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EmrContainersStartJobRunProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.EmrContainersStartJobRunProps
Pythonaws_cdk.aws_stepfunctions_tasks.EmrContainersStartJobRunProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » EmrContainersStartJobRunProps

The props for a EMR Containers StartJobRun Task.

Example

new tasks.EmrContainersStartJobRun(this, 'EMR Containers Start Job Run', {
  virtualCluster: tasks.VirtualClusterInput.fromVirtualClusterId('de92jdei2910fwedz'),
  releaseLabel: tasks.ReleaseLabel.EMR_6_2_0,
  jobName: 'EMR-Containers-Job',
  jobDriver: {
    sparkSubmitJobDriver: {
      entryPoint: sfn.TaskInput.fromText('local:///usr/lib/spark/examples/src/main/python/pi.py'),
    },
  },
  applicationConfig: [{
    classification: tasks.Classification.SPARK_DEFAULTS,
    properties: {
      'spark.executor.instances': '1',
      'spark.executor.memory': '512M',
    },
  }],
});

Properties

NameTypeDescription
jobDriverJobDriverThe job driver for the job run.
releaseLabelReleaseLabelThe Amazon EMR release version to use for the job run.
virtualClusterVirtualClusterInputThe ID of the virtual cluster where the job will be run.
applicationConfig?ApplicationConfiguration[]The configurations for the application running in the job run.
comment?stringAn optional description for this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
executionRole?IRoleThe execution role for the job run.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
jobName?stringThe name of the job run.
monitoring?MonitoringConfiguration for monitoring the job run.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
tags?{ [string]: string }The tags assigned to job runs.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.

jobDriver

Type: JobDriver

The job driver for the job run.

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


releaseLabel

Type: ReleaseLabel

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


virtualCluster

Type: VirtualClusterInput

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


applicationConfig?

Type: ApplicationConfiguration[] (optional, default: No application config)

The configurations for the application running in the job run.

Maximum of 100 items

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


comment?

Type: string (optional, default: No comment)

An optional description for this state.


credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html


executionRole?

Type: IRole (optional, default: Automatically generated only when the provided virtualClusterId is not an encoded JSON path)

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.

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


heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.


heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

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


inputPath?

Type: string (optional, default: The entire task input (JSON 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 {}.


integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

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

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token


jobName?

Type: string (optional, default: No job run name)

The name of the job run.


monitoring?

Type: Monitoring (optional, default: logging enabled and resources automatically generated if monitoring.logging is set to true)

Configuration for monitoring the job run.

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


outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON 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 {}.


resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON 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.


resultSelector?

Type: { [string]: any } (optional, default: None)

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.

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


tags?

Type: { [string]: string } (optional, default: None)

The tags assigned to job runs.


taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

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


timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.