2.214.0

interface CfnJobQueueProps

LanguageType name
.NETAmazon.CDK.AWS.Batch.CfnJobQueueProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobQueueProps
Javasoftware.amazon.awscdk.services.batch.CfnJobQueueProps
Pythonaws_cdk.aws_batch.CfnJobQueueProps
TypeScript aws-cdk-lib » aws_batch » CfnJobQueueProps

Properties for defining a CfnJobQueue.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html

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

NameTypeDescription
prioritynumberThe priority of the job queue.
computeEnvironmentOrder?IResolvable | IResolvable | ComputeEnvironmentOrderProperty[]The set of compute environments mapped to a job queue and their order relative to each other.
jobQueueName?stringThe name of the job queue.
jobQueueType?stringThe type of job queue.
jobStateTimeLimitActions?IResolvable | IResolvable | JobStateTimeLimitActionProperty[]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.
schedulingPolicyArn?stringThe Amazon Resource Name (ARN) of the scheduling policy.
serviceEnvironmentOrder?IResolvable | IResolvable | ServiceEnvironmentOrderProperty[]The order of the service environment associated with the job queue.
state?stringThe state of the job queue.
tags?{ [string]: string }The tags that are applied to the job queue.

priority

Type: number

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority

computeEnvironmentOrder?

Type: IResolvable | IResolvable | ComputeEnvironmentOrderProperty[] (optional)

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.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder

jobQueueName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename

jobQueueType?

Type: string (optional)

The type of job queue.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuetype

jobStateTimeLimitActions?

Type: IResolvable | IResolvable | JobStateTimeLimitActionProperty[] (optional)

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.

AWS Batch will perform each action after maxTimeSeconds has passed.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions

schedulingPolicyArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the scheduling policy.

The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-schedulingpolicyarn

serviceEnvironmentOrder?

Type: IResolvable | IResolvable | ServiceEnvironmentOrderProperty[] (optional)

The order of the service environment associated with the job queue.

Job queues with a higher priority are evaluated first when associated with the same service environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-serviceenvironmentorder

state?

Type: string (optional)

The state of the job queue.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state

tags?

Type: { [string]: string } (optional)

The tags that are applied to the job queue.

For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-tags

← PreviousNext →