software.amazon.awscdk.services.batch

Interface CfnSchedulingPolicy.FairsharePolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchedulingPolicy.FairsharePolicyProperty.Jsii$Proxy

Enclosing class:

CfnSchedulingPolicy

@Stability(value=Stable)
public static interface CfnSchedulingPolicy.FairsharePolicyProperty
extends software.amazon.jsii.JsiiSerializable

The fair share policy for a scheduling policy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 FairsharePolicyProperty fairsharePolicyProperty = FairsharePolicyProperty.builder()
         .computeReservation(123)
         .shareDecaySeconds(123)
         .shareDistribution(List.of(ShareAttributesProperty.builder()
                 .shareIdentifier("shareIdentifier")
                 .weightFactor(123)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSchedulingPolicy.FairsharePolicyProperty.Builder A builder for CfnSchedulingPolicy.FairsharePolicyProperty
static class	CfnSchedulingPolicy.FairsharePolicyProperty.Jsii$Proxy An implementation for CfnSchedulingPolicy.FairsharePolicyProperty

Method Summary

Modifier and Type	Method and Description
static CfnSchedulingPolicy.FairsharePolicyProperty.Builder	builder()
default Number	getComputeReservation() A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
default Number	getShareDecaySeconds() The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds.
default Object	getShareDistribution() An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComputeReservation

@Stability(value=Stable)
 @Nullable
default Number getComputeReservation()

A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.

The reserved ratio is ( *computeReservation* /100)^ *ActiveFairShares* where *ActiveFairShares* is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that AWS Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 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 is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

getShareDecaySeconds

@Stability(value=Stable)
 @Nullable
default Number getShareDecaySeconds()

The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds.

A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

getShareDistribution

@Stability(value=Stable)
 @Nullable
default Object getShareDistribution()

An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.

Fair share identifiers that aren't included have a default weight of 1.0 .

builder

@Stability(value=Stable)
static CfnSchedulingPolicy.FairsharePolicyProperty.Builder builder()

Returns:

a CfnSchedulingPolicy.FairsharePolicyProperty.Builder of CfnSchedulingPolicy.FairsharePolicyProperty