interface GlueStartJobRunProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.GlueStartJobRunProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.GlueStartJobRunProps
Python	aws_cdk.aws_stepfunctions_tasks.GlueStartJobRunProps
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » GlueStartJobRunProps

Properties for starting an AWS Glue job as a task.

Example

new tasks.GlueStartJobRun(this, 'Task', {
  glueJobName: 'my-glue-job',
  arguments: sfn.TaskInput.fromObject({
    key: 'value',
  }),
  timeout: Duration.minutes(30),
  notifyDelayAfter: Duration.minutes(5),
});

Properties

Name	Type	Description
glueJobName	string	Glue job name.
arguments?	TaskInput	The job arguments specifically for this run.
comment?	string	An optional description for this state.
heartbeat?	Duration	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
notifyDelayAfter?	Duration	After a job run starts, the number of minutes to wait before sending a job run delay notification.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
resultPath?	string	JSONPath 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.
securityConfiguration?	string	The name of the SecurityConfiguration structure to be used with this job run.
timeout?	Duration	Timeout for the state machine.

---

glueJobName

Type: string

Glue job name.

---

arguments?

Type: TaskInput (optional, default: Default arguments set in the job definition)

The job arguments specifically for this run.

For this job run, they replace the default arguments set in the job definition itself.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

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

---

notifyDelayAfter?

Type: Duration (optional, default: Default delay set in the job definition)

After a job run starts, the number of minutes to wait before sending a job run delay notification.

Must be at least 1 minute.

---

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

---

securityConfiguration?

Type: string (optional, default: Default configuration set in the job definition)

The name of the SecurityConfiguration structure to be used with this job run.

This must match the Glue API

See also: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-oneLine

---

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.