Package software.amazon.awscdk.services.batch

Class FairshareSchedulingPolicyProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • computeReservation

      @Stability(Stable) public FairshareSchedulingPolicyProps.Builder computeReservation(Number computeReservation)
      Sets the value of FairshareSchedulingPolicyProps.getComputeReservation()
      Parameters:
      computeReservation - Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue. The percentage reserved is defined by the Scheduler as: (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

      For example, a computeReservation value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers.

      A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

      Returns:
      this

    • schedulingPolicyName

      @Stability(Stable) public FairshareSchedulingPolicyProps.Builder schedulingPolicyName(String schedulingPolicyName)
      Sets the value of FairshareSchedulingPolicyProps.getSchedulingPolicyName()
      Parameters:
      schedulingPolicyName - The name of this SchedulingPolicy.
      Returns:
      this

    • shareDecay

      @Stability(Stable) public FairshareSchedulingPolicyProps.Builder shareDecay(Duration shareDecay)
      Sets the value of FairshareSchedulingPolicyProps.getShareDecay()
      Parameters:
      shareDecay - The amount of time to use to measure the usage of each job. The usage is used to calculate a fair share percentage for each fair share identifier currently in the Queue. A value of zero (0) indicates that only current usage is measured. The decay is linear and gives preference to newer jobs.

      The maximum supported value is 604800 seconds (1 week).

      Returns:
      this

    • shares

      @Stability(Stable) public FairshareSchedulingPolicyProps.Builder shares(List<? extends Share> shares)
      Sets the value of FairshareSchedulingPolicyProps.getShares()
      Parameters:
      shares - The shares that this Scheduling Policy applies to. Note: It is possible to submit Jobs to the queue with Share Identifiers that are not recognized by the Scheduling Policy.
      Returns:
      this

    • build

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