@aws-cdk_aws-batch-alpha.FairshareSchedulingPolicy

class FairshareSchedulingPolicy (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IFairshareSchedulingPolicy, ISchedulingPolicy

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

The Faireshare Scheduling Policy ensures that each share gets a certain amount of vCPUs. The scheduler 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.

Example

const fairsharePolicy = new batch.FairshareSchedulingPolicy(this, 'myFairsharePolicy');

fairsharePolicy.addShare({
  shareIdentifier: 'A',
  weightFactor: 1,
});
fairsharePolicy.addShare({
  shareIdentifier: 'B',
  weightFactor: 1,
});
new batch.JobQueue(this, 'JobQueue', {
  schedulingPolicy: fairsharePolicy,
});

Initializer

new FairshareSchedulingPolicy(scope: Construct, id: string, props?: FairshareSchedulingPolicyProps)

Parameters

  • scope Construct
  • id string
  • props FairshareSchedulingPolicyProps

Construct Props

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.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
schedulingPolicyArn๐Ÿ”นstringThe arn of this scheduling policy.
schedulingPolicyName๐Ÿ”นstringThe name of this scheduling policy.
shares๐Ÿ”นShare[]The shares that this Scheduling Policy applies to.
stack๐Ÿ”นStackThe stack in which this resource is defined.
computeReservation?๐Ÿ”นnumberUsed to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.
shareDecay?๐Ÿ”นDurationThe amount of time to use to measure the usage of each job.

env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


schedulingPolicyArn๐Ÿ”น

Type: string

The arn of this scheduling policy.


schedulingPolicyName๐Ÿ”น

Type: string

The name of this scheduling policy.


shares๐Ÿ”น

Type: Share[]

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.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.


computeReservation?๐Ÿ”น

Type: number (optional)

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.


shareDecay?๐Ÿ”น

Type: Duration (optional)

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

Methods

NameDescription
addShare(share)๐Ÿ”นAdd a share this to this Fairshare SchedulingPolicy.
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromFairshareSchedulingPolicyArn(scope, id, fairshareSchedulingPolicyArn)๐Ÿ”นReference an exisiting Scheduling Policy by its ARN.

addShare(share)๐Ÿ”น

public addShare(share: Share): void

Parameters

  • share Share

Add a share this to this Fairshare SchedulingPolicy.


applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromFairshareSchedulingPolicyArn(scope, id, fairshareSchedulingPolicyArn)๐Ÿ”น

public static fromFairshareSchedulingPolicyArn(scope: Construct, id: string, fairshareSchedulingPolicyArn: string): IFairshareSchedulingPolicy

Parameters

  • scope Construct
  • id string
  • fairshareSchedulingPolicyArn string

Returns

  • IFairshareSchedulingPolicy

Reference an exisiting Scheduling Policy by its ARN.