Struct PriorityConfiguration

#[non_exhaustive]
pub struct PriorityConfiguration {
    pub priority_order: Option<Vec<PriorityType>>,
    pub location_order: Option<Vec<String>>,
}

Custom prioritization settings to use with a game session queue. Prioritization settings determine how the queue selects a game hosting resource to start a new game session. This configuration replaces the default prioritization process for queues.

By default, a queue makes game session placements based on the following criteria:

• When a game session request does not include player latency data, Amazon GameLift Servers places game sessions based on the following priorities: (1) the queue's default destination order, and (2) for multi-location fleets, an alphabetic list of locations.

• When a game session request includes player latency data, Amazon GameLift Servers re-orders the queue's destinations to make placements where the average player latency is lowest. It reorders based the following priorities: (1) the lowest average latency across all players, (2) the lowest hosting cost, (3) the queue's default destination order, and (4) for multi-location fleets, an alphabetic list of locations.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

priority_order: Option<Vec<PriorityType>>

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

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

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

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

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

location_order: Option<Vec<String>>

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services 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 Servers service locations.

Implementations

impl PriorityConfiguration

pub fn priority_order(&self) -> &[PriorityType]

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

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

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

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .priority_order.is_none().

pub fn location_order(&self) -> &[String]

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services 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 Servers service locations.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .location_order.is_none().

impl PriorityConfiguration

pub fn builder() -> PriorityConfigurationBuilder

Creates a new builder-style object to manufacture PriorityConfiguration.

Trait Implementations

impl Clone for PriorityConfiguration

fn clone(&self) -> PriorityConfiguration

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PriorityConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PriorityConfiguration

fn eq(&self, other: &PriorityConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PriorityConfiguration