Struct aws_sdk_gamelift::types::PriorityConfiguration

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

Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:

• If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.

• If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).

Changing the priority order will affect how game sessions are placed.

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

The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

• LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

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

• DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

• LOCATION -- FleetIQ 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 are identified by Amazon Web Services Region codes such as us-west-2. Each location can only be listed once.

Implementations

impl PriorityConfiguration

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

The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

• LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

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

• DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

• LOCATION -- FleetIQ 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 are identified by Amazon Web Services Region codes such as us-west-2. Each location can only be listed once.

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 copy of the value.

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PriorityConfiguration