Package software.amazon.awscdk.services.batch

Interface CfnJobQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.668Z")
@Stability(Stable)
public interface CfnJobQueueProps
extends software.amazon.jsii.JsiiSerializable

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 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")
         .jobStateTimeLimitActions(List.of(JobStateTimeLimitActionProperty.builder()
                 .action("action")
                 .maxTimeSeconds(123)
                 .reason("reason")
                 .state("state")
                 .build()))
         .schedulingPolicyArn("schedulingPolicyArn")
         .state("state")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobQueueProps.Builder	A builder for CfnJobQueueProps
static final class	CfnJobQueueProps.Jsii$Proxy	An implementation for CfnJobQueueProps

Method Summary

Modifier and Type	Method	Description
static CfnJobQueueProps.Builder	builder()
Object	getComputeEnvironmentOrder()	The set of compute environments mapped to a job queue and their order relative to each other.
default String	getJobQueueName()	The name of the job queue.
default Object	getJobStateTimeLimitActions()	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.
Number	getPriority()	The priority of the job queue.
default String	getSchedulingPolicyArn()	The Amazon Resource Name (ARN) of the scheduling policy.
default String	getState()	The state of the job queue.
default Map<String,String>	getTags()	The tags that are applied to the job queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeEnvironmentOrder

@Stability(Stable)
@NotNull
Object 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 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

getPriority

@Stability(Stable)
@NotNull
Number 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 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

getJobQueueName

@Stability(Stable)
@Nullable
default String 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 (_).

See Also:

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

getJobStateTimeLimitActions

@Stability(Stable)
@Nullable
default Object getJobStateTimeLimitActions()

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

getSchedulingPolicyArn

@Stability(Stable)
@Nullable
default String 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 .

See Also:

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

getState

@Stability(Stable)
@Nullable
default String 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 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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

builder

@Stability(Stable)
static CfnJobQueueProps.Builder builder()

Returns:

a CfnJobQueueProps.Builder of CfnJobQueueProps