gamelift/aws.sdk.kotlin.services.gamelift.model/PlayerSession

PlayerSession

Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.

Related actions

All APIs by task

Types

Builder

class Builder

Companion

object Companion

Properties

creationTime

val creationTime: Instant?

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

dnsName

val dnsName: String?

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

fleetArn

val fleetArn: String?

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

fleetId

val fleetId: String?

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

gameSessionId

val gameSessionId: String?

A unique identifier for the game session that the player session is connected to.

ipAddress

val ipAddress: 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.

playerData

val playerData: String?

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

playerId

val playerId: String?

A unique identifier for a player that is associated with this player session.

playerSessionId

val playerSessionId: String?

A unique identifier for a player session.

port

val port: Int?

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

status

val status: PlayerSessionStatus?

Current status of the player session.

terminationTime

val terminationTime: Instant?

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

Functions

copy

inline fun copy(block: PlayerSession.Builder.() -> Unit = {}): PlayerSession

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String