GlueStartJobRunJsonPathProps Struct
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
argumentsTaskInputargumentsTaskInputargumentsTaskInputArgumentsTaskInputArgumentsTaskInput= Default arguments set in the job…#For this job run, they replace the default arguments set in the job definition itself.
default
Default: Default arguments set in the job definition
assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= Not assign variables#Using workflow variables, you can store data in a step and retrieve that data in future steps.
credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#This enables cross-account resource invocations.
default
Default: None (Task is executed using the State Machine's execution role)
executionClassExecutionClassexecution_classExecutionClassexecutionClassExecutionClassExecutionClassExecutionClassExecutionClassExecutionClass= STANDARD#heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
default
Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
notifyDelayAfterDurationnotify_delay_afterDurationnotifyDelayAfterDurationNotifyDelayAfterDurationNotifyDelayAfterDuration= Default delay set in the job def…#Must be at least 1 minute.
default
Default: Default delay set in the job definition
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= None#You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
securityConfigurationstringsecurity_configurationstrsecurityConfigurationStringSecurityConfigurationstringSecurityConfiguration*string= Default configuration set in the…#This must match the Glue API
default
Default: Default configuration set in the job definition
stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#default
Default: The construct ID will be used as state name
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
workerConfigurationWorkerConfigurationPropertyworker_configurationWorkerConfigurationPropertyworkerConfigurationWorkerConfigurationPropertyWorkerConfigurationWorkerConfigurationPropertyWorkerConfigurationWorkerConfigurationProperty= Default worker configuration in …#default
Default: Default worker configuration in the job definition