PriorityConfiguration - Amazon GameLift

PriorityConfiguration

Custom prioritization settings for a game session queue to use when searching for available game servers to place new game sessions. This configuration replaces the default FleetIQ prioritization process.

By default, a queue makes placements based on the following default prioritizations:

  • If player latency data is included in a game session request, Amazon GameLift prioritizes placing game sessions where the average player latency is lowest. Amazon GameLift re-orders the queue's destinations and locations (for multi-location fleets) based on the following priorities: (1) the lowest average latency across all players, (2) the lowest hosting cost, (3) the queue's default destination order, and then (4), an alphabetic list of locations.

  • If player latency data is not included, Amazon GameLift prioritizes placing game sessions in the queue's first destination. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically). Amazon GameLift re-orders the queue's destinations and locations (for multi-location fleets) based on the following priorities: (1) the queue's default destination order, and then (2) an alphabetic list of locations.

Contents

Note

In the following list, the required parameters are described first.

LocationOrder

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include AWS Region codes (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift service locations.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[A-Za-z0-9\-]+

Required: No

PriorityOrder

A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

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

  • DESTINATION -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Valid Values: LATENCY | COST | DESTINATION | LOCATION

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: