Package software.amazon.awscdk.services.stepfunctions.tasks

Interface BatchSubmitJobProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
All Known Implementing Classes:
BatchSubmitJobProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:38.018Z") @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();

  • Method Details

    • getJobDefinitionArn

      @Stability(Stable) @NotNull String getJobDefinitionArn()
      The arn of the job definition used by this job.

    • getJobName

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull String getJobQueueArn()
      The arn of the job queue into which the job is submitted.

    • getArraySize

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable 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:

    • getDependsOn

      @Stability(Stable) @Nullable default 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:

    • getPayload

      @Stability(Stable) @Nullable default TaskInput getPayload()
      The payload to be passed as parameters to the batch job.

      Default: - No parameters are passed

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      The tags applied to the job request.

      Default: {} - no tags

    • builder

      @Stability(Stable) static BatchSubmitJobProps.Builder builder()
      Returns:
      a BatchSubmitJobProps.Builder of BatchSubmitJobProps