Package software.amazon.awscdk.services.batch

Interface IFairshareSchedulingPolicy.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IFairshareSchedulingPolicy, IResource, IResource.Jsii$Default, ISchedulingPolicy, ISchedulingPolicy.Jsii$Default, ISchedulingPolicyRef, ISchedulingPolicyRef.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IFairshareSchedulingPolicy.Jsii$Proxy
Enclosing interface:
IFairshareSchedulingPolicy
@Internal public static interface IFairshareSchedulingPolicy.Jsii$Default extends IFairshareSchedulingPolicy, ISchedulingPolicy.Jsii$Default
Internal default implementation for IFairshareSchedulingPolicy.

  • Method Details

    • getShares

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

      Specified by:
      getShares in interface IFairshareSchedulingPolicy

    • 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

      Specified by:
      getComputeReservation in interface IFairshareSchedulingPolicy

    • 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

      Specified by:
      getShareDecay in interface IFairshareSchedulingPolicy