Package software.amazon.awscdk.services.batch

Class CfnJobQueue.Builder

java.lang.Object
software.amazon.awscdk.services.batch.CfnJobQueue.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnJobQueue>
Enclosing class:
CfnJobQueue
@Stability(Stable) public static final class CfnJobQueue.Builder extends Object implements software.amazon.jsii.Builder<CfnJobQueue>
A fluent builder for CfnJobQueue.

  • Method Details

    • create

      @Stability(Stable) public static CfnJobQueue.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnJobQueue.Builder.

    • computeEnvironmentOrder

      @Stability(Stable) public CfnJobQueue.Builder computeEnvironmentOrder(IResolvable computeEnvironmentOrder)
      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.

      Parameters:
      computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. This parameter is required.
      Returns:
      this

    • computeEnvironmentOrder

      @Stability(Stable) public CfnJobQueue.Builder computeEnvironmentOrder(List<? extends Object> computeEnvironmentOrder)
      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.

      Parameters:
      computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. This parameter is required.
      Returns:
      this

    • priority

      @Stability(Stable) public CfnJobQueue.Builder priority(Number priority)
      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.

      Parameters:
      priority - The priority of the job queue. This parameter is required.
      Returns:
      this

    • jobQueueName

      @Stability(Stable) public CfnJobQueue.Builder jobQueueName(String jobQueueName)
      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 (_).

      Parameters:
      jobQueueName - The name of the job queue. This parameter is required.
      Returns:
      this

    • schedulingPolicyArn

      @Stability(Stable) public CfnJobQueue.Builder schedulingPolicyArn(String schedulingPolicyArn)
      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 .

      Parameters:
      schedulingPolicyArn - The Amazon Resource Name (ARN) of the scheduling policy. This parameter is required.
      Returns:
      this

    • state

      @Stability(Stable) public CfnJobQueue.Builder state(String state)
      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.

      Parameters:
      state - The state of the job queue. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnJobQueue.Builder tags(Map<String,String> tags)
      The tags that are applied to the job queue.

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

      Parameters:
      tags - The tags that are applied to the job queue. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnJobQueue build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnJobQueue>
      Returns:
      a newly built instance of CfnJobQueue.