Struct PriorityConfigurationOverride 

#[non_exhaustive]
pub struct PriorityConfigurationOverride {
    pub placement_fallback_strategy: Option<PlacementFallbackStrategy>,
    pub location_order: Option<Vec<String>>,
}

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.

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 Servers won't attempt to place a game session there.

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.

placement_fallback_strategy: Option<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.

location_order: Option<Vec<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 Servers service locations.

Implementations

impl PriorityConfigurationOverride

pub fn placement_fallback_strategy(&self) -> Option<&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.

pub fn location_order(&self) -> &[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 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 PriorityConfigurationOverride

pub fn builder() -> PriorityConfigurationOverrideBuilder

Creates a new builder-style object to manufacture PriorityConfigurationOverride.

Trait Implementations

impl Clone for PriorityConfigurationOverride

fn clone(&self) -> PriorityConfigurationOverride

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PriorityConfigurationOverride

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

Formats the value using the given formatter.

impl PartialEq for PriorityConfigurationOverride

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

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

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 PriorityConfigurationOverride