Amazonka.Batch.Types.FairsharePolicy

Documentation

data FairsharePolicy

The fair share policy for a scheduling policy.

See: newFairsharePolicy smart constructor.

Constructors

FairsharePolicy'

Fields

• computeReservation :: Maybe Int

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

• shareDecaySeconds :: Maybe Int

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

• shareDistribution :: Maybe [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.

Instances

FromJSON FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

parseJSON :: Value -> Parser FairsharePolicy

parseJSONList :: Value -> Parser [FairsharePolicy]

ToJSON FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

toJSON :: FairsharePolicy -> Value

toEncoding :: FairsharePolicy -> Encoding

toJSONList :: [FairsharePolicy] -> Value

toEncodingList :: [FairsharePolicy] -> Encoding

Generic FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Associated Types

type Rep FairsharePolicy :: Type -> Type

Methods

from :: FairsharePolicy -> Rep FairsharePolicy x

to :: Rep FairsharePolicy x -> FairsharePolicy

Read FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

readsPrec :: Int -> ReadS FairsharePolicy

readList :: ReadS [FairsharePolicy]

readPrec :: ReadPrec FairsharePolicy

readListPrec :: ReadPrec [FairsharePolicy]

Show FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

showsPrec :: Int -> FairsharePolicy -> ShowS

show :: FairsharePolicy -> String

showList :: [FairsharePolicy] -> ShowS

NFData FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

rnf :: FairsharePolicy -> ()

Eq FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

(==) :: FairsharePolicy -> FairsharePolicy -> Bool

(/=) :: FairsharePolicy -> FairsharePolicy -> Bool

Hashable FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

hashWithSalt :: Int -> FairsharePolicy -> Int

hash :: FairsharePolicy -> Int

type Rep FairsharePolicy

Defined in Amazonka.Batch.Types.FairsharePolicy

type Rep FairsharePolicy = D1 ('MetaData "FairsharePolicy" "Amazonka.Batch.Types.FairsharePolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "FairsharePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "shareDecaySeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "shareDistribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareAttributes])))))

newFairsharePolicy :: FairsharePolicy

Create a value of FairsharePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeReservation:FairsharePolicy', fairsharePolicy_computeReservation - 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 Batchreserves 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 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.

$sel:shareDecaySeconds:FairsharePolicy', fairsharePolicy_shareDecaySeconds - 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).

$sel:shareDistribution:FairsharePolicy', fairsharePolicy_shareDistribution - 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.

fairsharePolicy_computeReservation :: Lens' FairsharePolicy (Maybe Int)

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

fairsharePolicy_shareDecaySeconds :: Lens' FairsharePolicy (Maybe Int)

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

fairsharePolicy_shareDistribution :: Lens' FairsharePolicy (Maybe [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.