interface BatchSubmitJobProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.BatchSubmitJobProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJobProps
Python	aws_cdk.aws_stepfunctions_tasks.BatchSubmitJobProps
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » BatchSubmitJobProps

Properties for RunBatchJob.

Example

import * as batch from '@aws-cdk/aws-batch';
declare const batchJobDefinition: batch.JobDefinition;
declare const batchQueue: batch.JobQueue;

const task = new tasks.BatchSubmitJob(this, 'Submit Job', {
  jobDefinitionArn: batchJobDefinition.jobDefinitionArn,
  jobName: 'MyJob',
  jobQueueArn: batchQueue.jobQueueArn,
});

Properties

Name	Type	Description
jobDefinitionArn	string	The arn of the job definition used by this job.
jobName	string	The name of the job.
jobQueueArn	string	The arn of the job queue into which the job is submitted.
arraySize?	number	The array size can be between 2 and 10,000.
attempts?	number	The number of times to move a job to the RUNNABLE status.
comment?	string	An optional description for this state.
containerOverrides?	BatchContainerOverrides	A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
dependsOn?	BatchJobDependency[]	A list of dependencies for the job.
heartbeat?	Duration	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.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
payload?	TaskInput	The payload to be passed as parameters to the batch job.
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.
timeout?	Duration	Timeout for the state machine.

---

jobDefinitionArn

Type: string

The arn of the job definition used by this job.

---

jobName

Type: string

The name of the job.

The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

---

jobQueueArn

Type: string

The arn of the job queue into which the job is submitted.

---

arraySize?

Type: number (optional, default: No array size)

The array size can be between 2 and 10,000.

If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

---

attempts?

Type: number (optional, default: 1)

The number of times to move a job to the RUNNABLE status.

You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

containerOverrides?

Type: BatchContainerOverrides (optional, default: No container overrides)

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

See also: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides

---

dependsOn?

Type: BatchJobDependency[] (optional, default: No dependencies)

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

See also: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn

---

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

---

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

---

payload?

Type: TaskInput (optional, default: No parameters are passed)

The payload to be passed as parameters to the batch job.

---

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

---

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.