Struct aws_sdk_gamelift::types::builders::GameSessionQueueBuilder

#[non_exhaustive]
pub struct GameSessionQueueBuilder { /* private fields */ }

A builder for GameSessionQueue.

Implementations

impl GameSessionQueueBuilder

pub fn name(self, input: impl Into<String>) -> Self

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

pub fn set_name(self, input: Option<String>) -> Self

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

pub fn get_name(&self) -> &Option<String>

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

pub fn game_session_queue_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::gamesessionqueue/ . In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

pub fn set_game_session_queue_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::gamesessionqueue/ . In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

pub fn get_game_session_queue_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::gamesessionqueue/ . In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

pub fn timeout_in_seconds(self, input: i32) -> Self

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

pub fn get_timeout_in_seconds(&self) -> &Option<i32>

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

pub fn player_latency_policies(self, input: PlayerLatencyPolicy) -> Self

Appends an item to player_latency_policies.

To override the contents of this collection use set_player_latency_policies.

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

pub fn set_player_latency_policies( self, input: Option<Vec<PlayerLatencyPolicy>> ) -> Self

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

pub fn get_player_latency_policies(&self) -> &Option<Vec<PlayerLatencyPolicy>>

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

pub fn destinations(self, input: GameSessionQueueDestination) -> Self

Appends an item to destinations.

To override the contents of this collection use set_destinations.

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

pub fn set_destinations( self, input: Option<Vec<GameSessionQueueDestination>> ) -> Self

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

pub fn get_destinations(&self) -> &Option<Vec<GameSessionQueueDestination>>

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

pub fn filter_configuration(self, input: FilterConfiguration) -> Self

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

pub fn set_filter_configuration( self, input: Option<FilterConfiguration> ) -> Self

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

pub fn get_filter_configuration(&self) -> &Option<FilterConfiguration>

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

pub fn priority_configuration(self, input: PriorityConfiguration) -> Self

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

pub fn set_priority_configuration( self, input: Option<PriorityConfiguration> ) -> Self

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

pub fn get_priority_configuration(&self) -> &Option<PriorityConfiguration>

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

pub fn custom_event_data(self, input: impl Into<String>) -> Self

Information that is added to all events that are related to this game session queue.

pub fn set_custom_event_data(self, input: Option<String>) -> Self

Information that is added to all events that are related to this game session queue.

pub fn get_custom_event_data(&self) -> &Option<String>

Information that is added to all events that are related to this game session queue.

pub fn notification_target(self, input: impl Into<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn set_notification_target(self, input: Option<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn get_notification_target(&self) -> &Option<String>

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn build(self) -> GameSessionQueue

Consumes the builder and constructs a GameSessionQueue.

Trait Implementations

impl Clone for GameSessionQueueBuilder

fn clone(&self) -> GameSessionQueueBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameSessionQueueBuilder

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

Formats the value using the given formatter.

impl Default for GameSessionQueueBuilder

fn default() -> GameSessionQueueBuilder

Returns the “default value” for a type.

impl PartialEq for GameSessionQueueBuilder

fn eq(&self, other: &GameSessionQueueBuilder) -> 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 GameSessionQueueBuilder