Class: Aws::Batch::Types::FairsharePolicy

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::FairsharePolicy

Defined in:

gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass FairsharePolicy data as a hash:

{
  share_decay_seconds: 1,
  compute_reservation: 1,
  share_distribution: [
    {
      share_identifier: "String", # required
      weight_factor: 1.0,
    },
  ],
}

The fair share policy for a scheduling policy.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute_reservation ⇒ Integer

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

• #share_decay_seconds ⇒ Integer

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

• #share_distribution ⇒ Array<Types::ShareAttributes>

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

Instance Attribute Details

#compute_reservation ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3230

class FairsharePolicy < Struct.new(
  :share_decay_seconds,
  :compute_reservation,
  :share_distribution)
  SENSITIVE = []
  include Aws::Structure
end

#share_decay_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3230

class FairsharePolicy < Struct.new(
  :share_decay_seconds,
  :compute_reservation,
  :share_distribution)
  SENSITIVE = []
  include Aws::Structure
end

#share_distribution ⇒ Array<Types::ShareAttributes>

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.

Returns:

• (Array<Types::ShareAttributes>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3230

class FairsharePolicy < Struct.new(
  :share_decay_seconds,
  :compute_reservation,
  :share_distribution)
  SENSITIVE = []
  include Aws::Structure
end