Class FairshareSchedulingPolicyProps
Fairshare SchedulingPolicy configuration.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FairshareSchedulingPolicyProps : Object, IFairshareSchedulingPolicyProps
Syntax (vb)
Public Class FairshareSchedulingPolicyProps
Inherits Object
Implements IFairshareSchedulingPolicyProps
Remarks
ExampleMetadata: infused
Examples
var fairsharePolicy = new FairshareSchedulingPolicy(this, "myFairsharePolicy", new FairshareSchedulingPolicyProps {
ShareDecay = Duration.Minutes(5)
});
Synopsis
Constructors
FairshareSchedulingPolicyProps() |
Properties
ComputeReservation | Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue. |
SchedulingPolicyName | The name of this SchedulingPolicy. |
ShareDecay | The amount of time to use to measure the usage of each job. |
Shares | The shares that this Scheduling Policy applies to. |
Constructors
FairshareSchedulingPolicyProps()
public FairshareSchedulingPolicyProps()
Properties
ComputeReservation
Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.
public Nullable<double> ComputeReservation { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
SchedulingPolicyName
The name of this SchedulingPolicy.
public string SchedulingPolicyName { get; set; }
Property Value
System.String
Remarks
Default: - generated by CloudFormation
ShareDecay
The amount of time to use to measure the usage of each job.
public Duration ShareDecay { get; set; }
Property Value
Remarks
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
Shares
The shares that this Scheduling Policy applies to.
public IShare[] Shares { get; set; }
Property Value
IShare[]
Remarks
Note: It is possible to submit Jobs to the queue with Share Identifiers that are not recognized by the Scheduling Policy.
Default: - no shares