IJobQueue Interface
Represents a JobQueue.
Properties
computeEnvironmentsOrderedComputeEnvironment[]compute_environmentstyping.List[OrderedComputeEnvironment]computeEnvironmentsList<OrderedComputeEnvironment>ComputeEnvironmentsOrderedComputeEnvironment[]ComputeEnvironments*[]OrderedComputeEnvironment#notes
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.
enabledmay be undefinedbooleanenabledmay be undefinedboolenabledmay be undefinedBooleanEnabledmay be undefinedboolEnabledmay be undefined*bool= true#Otherwise, new jobs can't be added to the queue, but jobs already in the queue can finish.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)
jobQueueRefJobQueueReferencejob_queue_refJobQueueReferencejobQueueRefJobQueueReferenceJobQueueRefJobQueueReferenceJobQueueRefJobQueueReference#notes
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.
schedulingPolicymay be undefinedISchedulingPolicyscheduling_policymay be undefinedISchedulingPolicyschedulingPolicymay be undefinedISchedulingPolicySchedulingPolicymay be undefinedISchedulingPolicySchedulingPolicymay be undefinedISchedulingPolicy#Default: no scheduling policy
Instructs the Scheduler how to schedule different jobs.
Methods
addComputeEnvironment(computeEnvironment: IComputeEnvironmentRef, order: number): voiddef add_compute_environment(self, compute_environment: IComputeEnvironmentRef, order: int | float) -> Nonepublic void addComputeEnvironment(IComputeEnvironmentRef computeEnvironment, Number order)public void AddComputeEnvironment(IComputeEnvironmentRef computeEnvironment, double order)func AddComputeEnvironment(ComputeEnvironment IComputeEnvironmentRef, Order *float64)#The Queue will prefer lower-order ComputeEnvironments.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining