Class: Aws::GameLift::Types::PriorityConfigurationOverride

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::PriorityConfigurationOverride

show all

Includes:: Structure

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

Overview

An alternate list of prioritized locations for use with a game session queue. When this property is included in a

StartGameSessionPlacement][1: request, the alternate list overrides

the queue’s default location priorities, as defined in the queue’s [PriorityConfiguration](gamelift/latest/apireference/API_PriorityConfiguration.html) 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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#location_order ⇒ Array<String>

A prioritized list of hosting locations.
#placement_fallback_strategy ⇒ String

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

Instance Attribute Details

#location_order ⇒ `Array<String>`

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.]

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html

Returns:

(Array<String>)

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

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

#placement_fallback_strategy ⇒ `String`

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.