@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.916Z") @Stability(value=Stable) public class CfnJobQueue extends CfnResource implements IInspectable
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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnJobQueue(software.constructs.Construct scope,
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) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAttrJobQueueArn()
Returns the job queue ARN, such as `batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*` .
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getComputeEnvironmentOrder()
The set of compute environments mapped to a job queue and their order relative to each other.
|
String |
getJobQueueName()
The name of the job queue.
|
Number |
getPriority()
The priority of the job queue.
|
String |
getSchedulingPolicyArn()
The Amazon Resource Name (ARN) of the scheduling policy.
|
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 Map<String,Object> |
renderProperties(Map<String,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(List<Object> value)
The set of compute environments mapped to a job queue and their order relative to each other.
|
void |
setJobQueueName(String value)
The name of the job queue.
|
void |
setPriority(Number value)
The priority of the job queue.
|
void |
setSchedulingPolicyArn(String value)
The Amazon Resource Name (ARN) of the scheduling policy.
|
void |
setState(String value)
The state of the job queue.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnJobQueue(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnJobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnJobQueue(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnJobQueueProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrJobQueueArn()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .
@Stability(value=Stable) @NotNull public Object getComputeEnvironmentOrder()
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.
@Stability(value=Stable)
public void setComputeEnvironmentOrder(@NotNull
IResolvable value)
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.
@Stability(value=Stable)
public void setComputeEnvironmentOrder(@NotNull
List<Object> value)
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.
@Stability(value=Stable) @NotNull public Number getPriority()
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.
@Stability(value=Stable)
public void setPriority(@NotNull
Number value)
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.
@Stability(value=Stable) @Nullable public String getJobQueueName()
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
@Stability(value=Stable)
public void setJobQueueName(@Nullable
String value)
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
@Stability(value=Stable) @Nullable public String getSchedulingPolicyArn()
The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy .
@Stability(value=Stable)
public void setSchedulingPolicyArn(@Nullable
String value)
The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy .
@Stability(value=Stable) @Nullable public String getState()
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.
@Stability(value=Stable)
public void setState(@Nullable
String value)
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.
Copyright © 2022. All rights reserved.