Interface BatchSubmitJobProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,TaskStateBaseProps
- All Known Implementing Classes:
BatchSubmitJobProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:24.421Z")
@Stability(Stable)
public interface BatchSubmitJobProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
Properties for RunBatchJob.
Example:
import software.amazon.awscdk.services.batch.*; EcsJobDefinition batchJobDefinition; JobQueue batchQueue; BatchSubmitJob task = BatchSubmitJob.Builder.create(this, "Submit Job") .jobDefinitionArn(batchJobDefinition.getJobDefinitionArn()) .jobName("MyJob") .jobQueueArn(batchQueue.getJobQueueArn()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forBatchSubmitJobProps
static final class
An implementation forBatchSubmitJobProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic BatchSubmitJobProps.Builder
builder()
default Number
The array size can be between 2 and 10,000.default Number
The number of times to move a job to the RUNNABLE status.default 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.default List<BatchJobDependency>
A list of dependencies for the job.The arn of the job definition used by this job.The name of the job.The arn of the job queue into which the job is submitted.default TaskInput
The payload to be passed as parameters to the batch job.getTags()
The tags applied to the job request.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout
-
Method Details
-
getJobDefinitionArn
The arn of the job definition used by this job. -
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
The arn of the job queue into which the job is submitted. -
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
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
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:
-
getDependsOn
A list of dependencies for the job.A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
- See Also:
-
getPayload
The payload to be passed as parameters to the batch job.Default: - No parameters are passed
-
getTags
The tags applied to the job request.Default: {} - no tags
-
builder
- Returns:
- a
BatchSubmitJobProps.Builder
ofBatchSubmitJobProps
-