Container for the parameters to the UpdateGameServer operation. This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
-
To update the game server's utilization status from
AVAILABLE(when the game server is available to be claimed) toUTILIZED(when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from toUTILIZEDtoAVAILABLE. -
To report health status, identify the game server and game server group and set health check to
HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. -
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.UpdateGameServerRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class UpdateGameServerRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The UpdateGameServerRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateGameServerRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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. |
|
|
GameServerGroupName | System.String |
Gets and sets the property GameServerGroupName. A unique identifier for the game server group where the game server is running. |
|
|
GameServerId | System.String |
Gets and sets the property GameServerId. A custom string that uniquely identifies the game server to update. |
|
|
HealthCheck | Amazon.GameLift.GameServerHealthCheck |
Gets and sets the property HealthCheck. Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp. |
|
|
UtilizationStatus | Amazon.GameLift.GameServerUtilizationStatus |
Gets and sets the property UtilizationStatus.
Indicates if the game server is available or is currently hosting gameplay. You can
update a game server status from |
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