libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.Types.TargetConfiguration

Description

 
Synopsis

Documentation

data TargetConfiguration Source #

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

See: newTargetConfiguration smart constructor.

Constructors

TargetConfiguration' 

Fields

  • targetValue :: Double

    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

Instances

Instances details
Eq TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

Read TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

Show TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

Generic TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

Associated Types

type Rep TargetConfiguration :: Type -> Type #

NFData TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

Methods

rnf :: TargetConfiguration -> () #

Hashable TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

ToJSON TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

FromJSON TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

type Rep TargetConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.TargetConfiguration

type Rep TargetConfiguration = D1 ('MetaData "TargetConfiguration" "Amazonka.GameLift.Types.TargetConfiguration" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "TargetConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))

newTargetConfiguration Source #

Create a value of TargetConfiguration 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:targetValue:TargetConfiguration', targetConfiguration_targetValue - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

targetConfiguration_targetValue :: Lens' TargetConfiguration Double Source #

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).