Package software.amazon.awscdk.services.batch

Interface FairshareSchedulingPolicyProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
FairshareSchedulingPolicyProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:59.657Z") @Stability(Stable) public interface FairshareSchedulingPolicyProps extends software.amazon.jsii.JsiiSerializable
Fairshare SchedulingPolicy configuration.

Example: 

 FairshareSchedulingPolicy fairsharePolicy = FairshareSchedulingPolicy.Builder.create(this, "myFairsharePolicy")
         .shareDecay(Duration.minutes(5))
         .build();

  • Method Details

    • getComputeReservation

      @Stability(Stable) @Nullable default Number getComputeReservation()
      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.

      Default: - no vCPU is reserved

    • getSchedulingPolicyName

      @Stability(Stable) @Nullable default String getSchedulingPolicyName()
      The name of this SchedulingPolicy.

      Default: - generated by CloudFormation

    • getShareDecay

      @Stability(Stable) @Nullable default Duration getShareDecay()
      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).

      Default: - 0: only the current job usage is considered

    • getShares

      @Stability(Stable) @Nullable default List<Share> getShares()
      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.

      Default: - no shares

    • builder

      @Stability(Stable) static FairshareSchedulingPolicyProps.Builder builder()
      Returns:
      a FairshareSchedulingPolicyProps.Builder of FairshareSchedulingPolicyProps