interface GlueStartJobRunJsonPathProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.GlueStartJobRunJsonPathProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#GlueStartJobRunJsonPathProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.GlueStartJobRunJsonPathProps
Python	aws_cdk.aws_stepfunctions_tasks.GlueStartJobRunJsonPathProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » GlueStartJobRunJsonPathProps

Properties for starting an AWS Glue job as a task.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const resultSelector: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
declare const workerTypeV2: stepfunctions_tasks.WorkerTypeV2;
const glueStartJobRunJsonPathProps: stepfunctions_tasks.GlueStartJobRunJsonPathProps = {
  glueJobName: 'glueJobName',

  // the properties below are optional
  arguments: taskInput,
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  executionClass: stepfunctions_tasks.ExecutionClass.FLEX,
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  notifyDelayAfter: cdk.Duration.minutes(30),
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  securityConfiguration: 'securityConfiguration',
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  workerConfiguration: {
    numberOfWorkers: 123,

    // the properties below are optional
    workerType: stepfunctions_tasks.WorkerType.STANDARD,
    workerTypeV2: workerTypeV2,
  },
};

Properties

Name	Type	Description
glueJobName	string	Glue job name.
arguments?	TaskInput	The job arguments specifically for this run.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
executionClass?	ExecutionClass	The excecution class of the job.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	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 part of the state to be the output to this state.
queryLanguage?	QueryLanguage	The name of the query language used by the 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.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.
workerConfiguration?	WorkerConfigurationProperty	The worker configuration for this run.

---

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.

---

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

comment?

Type: string (optional, default: No comment)

A comment describing 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

---

executionClass?

Type: ExecutionClass (optional, default: STANDARD)

The excecution class of the job.

---

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: $)

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.

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

---

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: $)

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

---

queryLanguage?

Type: QueryLanguage (optional, default: JSONPath)

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.

---

resultPath?

Type: string (optional, default: $)

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

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

---

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.

---

workerConfiguration?

Type: WorkerConfigurationProperty (optional, default: Default worker configuration in the job definition)

The worker configuration for this run.