class JobQueue (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.JobQueue |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#JobQueue |
![]() | software.amazon.awscdk.services.batch.JobQueue |
![]() | aws_cdk.aws_batch.JobQueue |
![]() | aws-cdk-lib » aws_batch » JobQueue |
Implements
IConstruct
, IDependable
, IResource
, IJob
JobQueues can receive Jobs, which are removed from the queue when sent to the linked ComputeEnvironment(s) to be executed.
Jobs exit the queue in FIFO order unless a SchedulingPolicy
is linked.
Example
declare const vpc: ec2.IVpc;
const ecsJob = new batch.EcsJobDefinition(this, 'JobDefn', {
container: new batch.EcsEc2ContainerDefinition(this, 'containerDefn', {
image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
memory: cdk.Size.mebibytes(2048),
cpu: 256,
}),
});
const queue = new batch.JobQueue(this, 'JobQueue', {
computeEnvironments: [{
computeEnvironment: new batch.ManagedEc2EcsComputeEnvironment(this, 'managedEc2CE', {
vpc,
}),
order: 1,
}],
priority: 10,
});
const user = new iam.User(this, 'MyUser');
ecsJob.grantSubmitJob(user, queue);
Initializer
new JobQueue(scope: Construct, id: string, props?: JobQueueProps)
Parameters
- scope
Construct
- id
string
- props
Job
Queue Props
Construct Props
Name | Type | Description |
---|---|---|
compute | Ordered [] | The set of compute environments mapped to a job queue and their order relative to each other. |
enabled? | boolean | If the job queue is enabled, it is able to accept jobs. |
job | string | The name of the job queue. |
job | Job [] | The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. |
priority? | number | The priority of the job queue. |
scheduling | IScheduling | The SchedulingPolicy for this JobQueue. |
computeEnvironments?
Type:
Ordered
[]
(optional, default: none)
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.
enabled?
Type:
boolean
(optional, default: true)
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.
jobQueueName?
Type:
string
(optional, default: no name)
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 (_)
jobStateTimeLimitActions?
Type:
Job
[]
(optional, default: no actions)
The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
priority?
Type:
number
(optional, default: 1)
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 of 10 is given scheduling preference over a job queue with a priority of 1.
schedulingPolicy?
Type:
IScheduling
(optional, default: no scheduling policy)
The SchedulingPolicy for this JobQueue.
Instructs the Scheduler how to schedule different jobs.
Properties
Name | Type | Description |
---|---|---|
compute | Ordered [] | The set of compute environments mapped to a job queue and their order relative to each other. |
env | Resource | The environment this resource belongs to. |
job | string | The ARN of this job queue. |
job | string | The name of the job queue. |
node | Node | The tree node. |
priority | number | The priority of the job queue. |
stack | Stack | The stack in which this resource is defined. |
enabled? | boolean | If the job queue is enabled, it is able to accept jobs. |
scheduling | IScheduling | The SchedulingPolicy for this JobQueue. |
computeEnvironments
Type:
Ordered
[]
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.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
jobQueueArn
Type:
string
The ARN of this job queue.
jobQueueName
Type:
string
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 (_)
node
Type:
Node
The tree node.
priority
Type:
number
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.
stack
Type:
Stack
The stack in which this resource is defined.
enabled?
Type:
boolean
(optional)
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.
schedulingPolicy?
Type:
IScheduling
(optional)
The SchedulingPolicy for this JobQueue.
Instructs the Scheduler how to schedule different jobs.
Methods
Name | Description |
---|---|
add | Add a ComputeEnvironment to this Queue. |
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | refer to an existing JobQueue by its arn. |
addComputeEnvironment(computeEnvironment, order)
public addComputeEnvironment(computeEnvironment: IComputeEnvironment, order: number): void
Parameters
- computeEnvironment
ICompute
Environment - order
number
Add a ComputeEnvironment
to this Queue.
The Queue will prefer lower-order ComputeEnvironment
s.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromJobQueueArn(scope, id, jobQueueArn)
public static fromJobQueueArn(scope: Construct, id: string, jobQueueArn: string): IJobQueue
Parameters
- scope
Construct
- id
string
- jobQueueArn
string
Returns
refer to an existing JobQueue by its arn.