Class CfnSchedulingPolicy.FairsharePolicyProperty

The fair-share scheduling policy details.

Inheritance

object

CfnSchedulingPolicy.FairsharePolicyProperty

Implements

CfnSchedulingPolicy.IFairsharePolicyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSchedulingPolicy.FairsharePolicyProperty : CfnSchedulingPolicy.IFairsharePolicyProperty

Syntax (vb)

Public Class CfnSchedulingPolicy.FairsharePolicyProperty Implements CfnSchedulingPolicy.IFairsharePolicyProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var fairsharePolicyProperty = new FairsharePolicyProperty {
                 ComputeReservation = 123,
                 ShareDecaySeconds = 123,
                 ShareDistribution = new [] { new ShareAttributesProperty {
                     ShareIdentifier = "shareIdentifier",
                     WeightFactor = 123
                 } }
             };

Synopsis

Constructors

FairsharePolicyProperty()

The fair-share scheduling policy details.

Properties

ComputeReservation	A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used.
ShareDecaySeconds	The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use.
ShareDistribution	An array of `SharedIdentifier` objects that contain the weights for the share identifiers for the fair-share policy.

Constructors

FairsharePolicyProperty()

The fair-share scheduling policy details.

public FairsharePolicyProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var fairsharePolicyProperty = new FairsharePolicyProperty {
                 ComputeReservation = 123,
                 ShareDecaySeconds = 123,
                 ShareDistribution = new [] { new ShareAttributesProperty {
                     ShareIdentifier = "shareIdentifier",
                     WeightFactor = 123
                 } }
             };

Properties

ComputeReservation

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

public double? ComputeReservation { get; set; }

Property Value

double?

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-computereservation

ShareDecaySeconds

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

public double? ShareDecaySeconds { get; set; }

Property Value

double?

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedecayseconds

ShareDistribution

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

public object? ShareDistribution { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or (either IResolvable or CfnSchedulingPolicy.IShareAttributesProperty)[]

Implements

CfnSchedulingPolicy.IFairsharePolicyProperty