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 scheduling policy details.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeReservation

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

A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used.

The reserved ratio is ( *computeReservation* /100)^ *ActiveFairShares* where *ActiveFairShares* is the number of active 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 share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-computereservation

getShareDecaySeconds

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

The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use.

A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week).

The decay allows for more recently run jobs to have more weight than jobs that ran earlier. Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, or a large difference in job count or job run times between share identifiers, and the allocation of resources doesn't meet your needs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedecayseconds

getShareDistribution

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

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSchedulingPolicy.ShareAttributesProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedistribution

builder

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

Returns:

a CfnSchedulingPolicy.FairsharePolicyProperty.Builder of CfnSchedulingPolicy.FairsharePolicyProperty