software.amazon.awscdk.services.batch

Class CfnJobQueue

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.batch.CfnJobQueue

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:27.658Z")
public class CfnJobQueue
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Batch::JobQueue`.

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues in the ** .

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.*;
 CfnJobQueue cfnJobQueue = CfnJobQueue.Builder.create(this, "MyCfnJobQueue")
         .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

Nested Classes

Modifier and Type	Class and Description
static class	CfnJobQueue.Builder A fluent builder for CfnJobQueue.
static interface	CfnJobQueue.ComputeEnvironmentOrderProperty The order in which compute environments are tried for job placement within a queue.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJobQueue(Construct scope, java.lang.String id, CfnJobQueueProps props) Create a new `AWS::Batch::JobQueue`.
protected	CfnJobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobQueue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrJobQueueArn() Returns the job queue ARN, such as `batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getComputeEnvironmentOrder() The set of compute environments mapped to a job queue and their order relative to each other.
java.lang.String	getJobQueueName() The name of the job queue.
java.lang.Number	getPriority() The priority of the job queue.
java.lang.String	getSchedulingPolicyArn() The Amazon Resource Name (ARN) of the scheduling policy.
java.lang.String	getState() The state of the job queue.
TagManager	getTags() The tags applied to the job queue.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setComputeEnvironmentOrder(IResolvable value) The set of compute environments mapped to a job queue and their order relative to each other.
void	setComputeEnvironmentOrder(java.util.List<java.lang.Object> value) The set of compute environments mapped to a job queue and their order relative to each other.
void	setJobQueueName(java.lang.String value) The name of the job queue.
void	setPriority(java.lang.Number value) The priority of the job queue.
void	setSchedulingPolicyArn(java.lang.String value) The Amazon Resource Name (ARN) of the scheduling policy.
void	setState(java.lang.String value) The state of the job queue.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnJobQueue

protected CfnJobQueue(software.amazon.jsii.JsiiObjectRef objRef)

CfnJobQueue

protected CfnJobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJobQueue

public CfnJobQueue(Construct scope,
                   java.lang.String id,
                   CfnJobQueueProps props)

Create a new `AWS::Batch::JobQueue`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrJobQueueArn

public java.lang.String getAttrJobQueueArn()

Returns the job queue ARN, such as `batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags applied to the job queue.

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

getComputeEnvironmentOrder

public java.lang.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.

setComputeEnvironmentOrder

public void setComputeEnvironmentOrder(IResolvable value)

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.

setComputeEnvironmentOrder

public void setComputeEnvironmentOrder(java.util.List<java.lang.Object> value)

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.

getPriority

public java.lang.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.

setPriority

public void setPriority(java.lang.Number value)

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.

getJobQueueName

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

setJobQueueName

public void setJobQueueName(java.lang.String value)

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

public java.lang.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:012345678910:scheduling-policy/MySchedulingPolicy .

setSchedulingPolicyArn

public void setSchedulingPolicyArn(java.lang.String value)

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:012345678910:scheduling-policy/MySchedulingPolicy .

getState

public java.lang.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.

setState

public void setState(java.lang.String value)

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.