BatchSubmitJobProps

All Superinterfaces:: TaskStateBaseProps

All Known Implementing Classes:: BatchSubmitJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.150Z")
public interface BatchSubmitJobProps
extends TaskStateBaseProps

Properties for RunBatchJob.

Example:

 import software.amazon.awscdk.services.batch.*;
 JobDefinition batchJobDefinition;
 JobQueue batchQueue;
 BatchSubmitJob task = BatchSubmitJob.Builder.create(this, "Submit Job")
         .jobDefinitionArn(batchJobDefinition.getJobDefinitionArn())
         .jobName("MyJob")
         .jobQueueArn(batchQueue.getJobQueueArn())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BatchSubmitJobProps.Builder` A builder for `BatchSubmitJobProps`
`static class`	`BatchSubmitJobProps.Jsii$Proxy` An implementation for `BatchSubmitJobProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static BatchSubmitJobProps.Builder`	`builder()`
`default java.lang.Number`	`getArraySize()` The array size can be between 2 and 10,000.
`default java.lang.Number`	`getAttempts()` The number of times to move a job to the RUNNABLE status.
`default BatchContainerOverrides`	`getContainerOverrides()` 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 java.util.List<BatchJobDependency>`	`getDependsOn()` A list of dependencies for the job.
`java.lang.String`	`getJobDefinitionArn()` The arn of the job definition used by this job.
`java.lang.String`	`getJobName()` The name of the job.
`java.lang.String`	`getJobQueueArn()` The arn of the job queue into which the job is submitted.
`default TaskInput`	`getPayload()` The payload to be passed as parameters to the batch job.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

- Method Detail
  - getJobDefinitionArn
```
java.lang.String getJobDefinitionArn()
```
    The arn of the job definition used by this job.
  - getJobName
```
java.lang.String getJobName()
```
    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.
  - getJobQueueArn
```
java.lang.String getJobQueueArn()
```
    The arn of the job queue into which the job is submitted.
  - getArraySize
```
default java.lang.Number getArraySize()
```
    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.
    Default: - No array size
  - getAttempts
```
default java.lang.Number getAttempts()
```
    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.
    Default: 1
  - getContainerOverrides
```
default BatchContainerOverrides getContainerOverrides()
```
    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
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides
  - getDependsOn
```
default java.util.List<BatchJobDependency> getDependsOn()
```
    A list of dependencies for the job.
    A job can depend upon a maximum of 20 jobs.
    Default: - No dependencies
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn
  - getPayload
```
default TaskInput getPayload()
```
    The payload to be passed as parameters to the batch job.
    Default: - No parameters are passed
  - builder
```
static BatchSubmitJobProps.Builder builder()
```
    Specified by:
    
    builder in interface TaskStateBaseProps
    
    Returns:
    
    a BatchSubmitJobProps.Builder of BatchSubmitJobProps

Interface BatchSubmitJobProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

Method Detail

getJobDefinitionArn

getJobName

getJobQueueArn

getArraySize

getAttempts

getContainerOverrides

getDependsOn

getPayload

builder