Package software.amazon.awscdk.services.batch

Class JobQueue

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.batch.JobQueue

All Implemented Interfaces:

IConstruct, IDependable, IResource, IJobQueue, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.665Z")
@Stability(Experimental)
public class JobQueue
extends Resource
implements IJobQueue

(experimental) Batch Job Queue.

Defines a batch job queue to define how submitted batch jobs should be ran based on specified batch compute environments.

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	Class	Description
static final class	JobQueue.Builder	(experimental) A fluent builder for JobQueue.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IJobQueue

IJobQueue.Jsii$Default, IJobQueue.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JobQueue(software.amazon.jsii.JsiiObjectRef objRef)
	JobQueue(software.constructs.Construct scope, String id, JobQueueProps props)

Method Summary

Modifier and Type	Method	Description
static IJobQueue	fromJobQueueArn(software.constructs.Construct scope, String id, String jobQueueArn)	(experimental) Fetches an existing batch job queue by its amazon resource name.
String	getJobQueueArn()	(experimental) The ARN of this batch job queue.
String	getJobQueueName()	(experimental) A name for the job queue.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

JobQueue

protected JobQueue(software.amazon.jsii.JsiiObjectRef objRef)

JobQueue

protected JobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

JobQueue

@Stability(Experimental)
public JobQueue(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 JobQueueProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromJobQueueArn

@Stability(Experimental)
@NotNull
public static IJobQueue fromJobQueueArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String jobQueueArn)

(experimental) Fetches an existing batch job queue by its amazon resource name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

jobQueueArn - This parameter is required.

getJobQueueArn

@Stability(Experimental)
@NotNull
public String getJobQueueArn()

(experimental) The ARN of this batch job queue.

Specified by:

getJobQueueArn in interface IJobQueue

getJobQueueName

@Stability(Experimental)
@NotNull
public String getJobQueueName()

(experimental) A name for the job queue.

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

Specified by:

getJobQueueName in interface IJobQueue