Package software.amazon.awscdk.services.batch

Class JobQueueProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • computeEnvironments

      @Stability(Stable) public JobQueueProps.Builder computeEnvironments(List<? extends OrderedComputeEnvironment> computeEnvironments)
      Sets the value of JobQueueProps.getComputeEnvironments()
      Parameters:
      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.

      Returns:
      this

    • enabled

      @Stability(Stable) public JobQueueProps.Builder enabled(Boolean enabled)
      Sets the value of JobQueueProps.getEnabled()
      Parameters:
      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.
      Returns:
      this

    • jobQueueName

      @Stability(Stable) public JobQueueProps.Builder jobQueueName(String jobQueueName)
      Sets the value of JobQueueProps.getJobQueueName()
      Parameters:
      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 (_)
      Returns:
      this

    • jobStateTimeLimitActions

      @Stability(Stable) public JobQueueProps.Builder jobStateTimeLimitActions(List<? extends JobStateTimeLimitAction> jobStateTimeLimitActions)
      Sets the value of JobQueueProps.getJobStateTimeLimitActions()
      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.
      Returns:
      this

    • priority

      @Stability(Stable) public JobQueueProps.Builder priority(Number priority)
      Sets the value of JobQueueProps.getPriority()
      Parameters:
      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.
      Returns:
      this

    • schedulingPolicy

      @Stability(Stable) public JobQueueProps.Builder schedulingPolicy(ISchedulingPolicy schedulingPolicy)
      Sets the value of JobQueueProps.getSchedulingPolicy()
      Parameters:
      schedulingPolicy - The SchedulingPolicy for this JobQueue. Instructs the Scheduler how to schedule different jobs.
      Returns:
      this

    • build

      @Stability(Stable) public JobQueueProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<JobQueueProps>
      Returns:
      a new instance of JobQueueProps
      Throws:
      NullPointerException - if any required attribute was not provided