Struct aws_sdk_gamelift::input::start_game_session_placement_input::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for StartGameSessionPlacementInput

Implementations

impl Builder

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

A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

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

A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

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

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

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

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

pub fn game_properties(self, input: impl Into<GameProperty>) -> Self

Appends an item to game_properties.

To override the contents of this collection use set_game_properties.

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

pub fn set_game_properties(self, input: Option<Vec<GameProperty>>) -> Self

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

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

The maximum number of players that can be connected simultaneously to the game session.

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

The maximum number of players that can be connected simultaneously to the game session.

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

A descriptive label that is associated with a game session. Session names do not need to be unique.

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

A descriptive label that is associated with a game session. Session names do not need to be unique.

pub fn player_latencies(self, input: impl Into<PlayerLatency>) -> Self

Appends an item to player_latencies.

To override the contents of this collection use set_player_latencies.

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

pub fn set_player_latencies(self, input: Option<Vec<PlayerLatency>>) -> Self

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

pub fn desired_player_sessions(
    self,
    input: impl Into<DesiredPlayerSession>
) -> Self

Appends an item to desired_player_sessions.

To override the contents of this collection use set_desired_player_sessions.

Set of information on each player to create a player session for.

pub fn set_desired_player_sessions(
    self,
    input: Option<Vec<DesiredPlayerSession>>
) -> Self

Set of information on each player to create a player session for.

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

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

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

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

pub fn build(self) -> Result<StartGameSessionPlacementInput, BuildError>

Consumes the builder and constructs a StartGameSessionPlacementInput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder