# BatchSubmitJobJsonPathProps

Properties for BatchSubmitJob using JSONPath.

Extends: BatchSubmitJobJsonPathProps
Extends: TaskStateJsonPathBaseProps

- Source: [`aws-stepfunctions-tasks/lib/batch/submit-job.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/batch/submit-job.ts#L160)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
// 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_ec2 as ec2 } 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 instanceType: ec2.InstanceType;
declare const resultSelector: any;
declare const size: cdk.Size;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const batchSubmitJobJsonPathProps: stepfunctions_tasks.BatchSubmitJobJsonPathProps = {
  jobDefinitionArn: 'jobDefinitionArn',
  jobName: 'jobName',
  jobQueueArn: 'jobQueueArn',

  // the properties below are optional
  arraySize: 123,
  assign: {
    assignKey: assign,
  },
  attempts: 123,
  comment: 'comment',
  containerOverrides: {
    command: ['command'],
    environment: {
      environmentKey: 'environment',
    },
    gpuCount: 123,
    instanceType: instanceType,
    memory: size,
    vcpus: 123,
  },
  credentials: {
    role: taskRole,
  },
  dependsOn: [{
    jobId: 'jobId',
    type: 'type',
  }],
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  payload: taskInput,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  tags: {
    tagsKey: 'tags',
  },
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};
```

## Properties

- `arraySize`: number — The array size can be between 2 and 10,000.

  **Default:** No array size

  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.

- `assign`: { [key: string]: any } — 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.

- `attempts`: number = 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`: string — A comment describing this state.

  **Default:** No comment

- `containerOverrides`: [BatchContainerOverrides](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.BatchContainerOverrides.html) — 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.

  **Default:** No container overrides

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) — 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.

- `dependsOn`: [BatchJobDependency](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.BatchJobDependency.html)[] — A list of dependencies for the job.

  **Default:** No dependencies

  A job can depend upon a maximum of 20 jobs.

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: 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 {}.

- `integrationPattern`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) — 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.

- `jobDefinitionArn`: string (required) — The arn of the job definition used by this job.

- `jobName`: string (required) — 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`: string (required) — The arn of the job queue into which the job is submitted.

- `outputPath`: 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 {}.

- `payload`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) — The payload to be passed as parameters to the batch job.

  **Default:** No parameters are passed

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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`: 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.

- `resultSelector`: { [key: string]: any } = 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.

- `stateName`: string — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `tags`: { [key: string]: string } — The tags applied to the job request.

  **Default:** {} - no tags

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`