GlueStartJobRunJsonPathProps Struct

Properties for starting an AWS Glue job as a task.

Source: aws-stepfunctions-tasks/lib/glue/start-job-run.ts
Type last changed: v2.178.0 · 6 Feb 2025

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

argumentsoptionalTaskInputargumentsoptionalTaskInputargumentsoptionalTaskInputArgumentsoptionalTaskInputArgumentsoptionalTaskInput#

The job arguments specifically for this run.

Default: Default arguments set in the job definition

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

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

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

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

A comment describing this state.

Default: No comment

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#

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

Default: None (Task is executed using the State Machine's execution role)

This enables cross-account resource invocations.

executionClassoptionalExecutionClassexecution_classoptionalExecutionClassexecutionClassoptionalExecutionClassExecutionClassoptionalExecutionClassExecutionClassoptionalExecutionClass= STANDARD#

The excecution class of the job.

glueJobNamestringglue_job_namestrglueJobNameStringGlueJobNamestringGlueJobName*stringrequired#

Glue job name.

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#

Timeout for the heartbeat.

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#

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

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#

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

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

You can control these AWS services using service integration patterns.

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

notifyDelayAfteroptionalDurationnotify_delay_afteroptionalDurationnotifyDelayAfteroptionalDurationNotifyDelayAfteroptionalDurationNotifyDelayAfteroptionalDuration#

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

Default: Default delay set in the job definition

Must be at least 1 minute.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#

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

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= 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.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#

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.

resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= 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.

securityConfigurationoptionalstringsecurity_configurationoptionalstrsecurityConfigurationoptionalStringSecurityConfigurationoptionalstringSecurityConfigurationoptional*string#

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

Default: Default configuration set in the job definition

This must match the Glue API

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#

Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#

Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#

use `taskTimeout`

workerConfigurationoptionalWorkerConfigurationPropertyworker_configurationoptionalWorkerConfigurationPropertyworkerConfigurationoptionalWorkerConfigurationPropertyWorkerConfigurationoptionalWorkerConfigurationPropertyWorkerConfigurationoptionalWorkerConfigurationProperty#

The worker configuration for this run.

Default: Default worker configuration in the job definition

GlueStartJobRunJsonPathProps Struct ​

Example ​

Properties ​

GlueStartJobRunJsonPathProps Struct

Example

Properties