2.168.0

interface GlueStartJobRunProps

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

Properties for starting an AWS Glue job as a task.

Example

new tasks.GlueStartJobRun(this, 'Task', {
  glueJobName: 'my-glue-job',
  workerConfiguration: {
    workerType: tasks.WorkerType.G_1X, // Worker type
    numberOfWorkers: 2, // Number of Workers
  },
});

Properties

NameTypeDescription
glueJobNamestringGlue job name.
arguments?TaskInputThe job arguments specifically for this run.
comment?stringAn optional description for this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
executionClass?ExecutionClassThe excecution class of the job.
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.
notifyDelayAfter?DurationAfter a job run starts, the number of minutes to wait before sending a job run delay notification.
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.
securityConfiguration?stringThe name of the SecurityConfiguration structure to be used with this job run.
stateName?stringOptional name for this state.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.
workerConfiguration?WorkerConfigurationPropertyThe 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.

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

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: 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.

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

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.

← PreviousNext →