Interface CfnJobQueueProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobQueueProps.Jsii$Proxy
CfnJobQueue
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.batch.*; CfnJobQueueProps cfnJobQueueProps = CfnJobQueueProps.builder() .computeEnvironmentOrder(List.of(ComputeEnvironmentOrderProperty.builder() .computeEnvironment("computeEnvironment") .order(123) .build())) .priority(123) // the properties below are optional .jobQueueName("jobQueueName") .schedulingPolicyArn("schedulingPolicyArn") .state("state") .tags(Map.of( "tagsKey", "tags")) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnJobQueueProps
static final class
An implementation forCfnJobQueueProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnJobQueueProps.Builder
builder()
The set of compute environments mapped to a job queue and their order relative to each other.default String
The name of the job queue.The priority of the job queue.default String
The Amazon Resource Name (ARN) of the scheduling policy.default String
getState()
The state of the job queue.getTags()
The tags that are applied to the job queue.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComputeEnvironmentOrder
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
orSPOT
) or Fargate (FARGATE
orFARGATE_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.
-
getPriority
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 of10
is given scheduling preference over a job queue with a priority value of1
. All of the compute environments must be either EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
); EC2 and Fargate compute environments can't be mixed. -
getJobQueueName
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 (_).
-
getSchedulingPolicyArn
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
. -
getState
The state of the job queue.If the job queue state is
ENABLED
, it is able to accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish. -
getTags
The tags that are applied to the job queue.For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .
-
builder
- Returns:
- a
CfnJobQueueProps.Builder
ofCfnJobQueueProps
-