Struct aws_sdk_gamelift::model::game_session_placement::Builder

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

A builder for GameSessionPlacement

Implementations

impl Builder

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

A unique identifier for a game session placement.

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

A unique identifier for a game session placement.

pub fn game_session_queue_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_game_session_queue_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 status(self, input: GameSessionPlacementState) -> Self

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

pub fn set_status(self, input: Option<GameSessionPlacementState>) -> Self

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

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 game_session_id(self, input: impl Into<String>) -> Self

A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

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

A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

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

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.

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

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.

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

Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

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

Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

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.

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.

pub fn start_time(self, input: DateTime) -> Self

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn set_start_time(self, input: Option<DateTime>) -> Self

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn end_time(self, input: DateTime) -> Self

Time stamp indicating when this request was completed, canceled, or timed out.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

Time stamp indicating when this request was completed, canceled, or timed out.

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

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

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

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

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

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: ..amazongamelift.com.

• Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

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

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: ..amazongamelift.com.

• Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

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

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

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

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

pub fn placed_player_sessions(
    self,
    input: impl Into<PlacedPlayerSession>
) -> Self

Appends an item to placed_player_sessions.

To override the contents of this collection use set_placed_player_sessions.

A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

pub fn set_placed_player_sessions(
    self,
    input: Option<Vec<PlacedPlayerSession>>
) -> Self

A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

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 matchmaker_data(self, input: impl Into<String>) -> Self

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

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

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

pub fn build(self) -> GameSessionPlacement

Consumes the builder and constructs a GameSessionPlacement

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