Container for the parameters to the RegisterGameServer operation. This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.
Once a game server is successfully registered, it is put in status AVAILABLE.
A request to register a game server may fail if the instance it is running on is in
the process of shutting down as part of instance balancing or scale-down activity.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.RegisterGameServerRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class RegisterGameServerRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The RegisterGameServerRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
RegisterGameServerRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ConnectionInfo | System.String |
Gets and sets the property ConnectionInfo. Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information. |
|
|
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 register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account. |
|
|
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: |
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