@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:50.150Z") public interface BatchSubmitJobProps extends TaskStateBaseProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
BatchSubmitJobProps.Builder
A builder for
BatchSubmitJobProps |
static class |
BatchSubmitJobProps.Jsii$Proxy
An implementation for
BatchSubmitJobProps |
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.
|
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout
java.lang.String getJobDefinitionArn()
java.lang.String getJobName()
The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
java.lang.String getJobQueueArn()
default java.lang.Number getArraySize()
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
default java.lang.Number getAttempts()
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
default BatchContainerOverrides getContainerOverrides()
Default: - No container overrides
default java.util.List<BatchJobDependency> getDependsOn()
A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
default TaskInput getPayload()
Default: - No parameters are passed
static BatchSubmitJobProps.Builder builder()
builder
in interface TaskStateBaseProps
BatchSubmitJobProps.Builder
of BatchSubmitJobProps