PriorityConfigurationOverride - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PriorityConfigurationOverride

An alternate list of prioritized locations for use with a game session queue. When this property is included in a StartGameSessionPlacement request, the alternate list overrides the queue's default location priorities, as defined in the queue's PriorityConfiguration setting (LocationOrder). The override is valid for an individual placement request only. Use this property only with queues that have a PriorityConfiguration setting that prioritizes LOCATION first.

Note

A priority configuration override list does not override a queue's FilterConfiguration setting, if the queue has one. Filter configurations are used to limit placements to a subset of the locations in a queue's destinations. If the override list includes a location that's not on in the FilterConfiguration allowed list, Amazon GameLift won't attempt to place a game session there.

Contents

Note

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

LocationOrder

A prioritized list of hosting locations. The list can include Amazon Web Services Regions (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 10 items.

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

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

Required: Yes

PlacementFallbackStrategy

Instructions for how to proceed if placement fails in every location on the priority override list. Valid strategies include:

  • DEFAULT_AFTER_SINGLE_PASS -- After attempting to place a new game session in every location on the priority override list, try to place a game session in queue's other locations. This is the default behavior.

  • NONE -- Limit placements to locations on the priority override list only.

Type: String

Valid Values: DEFAULT_AFTER_SINGLE_PASS | NONE

Required: No

See Also

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