Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnJobQueueMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • computeEnvironmentOrder

      @Stability(Stable) public CfnJobQueueMixinProps.Builder computeEnvironmentOrder(IResolvable computeEnvironmentOrder)
      Sets the value of CfnJobQueueMixinProps.getComputeEnvironmentOrder()
      Parameters:
      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.

      Returns:
      this

    • computeEnvironmentOrder

      @Stability(Stable) public CfnJobQueueMixinProps.Builder computeEnvironmentOrder(List<? extends Object> computeEnvironmentOrder)
      Sets the value of CfnJobQueueMixinProps.getComputeEnvironmentOrder()
      Parameters:
      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.

      Returns:
      this

    • jobQueueName

      @Stability(Stable) public CfnJobQueueMixinProps.Builder jobQueueName(String jobQueueName)
      Sets the value of CfnJobQueueMixinProps.getJobQueueName()
      Parameters:
      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 (_).
      Returns:
      this

    • jobQueueType

      @Stability(Stable) public CfnJobQueueMixinProps.Builder jobQueueType(String jobQueueType)
      Sets the value of CfnJobQueueMixinProps.getJobQueueType()
      Parameters:
      jobQueueType - The type of job queue. For service jobs that run on SageMaker AI , this value is SAGEMAKER_TRAINING . For regular container jobs, this value is EKS , ECS , or ECS_FARGATE depending on the compute environment.
      Returns:
      this

    • jobStateTimeLimitActions

      @Stability(Stable) public CfnJobQueueMixinProps.Builder jobStateTimeLimitActions(IResolvable jobStateTimeLimitActions)
      Sets the value of CfnJobQueueMixinProps.getJobStateTimeLimitActions()
      Parameters:
      jobStateTimeLimitActions - 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.
      Returns:
      this

    • jobStateTimeLimitActions

      @Stability(Stable) public CfnJobQueueMixinProps.Builder jobStateTimeLimitActions(List<? extends Object> jobStateTimeLimitActions)
      Sets the value of CfnJobQueueMixinProps.getJobStateTimeLimitActions()
      Parameters:
      jobStateTimeLimitActions - 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.
      Returns:
      this

    • priority

      @Stability(Stable) public CfnJobQueueMixinProps.Builder priority(Number priority)
      Sets the value of CfnJobQueueMixinProps.getPriority()
      Parameters:
      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.
      Returns:
      this

    • schedulingPolicyArn

      @Stability(Stable) public CfnJobQueueMixinProps.Builder schedulingPolicyArn(String schedulingPolicyArn)
      Sets the value of CfnJobQueueMixinProps.getSchedulingPolicyArn()
      Parameters:
      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 .
      Returns:
      this

    • schedulingPolicyArn

      @Stability(Stable) public CfnJobQueueMixinProps.Builder schedulingPolicyArn(ISchedulingPolicyRef schedulingPolicyArn)
      Sets the value of CfnJobQueueMixinProps.getSchedulingPolicyArn()
      Parameters:
      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 .
      Returns:
      this

    • serviceEnvironmentOrder

      @Stability(Stable) public CfnJobQueueMixinProps.Builder serviceEnvironmentOrder(IResolvable serviceEnvironmentOrder)
      Sets the value of CfnJobQueueMixinProps.getServiceEnvironmentOrder()
      Parameters:
      serviceEnvironmentOrder - The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.
      Returns:
      this

    • serviceEnvironmentOrder

      @Stability(Stable) public CfnJobQueueMixinProps.Builder serviceEnvironmentOrder(List<? extends Object> serviceEnvironmentOrder)
      Sets the value of CfnJobQueueMixinProps.getServiceEnvironmentOrder()
      Parameters:
      serviceEnvironmentOrder - The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.
      Returns:
      this

    • state

      @Stability(Stable) public CfnJobQueueMixinProps.Builder state(String state)
      Sets the value of CfnJobQueueMixinProps.getState()
      Parameters:
      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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnJobQueueMixinProps.Builder tags(Map<String,String> tags)
      Sets the value of CfnJobQueueMixinProps.getTags()
      Parameters:
      tags - The tags that are applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .
      Returns:
      this

    • build

      @Stability(Stable) public CfnJobQueueMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnJobQueueMixinProps>
      Returns:
      a new instance of CfnJobQueueMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided