Package software.amazon.awscdk.services.batch

Interface IJobQueue.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IJobQueue, IJobQueueRef, IJobQueueRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IJobQueue.Jsii$Proxy
Enclosing interface:
IJobQueue
@Internal public static interface IJobQueue.Jsii$Default extends IJobQueue, IResource.Jsii$Default, IJobQueueRef.Jsii$Default
Internal default implementation for IJobQueue.

  • Method Details

    • getComputeEnvironments

      @Stability(Stable) @NotNull default List<OrderedComputeEnvironment> getComputeEnvironments()
      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.

      Specified by:
      getComputeEnvironments in interface IJobQueue

    • getJobQueueArn

      @Stability(Stable) @NotNull default String getJobQueueArn()
      The ARN of this job queue.
      Specified by:
      getJobQueueArn in interface IJobQueue

    • getJobQueueName

      @Stability(Stable) @NotNull default String getJobQueueName()
      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 (_)

      Specified by:
      getJobQueueName in interface IJobQueue

    • getPriority

      @Stability(Stable) @NotNull default Number getPriority()
      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 value of 10 is given scheduling preference over a job queue with a priority value of 1.

      Specified by:
      getPriority in interface IJobQueue

    • getEnabled

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

      Specified by:
      getEnabled in interface IJobQueue

    • getSchedulingPolicy

      @Stability(Stable) @Nullable default ISchedulingPolicy getSchedulingPolicy()
      The SchedulingPolicy for this JobQueue.

      Instructs the Scheduler how to schedule different jobs.

      Default: - no scheduling policy

      Specified by:
      getSchedulingPolicy in interface IJobQueue

    • addComputeEnvironment

      @Stability(Stable) default void addComputeEnvironment(@NotNull IComputeEnvironmentRef computeEnvironment, @NotNull Number order)
      Add a ComputeEnvironment to this Queue.

      The Queue will prefer lower-order ComputeEnvironments.

      Specified by:
      addComputeEnvironment in interface IJobQueue
      Parameters:
      computeEnvironment - This parameter is required.
      order - This parameter is required.