Package software.amazon.awscdk.services.batch

Class JobQueue.Builder

java.lang.Object
software.amazon.awscdk.services.batch.JobQueue.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<JobQueue>
Enclosing class:
JobQueue
@Stability(Stable) public static final class JobQueue.Builder extends Object implements software.amazon.jsii.Builder<JobQueue>
A fluent builder for JobQueue.

  • Method Details

    • create

      @Stability(Stable) public static JobQueue.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of JobQueue.Builder.

    • computeEnvironments

      @Stability(Stable) public JobQueue.Builder computeEnvironments(List<? extends OrderedComputeEnvironment> computeEnvironments)
      The set of compute environments mapped to a job queue and their order relative to each other.

      The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      Note: All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

      Default: none

      Parameters:
      computeEnvironments - The set of compute environments mapped to a job queue and their order relative to each other. This parameter is required.
      Returns:
      this

    • enabled

      @Stability(Stable) public JobQueue.Builder enabled(Boolean enabled)
      If the job queue is enabled, it is able to accept jobs.

      Otherwise, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Default: true

      Parameters:
      enabled - If the job queue is enabled, it is able to accept jobs. This parameter is required.
      Returns:
      this

    • jobQueueName

      @Stability(Stable) public JobQueue.Builder jobQueueName(String jobQueueName)
      The name of the job queue.

      It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)

      Default: - no name

      Parameters:
      jobQueueName - The name of the job queue. This parameter is required.
      Returns:
      this

    • jobStateTimeLimitActions

      @Stability(Stable) public JobQueue.Builder jobStateTimeLimitActions(List<? extends JobStateTimeLimitAction> jobStateTimeLimitActions)
      The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.

      Default: - no actions

      Parameters:
      jobStateTimeLimitActions - The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. This parameter is required.
      Returns:
      this

    • priority

      @Stability(Stable) public JobQueue.Builder priority(Number priority)
      The priority of the job queue.

      Job queues with a higher priority are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority of 10 is given scheduling preference over a job queue with a priority of 1.

      Default: 1

      Parameters:
      priority - The priority of the job queue. This parameter is required.
      Returns:
      this

    • schedulingPolicy

      @Stability(Stable) public JobQueue.Builder schedulingPolicy(ISchedulingPolicy schedulingPolicy)
      The SchedulingPolicy for this JobQueue.

      Instructs the Scheduler how to schedule different jobs.

      Default: - no scheduling policy

      Parameters:
      schedulingPolicy - The SchedulingPolicy for this JobQueue. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public JobQueue build()
      Specified by:
      build in interface software.amazon.jsii.Builder<JobQueue>
      Returns:
      a newly built instance of JobQueue.