Amazon GameLift server SDK (Go) reference: Data types
You can use this Amazon GameLift Go server SDK reference to help you prepare your multiplayer game for use with Amazon GameLift. For details about the integration process, see Add Amazon GameLift to your game server.
Data types
LogParameters
An object identifying files generated during a game session that you want Amazon GameLift to upload
and store after the game session ends. The game server provides
LogParameters
to Amazon GameLift as part of a ProcessParameters
object in a ProcessReady() call.
Properties |
Description |
LogPaths |
The list of directory paths to game server log files that you want Amazon GameLift to store for future access. The server process generates these files during each game session. You define file paths and names in your game server and store them in the root game build directory. The log paths must be absolute. For example, if your game build
stores game session logs in a path such as
Type:
Required: No |
ProcessParameters
An object describing the communication between a server process and Amazon GameLift. The server process provides this information to Amazon GameLift with a call to ProcessReady().
Properties |
Description |
LogParameters |
An object with directory paths to files that are generated during a game
session. Amazon GameLift copies and stores the files for future
access. Type:
Required: No |
OnHealthCheck |
The callback function that Amazon GameLift invokes to request a health status
report from the server process. Amazon GameLift calls this function every 60
seconds and waits 60 seconds for a response. The server process returns
TRUE if healthy, FALSE if not healthy. If
no response is returned, Amazon GameLift records the server process as not
healthy.Type:
Required: No |
OnProcessTerminate |
The callback function that Amazon GameLift invokes to force the server process to
shut down. After calling this function, Amazon GameLift waits 5 minutes for the
server process to shut down and respond with a ProcessEnding() call
before it shuts down the server process. Type:
Required: Yes |
OnStartGameSession |
The callback function that Amazon GameLift invokes to pass an updated game session
object to the server process. Amazon GameLift calls this function when a match
backfill request has been processed to provide updated matchmaker data.
It passes a GameSession object, a status update
(updateReason ), and the match backfill ticket
ID.Type:
Required: Yes |
OnUpdateGameSession |
The callback function that Amazon GameLift invokes to pass updated game session
information to the server process. Amazon GameLift calls this function after
processing a match backfill request to provide updated matchmaker data.
Type:
Required: No |
Port |
The port number that the server process listens on for new player
connections. The value must fall into the port range configured for any
fleet deploying this game server build. This port number is included in
game session and player session objects, which game sessions use when
connecting to a server process. Type:
Required: Yes |
UpdateGameSession
The updates to a game session object, which includes the reason that the game session was updated, and the related backfill ticket ID if backfill is being used to fill player sessions in the game session.
Properties | Description |
---|---|
GameSession | A GameSession object. The
GameSession object contains properties describing a
game session. Type:
Required: Yes |
UpdateReason | The reason that the game session is being updated. Type:
Required: Yes |
BackfillTicketId | The ID of the backfill ticket attempting to update the game
session. Type:
Required: No |
GameSession
The details of a game session.
Properties | Description |
---|---|
GameSessionId |
A unique identifier for the game session. A game session Amazon
Resource Name (ARN) has the following format:
Type:
Required: No |
Name |
A descriptive label of the game session. Type:
Required: No |
FleetId |
A unique identifier for the fleet that the game session is running on. Type:
Required: No |
MaximumPlayerSessionCount |
The maximum number of player connections to the game session. Type:
Required: No |
Port |
The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. Type:
Required: No |
IpAddress |
The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. Type:
Required: No |
GameSessionData |
A set of custom game session properties, formatted as a single string value. Type:
Required: No |
MatchmakerData |
The information about the matchmaking process that was used to create the game session, in JSON syntax, formatted as a string. In addition to the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. Type:
Required: No |
GameProperties |
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed with a request to start a new game session. Type:
Required: No |
DnsName |
The DNS identifier assigned to the instance that's running the game session. Values have the following format:
When connecting to a game session that's running on a TLS-enabled fleet, you must use the DNS name, not the IP address. Type:
Required: No |
ServerParameters
Information used to maintain the connection between an Amazon GameLift Anywhere server and the Amazon GameLift service. This information is used when launching new server processes with InitSDK(). For servers hosted on Amazon GameLift managed EC2 instances, use an empty object.
Properties | Description |
---|---|
WebSocketURL |
The Type:
Required: Yes |
ProcessID |
A unique identifier registered to the server process hosting your game. Type:
Required: Yes |
HostID |
The unique identifier of the compute resource that's hosting the new server process. The Type:
Required: Yes |
FleetID |
The unique identifier of the fleet that the compute is registered to.
For more information, see RegisterCompute. Type:
Required: Yes |
AuthToken |
The authentication token generated by Amazon GameLift that authenticates your
server to Amazon GameLift. For more information, see GetComputeAuthToken. Type:
Required: Yes |
StartMatchBackfillRequest
Information used to create a matchmaking backfill request. The game server communicates this information to Amazon GameLift in a StartMatchBackfill() call.
Properties | Description |
---|---|
GameSessionArn |
The unique game session identifier. The API operation Type:
Required: Yes |
MatchmakingConfigurationArn |
The unique identifier (in the form of an ARN) for the matchmaker to use for this request. The matchmaker ARN for the original game session is in the game session object in the matchmaker data property. For more information about matchmaker data, see Work with matchmaker data. Type:
Required: Yes |
Players |
A set of data that represents all players who are currently in the game session. The matchmaker uses this information to search for new players who are good matches for the current players. Type:
Required: Yes |
TicketId |
The unique identifier for a matchmaking or match backfill request ticket. If you don't provide a value, Amazon GameLift generates one. Use this identifier to track the match backfill ticket status or cancel the request if needed. Type:
Required: No |
Player
The object that represents a player in matchmaking. When a matchmaking request starts, a player has a player ID, attributes, and possibly latency data. Amazon GameLift adds team information after a match is made.
Properties | Description |
---|---|
LatencyInMS |
A set of values expressed in milliseconds that indicate the amount of latency that a player experiences when connected to a location. If this property is used, the player is only matched for locations listed. If a matchmaker has a rule that evaluates player latency, players must report latency to be matched. Type:
Required: No |
PlayerAttributes |
A collection of key:value pairs that contain player information for use in matchmaking. Player attribute keys must match the PlayerAttributes used in a matchmaking rule set. For more information about player attributes, see AttributeValue. Type:
Required: No |
PlayerId |
A unique identifier for a player. Type:
Required: No |
Team |
The name of the team that the player is assigned to in a match. You define the team name in the matchmaking rule set. Type:
Required: No |
DescribePlayerSessionsRequest
An object that specifies which player sessions to retrieve. The server process provides this information with a DescribePlayerSessions() call to Amazon GameLift.
Properties | Description |
---|---|
GameSessionID |
A unique game session identifier. Use this parameter to request all player sessions for the specified game session. Game session ID format is
Type:
Required: No |
PlayerSessionID |
The unique identifier for a player session. Use this parameter to request a single specific player session. Type:
Required: No |
PlayerID |
The unique identifier for a player. Use this parameter to request all player sessions for a specific player. See Generate player IDs. Type:
Required: No |
PlayerSessionStatusFilter |
The player session status to filter results on. Possible player session statuses include:
Type:
Required: No |
NextToken |
The token indicating the start of the next page of results. To specify the start of the result set, don't provide a value. If you provide a player session ID, this parameter is ignored. Type:
Required: No |
Limit |
The maximum number of results to return. If you provide a player session ID, this parameter is ignored. Type:
Required: No |
StopMatchBackfillRequest
Information used to cancel a matchmaking backfill request. The game server communicates this information to Amazon GameLift service in a StopMatchBackfill() call.
Properties | Description |
---|---|
GameSessionArn |
The unique game session identifier of the request being canceled. Type:
Required: No |
MatchmakingConfigurationArn |
The unique identifier of the matchmaker this request was sent to. Type:
Required: No |
TicketId |
The unique identifier of the backfill request ticket to be canceled. Type:
Required: No |
GetFleetRoleCredentialsRequest
The role credentials that extend limited access to your AWS resources to the game server. For more information see, Set up an IAM service role for Amazon GameLift.
Properties | Description |
---|---|
RoleArn | The ARN of the service role that extends limited access to your AWS
resources. Type:
Required: Yes |
RoleSessionName | The name of the session that describes the use of the role
credentials. Type:
Required: Yes |