GameSession

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Number of players currently in the game session.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val name: String?

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

Link copied to clipboard

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

Link copied to clipboard
val port: Int?

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline fun copy(block: GameSession.Builder.() -> Unit = {}): GameSession
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String