interface GlueStartJobRunProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.GlueStartJobRunProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#GlueStartJobRunProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.GlueStartJobRunProps |
![]() | aws_cdk.aws_stepfunctions_tasks.GlueStartJobRunProps |
![]() | 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: {
workerTypeV2: tasks.WorkerTypeV2.G_1X, // Worker type
numberOfWorkers: 2, // Number of Workers
},
});
Properties
Name | Type | Description |
---|---|---|
glue | string | Glue job name. |
arguments? | Task | 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. |
execution | Execution | The excecution class of the job. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
notify | Duration | After a job run starts, the number of minutes to wait before sending a job run delay notification. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
query | Query | The name of the query language used by the state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
security | string | The name of the SecurityConfiguration structure to be used with this job run. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
worker | Worker | The worker configuration for this run. |
glueJobName
Type:
string
Glue job name.
arguments?
Type:
Task
(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:
Execution
(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:
Integration
(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 {}.
outputs?
Type:
any
(optional, default: $states.result or $states.errorOutput)
Used to specify and transform output from the state.
When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html
queryLanguage?
Type:
Query
(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.
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:
Worker
(optional, default: Default worker configuration in the job definition)
The worker configuration for this run.