AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

Game-session-related operations include:

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameSession

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class GameSession

The GameSession type exposes the following members

Constructors

NameDescription
Public Method GameSession()

Properties

NameTypeDescription
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

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

Public Property CreatorId System.String

Gets and sets the property CreatorId.

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.

Public Property CurrentPlayerSessionCount System.Int32

Gets and sets the property CurrentPlayerSessionCount.

Number of players currently in the game session.

Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet that the game session is running on.

Public Property GameProperties System.Collections.Generic.List<Amazon.GameLift.Model.GameProperty>

Gets and sets the property GameProperties.

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Public Property GameSessionData System.String

Gets and sets the property GameSessionData.

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Public Property GameSessionId System.String

Gets and sets the property GameSessionId.

Unique identifier for the game session. A game session ARN has the following format:

arn:aws:gamelift:::gamesession//
.

Public Property IpAddress System.String

Gets and sets the property IpAddress.

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

Public Property MaximumPlayerSessionCount System.Int32

Gets and sets the property MaximumPlayerSessionCount.

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

Public Property Name System.String

Gets and sets the property Name.

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

Public Property PlayerSessionCreationPolicy Amazon.GameLift.PlayerSessionCreationPolicy

Gets and sets the property PlayerSessionCreationPolicy.

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

Public Property Port System.Int32

Gets and sets the property Port.

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

Public Property Status Amazon.GameLift.GameSessionStatus

Gets and sets the property Status.

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

Public Property TerminationTime System.DateTime

Gets and sets the property TerminationTime.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms