Package 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(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();

  • Method Details

    • getComputeReservation

      @Stability(Stable) @Nullable default Number getComputeReservation()
      A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already 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 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.

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

    • getShareDecaySeconds

      @Stability(Stable) @Nullable default Number getShareDecaySeconds()
      The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use.

      A value of zero (0) indicates that only current usage is 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(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(Stable) static CfnSchedulingPolicy.FairsharePolicyProperty.Builder builder()
      Returns:
      a CfnSchedulingPolicy.FairsharePolicyProperty.Builder of CfnSchedulingPolicy.FairsharePolicyProperty