Package software.amazon.awscdk.services.batch

Interface JobQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.668Z")
@Stability(Experimental)
public interface JobQueueProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of a batch job queue.

Example:

 ComputeEnvironment sharedComputeEnvs;
 JobQueue highPrioQueue = JobQueue.Builder.create(this, "JobQueue")
         .computeEnvironments(List.of(JobQueueComputeEnvironment.builder()
                 .computeEnvironment(sharedComputeEnvs)
                 .order(1)
                 .build()))
         .priority(2)
         .build();
 JobQueue lowPrioQueue = JobQueue.Builder.create(this, "JobQueue")
         .computeEnvironments(List.of(JobQueueComputeEnvironment.builder()
                 .computeEnvironment(sharedComputeEnvs)
                 .order(1)
                 .build()))
         .priority(1)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	JobQueueProps.Builder	A builder for JobQueueProps
static final class	JobQueueProps.Jsii$Proxy	An implementation for JobQueueProps

Method Summary

Modifier and Type	Method	Description
static JobQueueProps.Builder	builder()
List<JobQueueComputeEnvironment>	getComputeEnvironments()	(experimental) The set of compute environments mapped to a job queue and their order relative to each other.
default Boolean	getEnabled()	(experimental) The state of the job queue.
default String	getJobQueueName()	(experimental) A name for the job queue.
default Number	getPriority()	(experimental) The priority of the job queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeEnvironments

@Stability(Experimental)
@NotNull
List<JobQueueComputeEnvironment> getComputeEnvironments()

(experimental) 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 should execute a given 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.

getEnabled

@Stability(Experimental)
@Nullable
default Boolean getEnabled()

(experimental) The state of the job queue.

If set to true, it is able to accept jobs.

Default: true

getJobQueueName

@Stability(Experimental)
@Nullable
default String getJobQueueName()

(experimental) A name for the job queue.

Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Default: - Cloudformation-generated name

getPriority

@Stability(Experimental)
@Nullable
default Number getPriority()

(experimental) The priority of the job queue.

Job queues with a higher priority (or a higher integer value for the priority parameter) 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.

Default: 1

builder

@Stability(Experimental)
static JobQueueProps.Builder builder()

Returns:

a JobQueueProps.Builder of JobQueueProps