CfnJobQueueProps Struct
Properties for defining a CfnJobQueue.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const cfnJobQueueProps: batch.CfnJobQueueProps = {
priority: 123,
// the properties below are optional
computeEnvironmentOrder: [{
computeEnvironment: 'computeEnvironment',
order: 123,
}],
jobQueueName: 'jobQueueName',
jobQueueType: 'jobQueueType',
jobStateTimeLimitActions: [{
action: 'action',
maxTimeSeconds: 123,
reason: 'reason',
state: 'state',
}],
schedulingPolicyArn: 'schedulingPolicyArn',
serviceEnvironmentOrder: [{
order: 123,
serviceEnvironment: 'serviceEnvironment',
}],
state: 'state',
tags: {
tagsKey: 'tags',
},
};
Properties
computeEnvironmentOrderIResolvable | IResolvable | CfnJobQueue.ComputeEnvironmentOrderProperty[]compute_environment_ordertyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ComputeEnvironmentOrderProperty]]]computeEnvironmentOrderIResolvableComputeEnvironmentOrderIResolvableComputeEnvironmentOrderinterface{}#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.
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.
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
For service jobs that run on SageMaker AI , this value is SAGEMAKER_TRAINING . For regular container jobs, this value is EKS , ECS , or ECS_FARGATE depending on the compute environment.
jobStateTimeLimitActionsIResolvable | IResolvable | CfnJobQueue.JobStateTimeLimitActionProperty[]job_state_time_limit_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, JobStateTimeLimitActionProperty]]]jobStateTimeLimitActionsIResolvableJobStateTimeLimitActionsIResolvableJobStateTimeLimitActionsinterface{}#AWS Batch will perform each action after maxTimeSeconds has passed.
notes
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 . 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.
schedulingPolicyArnstring | ISchedulingPolicyRefscheduling_policy_arntyping.Union[str, ISchedulingPolicyRef]schedulingPolicyArnStringSchedulingPolicyArnstringSchedulingPolicyArninterface{}#The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
serviceEnvironmentOrderIResolvable | IResolvable | CfnJobQueue.ServiceEnvironmentOrderProperty[]service_environment_ordertyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceEnvironmentOrderProperty]]]serviceEnvironmentOrderIResolvableServiceEnvironmentOrderIResolvableServiceEnvironmentOrderinterface{}#Job queues with a higher priority are evaluated first when associated with the same service environment.
If the job queue state is ENABLED , it is able to accept jobs. If the job queue state is DISABLED , new jobs can't be added to the queue, but jobs already in the queue can finish.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .