Struct aws_sdk_gamelift::types::GameSession

#[non_exhaustive]
pub struct GameSession {

    pub game_session_id: Option<String>,
    pub name: Option<String>,
    pub fleet_id: Option<String>,
    pub fleet_arn: Option<String>,
    pub creation_time: Option<DateTime>,
    pub termination_time: Option<DateTime>,
    pub current_player_session_count: Option<i32>,
    pub maximum_player_session_count: Option<i32>,
    pub status: Option<GameSessionStatus>,
    pub status_reason: Option<GameSessionStatusReason>,
    pub game_properties: Option<Vec<GameProperty>>,
    pub ip_address: Option<String>,
    pub dns_name: Option<String>,
    pub port: Option<i32>,
    pub player_session_creation_policy: Option<PlayerSessionCreationPolicy>,
    pub creator_id: Option<String>,
    pub game_session_data: Option<String>,
    pub matchmaker_data: Option<String>,
    pub location: Option<String>,
}

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Amazon GameLift retains a game session resource for 30 days after the game session ends. You can reuse idempotency token values after this time. Game session logs are retained for 14 days.

All APIs by task

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.

game_session_id: Option<String>

A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift: ::gamesession/ / .

name: Option<String>

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

fleet_id: Option<String>

A unique identifier for the fleet that the game session is running on.

fleet_arn: Option<String>

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

creation_time: Option<DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

termination_time: Option<DateTime>

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

current_player_session_count: Option<i32>

Number of players currently in the game session.

maximum_player_session_count: Option<i32>

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

status: Option<GameSessionStatus>

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

status_reason: Option<GameSessionStatusReason>

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

game_properties: Option<Vec<GameProperty>>

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

ip_address: Option<String>

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

dns_name: Option<String>

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.

port: Option<i32>

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

player_session_creation_policy: Option<PlayerSessionCreationPolicy>

Indicates whether or not the game session is accepting new players.

creator_id: Option<String>

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

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 with a request to start a new game session (see Start a Game Session).

matchmaker_data: Option<String>

Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

location: Option<String>

The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.

Implementations

impl GameSession

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

A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift: ::gamesession/ / .

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

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

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

A unique identifier for the fleet that the game session is running on.

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

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

pub fn creation_time(&self) -> Option<&DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn termination_time(&self) -> Option<&DateTime>

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

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

Number of players currently in the 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 status(&self) -> Option<&GameSessionStatus>

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

pub fn status_reason(&self) -> Option<&GameSessionStatusReason>

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

pub fn game_properties(&self) -> &[GameProperty]

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .game_properties.is_none().

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

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

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

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

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

pub fn player_session_creation_policy( &self ) -> Option<&PlayerSessionCreationPolicy>

Indicates whether or not the game session is accepting new players.

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

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

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 with a request to start a new game session (see Start a Game Session).

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

Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

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

The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.

impl GameSession

pub fn builder() -> GameSessionBuilder

Creates a new builder-style object to manufacture GameSession.

Trait Implementations

impl Clone for GameSession

fn clone(&self) -> GameSession

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameSession

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

Formats the value using the given formatter.

impl PartialEq for GameSession

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