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.

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:

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

Amazon GameLift FleetIQ Guide

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.UpdateGameServerRequest

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

Syntax

C#
public class UpdateGameServerRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The UpdateGameServerRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateGameServerRequest()

Properties

NameTypeDescription
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 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 to update.

Public Property 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.

Public Property 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 AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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