Interface IFairshareSchedulingPolicy

Represents a Fairshare Scheduling Policy. Instructs the scheduler to allocate ComputeEnvironment vCPUs based on Job shareIdentifiers.

Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IFairshareSchedulingPolicy : ISchedulingPolicy, IResource, ISchedulingPolicyRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IFairshareSchedulingPolicy Inherits ISchedulingPolicy, IResource, ISchedulingPolicyRef, IConstruct, IDependable, IEnvironmentAware
Remarks

The Faireshare Scheduling Policy ensures that each share gets a certain amount of vCPUs. It does this by deciding how many Jobs of each share to schedule relative to how many jobs of each share are currently being executed by the ComputeEnvironment. The weight factors associated with each share determine the ratio of vCPUs allocated; see the readme for a more in-depth discussion of fairshare policies.

Synopsis

Properties

ComputeReservation

Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.
ShareDecay

The amount of time to use to measure the usage of each job.
Shares

The shares that this Scheduling Policy applies to.

Properties

ComputeReservation

Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.

double? ComputeReservation { get; }
Property Value

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

ShareDecay

The amount of time to use to measure the usage of each job.

Duration? ShareDecay { get; }
Property Value

Duration

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.

IShare[] Shares { get; }
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.