AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::GameServerGroupAutoScalingPolicy Class Reference

#include <GameServerGroupAutoScalingPolicy.h>

Public Member Functions

 GameServerGroupAutoScalingPolicy ()
 
 GameServerGroupAutoScalingPolicy (Aws::Utils::Json::JsonView jsonValue)
 
GameServerGroupAutoScalingPolicyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetEstimatedInstanceWarmup () const
 
bool EstimatedInstanceWarmupHasBeenSet () const
 
void SetEstimatedInstanceWarmup (int value)
 
GameServerGroupAutoScalingPolicyWithEstimatedInstanceWarmup (int value)
 
const TargetTrackingConfigurationGetTargetTrackingConfiguration () const
 
bool TargetTrackingConfigurationHasBeenSet () const
 
void SetTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
void SetTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 
GameServerGroupAutoScalingPolicyWithTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
GameServerGroupAutoScalingPolicyWithTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 

Detailed Description

This data type is used with the Amazon 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 Also:

AWS API Reference

Definition at line 38 of file GameServerGroupAutoScalingPolicy.h.

Constructor & Destructor Documentation

◆ GameServerGroupAutoScalingPolicy() [1/2]

Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::GameServerGroupAutoScalingPolicy ( )

◆ GameServerGroupAutoScalingPolicy() [2/2]

Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::GameServerGroupAutoScalingPolicy ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EstimatedInstanceWarmupHasBeenSet()

bool Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::EstimatedInstanceWarmupHasBeenSet ( ) const
inline

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.

Definition at line 61 of file GameServerGroupAutoScalingPolicy.h.

◆ GetEstimatedInstanceWarmup()

int Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::GetEstimatedInstanceWarmup ( ) const
inline

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.

Definition at line 53 of file GameServerGroupAutoScalingPolicy.h.

◆ GetTargetTrackingConfiguration()

const TargetTrackingConfiguration& Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::GetTargetTrackingConfiguration ( ) const
inline

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.

Definition at line 87 of file GameServerGroupAutoScalingPolicy.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::Jsonize ( ) const

◆ operator=()

GameServerGroupAutoScalingPolicy& Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEstimatedInstanceWarmup()

void Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::SetEstimatedInstanceWarmup ( int  value)
inline

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.

Definition at line 69 of file GameServerGroupAutoScalingPolicy.h.

◆ SetTargetTrackingConfiguration() [1/2]

void Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::SetTargetTrackingConfiguration ( const TargetTrackingConfiguration value)
inline

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.

Definition at line 105 of file GameServerGroupAutoScalingPolicy.h.

◆ SetTargetTrackingConfiguration() [2/2]

void Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::SetTargetTrackingConfiguration ( TargetTrackingConfiguration &&  value)
inline

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.

Definition at line 114 of file GameServerGroupAutoScalingPolicy.h.

◆ TargetTrackingConfigurationHasBeenSet()

bool Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::TargetTrackingConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 96 of file GameServerGroupAutoScalingPolicy.h.

◆ WithEstimatedInstanceWarmup()

GameServerGroupAutoScalingPolicy& Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::WithEstimatedInstanceWarmup ( int  value)
inline

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.

Definition at line 77 of file GameServerGroupAutoScalingPolicy.h.

◆ WithTargetTrackingConfiguration() [1/2]

GameServerGroupAutoScalingPolicy& Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::WithTargetTrackingConfiguration ( const TargetTrackingConfiguration value)
inline

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.

Definition at line 123 of file GameServerGroupAutoScalingPolicy.h.

◆ WithTargetTrackingConfiguration() [2/2]

GameServerGroupAutoScalingPolicy& Aws::GameLift::Model::GameServerGroupAutoScalingPolicy::WithTargetTrackingConfiguration ( TargetTrackingConfiguration &&  value)
inline

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.

Definition at line 132 of file GameServerGroupAutoScalingPolicy.h.


The documentation for this class was generated from the following file: