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.

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a game server group.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameServer

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

Syntax

C#
public class GameServer

The GameServer type exposes the following members

Constructors

NameDescription
Public Method GameServer()

Properties

NameTypeDescription
Public Property ClaimStatus Amazon.GameLift.GameServerClaimStatus

Gets and sets the property ClaimStatus.

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Public Property ConnectionInfo System.String

Gets and sets the property ConnectionInfo.

The port and IP address that must be used to establish a client connection to the game server.

Public Property GameServerData System.String

Gets and sets the property GameServerData.

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

Public Property GameServerGroupArn System.String

Gets and sets the property GameServerGroupArn.

The ARN identifier for the game server group where the game server is located.

Public Property GameServerGroupName System.String

Gets and sets the property GameServerGroupName.

A unique identifier for the game server group where the game server is running.

Public Property GameServerId System.String

Gets and sets the property GameServerId.

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an Amazon Web Services account.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Public Property LastClaimTime System.DateTime

Gets and sets the property LastClaimTime.

Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

Public Property LastHealthCheckTime System.DateTime

Gets and sets the property LastHealthCheckTime.

Timestamp that indicates the last time the game server was updated with health status. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Public Property RegistrationTime System.DateTime

Gets and sets the property RegistrationTime.

Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Public Property UtilizationStatus Amazon.GameLift.GameServerUtilizationStatus

Gets and sets the property UtilizationStatus.

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

  • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

  • UTILIZED - The game server is currently hosting a game session with players.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5