Class: Aws::GameLift::Types::GameServerGroupAutoScalingPolicy

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::GameServerGroupAutoScalingPolicy

show all

Defined in:: gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

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

{
  estimated_instance_warmup: 1,
  target_tracking_configuration: { # required
    target_value: 1.0, # required
  },
}

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#estimated_instance_warmup ⇒ Integer
Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.
#target_tracking_configuration ⇒ Types::TargetTrackingConfiguration
Settings for a target-based scaling policy applied to Auto Scaling group.

Instance Attribute Details

#estimated_instance_warmup ⇒ `Integer`

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.

Returns:

(Integer)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5171

class GameServerGroupAutoScalingPolicy < Struct.new(
  :estimated_instance_warmup,
  :target_tracking_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#target_tracking_configuration ⇒ `Types::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.