Struct aws_sdk_gamelift::input::StartGameSessionPlacementInput

#[non_exhaustive]
pub struct StartGameSessionPlacementInput {
    pub placement_id: Option<String>,
    pub game_session_queue_name: Option<String>,
    pub game_properties: Option<Vec<GameProperty>>,
    pub maximum_player_session_count: Option<i32>,
    pub game_session_name: Option<String>,
    pub player_latencies: Option<Vec<PlayerLatency>>,
    pub desired_player_sessions: Option<Vec<DesiredPlayerSession>>,
    pub game_session_data: Option<String>,
}

Represents the input for a request operation.

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_id: Option<String>

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.

game_session_queue_name: Option<String>

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

game_properties: Option<Vec<GameProperty>>

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

maximum_player_session_count: Option<i32>

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

game_session_name: Option<String>

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

player_latencies: Option<Vec<PlayerLatency>>

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.

desired_player_sessions: Option<Vec<DesiredPlayerSession>>

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

game_session_data: Option<String>

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

Implementations

impl StartGameSessionPlacementInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StartGameSessionPlacement, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartGameSessionPlacement>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartGameSessionPlacementInput

impl StartGameSessionPlacementInput

pub fn placement_id(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&[GameProperty]>

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) -> Option<i32>

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

pub fn game_session_name(&self) -> Option<&str>

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

pub fn player_latencies(&self) -> Option<&[PlayerLatency]>

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) -> Option<&[DesiredPlayerSession]>

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

pub fn game_session_data(&self) -> Option<&str>

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

Trait Implementations

impl Clone for StartGameSessionPlacementInput

fn clone(&self) -> StartGameSessionPlacementInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartGameSessionPlacementInput

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

Formats the value using the given formatter.

impl PartialEq<StartGameSessionPlacementInput> for StartGameSessionPlacementInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartGameSessionPlacementInput