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

Description

 
Synopsis

Documentation

data GameServerGroupAutoScalingPolicy Source #

__This data type is used with the GameLift FleetIQ and game server groups.__

Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group with CreateGameServerGroup. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

See: newGameServerGroupAutoScalingPolicy smart constructor.

Constructors

GameServerGroupAutoScalingPolicy' 

Fields

  • estimatedInstanceWarmup :: Maybe Natural

    Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

  • targetTrackingConfiguration :: TargetTrackingConfiguration

    Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

Instances

Instances details
Eq GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

Read GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

Show GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

Generic GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

Associated Types

type Rep GameServerGroupAutoScalingPolicy :: Type -> Type #

NFData GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

Hashable GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

ToJSON GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

type Rep GameServerGroupAutoScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy

type Rep GameServerGroupAutoScalingPolicy = D1 ('MetaData "GameServerGroupAutoScalingPolicy" "Amazonka.GameLift.Types.GameServerGroupAutoScalingPolicy" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "GameServerGroupAutoScalingPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "estimatedInstanceWarmup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "targetTrackingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetTrackingConfiguration)))

newGameServerGroupAutoScalingPolicy Source #

Create a value of GameServerGroupAutoScalingPolicy 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:estimatedInstanceWarmup:GameServerGroupAutoScalingPolicy', gameServerGroupAutoScalingPolicy_estimatedInstanceWarmup - Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

$sel:targetTrackingConfiguration:GameServerGroupAutoScalingPolicy', gameServerGroupAutoScalingPolicy_targetTrackingConfiguration - Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

gameServerGroupAutoScalingPolicy_estimatedInstanceWarmup :: Lens' GameServerGroupAutoScalingPolicy (Maybe Natural) Source #

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

gameServerGroupAutoScalingPolicy_targetTrackingConfiguration :: Lens' GameServerGroupAutoScalingPolicy TargetTrackingConfiguration Source #

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.