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, this list overrides the

queue’s default location prioritization, as defined in the queue’s [PriorityConfiguration](gamelift/latest/apireference/API_PriorityConfiguration.html) setting (LocationOrder). This property overrides the queue’s default priority list for individual placement requests only. Use this property only with queues that have a ‘PriorityConfiguration` setting that prioritizes 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 included 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 use the override list if the first round of placement attempts fails.

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 9425

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

#placement_fallback_strategy ⇒ `String`

Instructions for how to use the override list if the first round of placement attempts fails. The first round is a failure if Amazon GameLift searches all listed locations, in all of the queue’s destinations, without finding an available hosting resource for a new game session. Valid strategies include:

‘DEFAULT_AFTER_SINGLE_PASS` – After the first round of placement attempts, discard the override list and use the queue’s default location priority list. Continue to use the queue’s default list until the placement request times out.
‘NONE` – Continue to use the override list for all rounds of placement attempts until the placement request times out.