Package software.amazon.awscdk.services.batch

Class CfnJobQueue

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:47.641Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJobQueue

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

    • CfnJobQueue

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

    • CfnJobQueue

      @Stability(Stable) public CfnJobQueue(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrJobQueueArn

      @Stability(Stable) @NotNull public String getAttrJobQueueArn()
      Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags that are applied to the job queue.

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

    • getComputeEnvironmentOrder

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

      @Stability(Stable) public void setComputeEnvironmentOrder(@NotNull 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

      @Stability(Stable) public void setComputeEnvironmentOrder(@NotNull List<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

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

      @Stability(Stable) public void setPriority(@NotNull 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

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

      @Stability(Stable) public void setJobQueueName(@Nullable 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

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

    • setSchedulingPolicyArn

      @Stability(Stable) public void setSchedulingPolicyArn(@Nullable 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:123456789012:scheduling-policy/MySchedulingPolicy .

    • getState

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

      @Stability(Stable) public void setState(@Nullable 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.