Class: Aws::GameLift::Types::PriorityConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

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

{
  priority_order: ["LATENCY"], # accepts LATENCY, COST, DESTINATION, LOCATION
  location_order: ["LocationStringModel"],
}

Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:

  • If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.

  • If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).

Changing the priority order will affect how game sessions are placed.

Priority configurations are part of a GameSessionQueue.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#location_orderArray<String>

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

Returns:

  • (Array<String>)


7527
7528
7529
7530
7531
7532
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7527

class PriorityConfiguration < Struct.new(
  :priority_order,
  :location_order)
  SENSITIVE = []
  include Aws::Structure
end

#priority_orderArray<String>

The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

  • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

  • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

  • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

  • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

Returns:

  • (Array<String>)


7527
7528
7529
7530
7531
7532
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7527

class PriorityConfiguration < Struct.new(
  :priority_order,
  :location_order)
  SENSITIVE = []
  include Aws::Structure
end