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(value=Experimental)
public static final class JobQueue.Builder
extends Object
implements software.amazon.jsii.Builder<JobQueue>

(experimental) A fluent builder for JobQueue.

Method Summary

Modifier and Type	Method and Description
JobQueue	build()
JobQueue.Builder	computeEnvironments(List<? extends JobQueueComputeEnvironment> computeEnvironments) (experimental) The set of compute environments mapped to a job queue and their order relative to each other.
static JobQueue.Builder	create(software.constructs.Construct scope, String id)
JobQueue.Builder	enabled(Boolean enabled) (experimental) The state of the job queue.
JobQueue.Builder	jobQueueName(String jobQueueName) (experimental) A name for the job queue.
JobQueue.Builder	priority(Number priority) (experimental) The priority of the job queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
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(value=Experimental)
public JobQueue.Builder computeEnvironments(List<? extends JobQueueComputeEnvironment> computeEnvironments)

(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.

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(value=Experimental)
public JobQueue.Builder enabled(Boolean enabled)

(experimental) The state of the job queue.

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

Default: true

Parameters:

enabled - The state of the job queue. This parameter is required.

Returns:

this

jobQueueName

@Stability(value=Experimental)
public JobQueue.Builder jobQueueName(String jobQueueName)

(experimental) A name for the job queue.

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

Default: - Cloudformation-generated name

Parameters:

jobQueueName - A name for the job queue. This parameter is required.

Returns:

this

priority

@Stability(value=Experimental)
public JobQueue.Builder priority(Number priority)

(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

Parameters:

priority - The priority of the job queue. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public JobQueue build()

Specified by:

build in interface software.amazon.jsii.Builder<JobQueue>