@aws-cdk_aws-batch-alpha.FairshareSchedulingPolicyProps

interface FairshareSchedulingPolicyProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.FairshareSchedulingPolicyProps
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#FairshareSchedulingPolicyProps
Javasoftware.amazon.awscdk.services.batch.alpha.FairshareSchedulingPolicyProps
Pythonaws_cdk.aws_batch_alpha.FairshareSchedulingPolicyProps
TypeScript (source)@aws-cdk/aws-batch-alpha ยป FairshareSchedulingPolicyProps

Fairshare SchedulingPolicy configuration.

Example

import * as cdk from 'aws-cdk-lib'
const fairsharePolicy = new batch.FairshareSchedulingPolicy(this, 'myFairsharePolicy', {
   shareDecay: cdk.Duration.minutes(5),
});

Properties

NameTypeDescription
computeReservation?๐Ÿ”นnumberUsed to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.
schedulingPolicyName?๐Ÿ”นstringThe name of this SchedulingPolicy.
shareDecay?๐Ÿ”นDurationThe amount of time to use to measure the usage of each job.
shares?๐Ÿ”นShare[]The shares that this Scheduling Policy applies to.

computeReservation?๐Ÿ”น

Type: number (optional, default: no vCPU is reserved)

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.


schedulingPolicyName?๐Ÿ”น

Type: string (optional, default: generated by CloudFormation)

The name of this SchedulingPolicy.


shareDecay?๐Ÿ”น

Type: Duration (optional, default: 0: only the current job usage is considered)

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).


shares?๐Ÿ”น

Type: Share[] (optional, default: no 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.