Connection information for a game client to connect to a game session. This object contains the IP address(es), port(s), and authentication details your game client needs to establish a connection.
With player gateway enabled: Contains relay endpoints and a player gateway token. Your game client must prepend player gateway token to each payload for validation and connection through relay endpoints.
With player gateway disabled: Contains game server endpoint. Player gateway token and expiration fields are empty.
Inheritance Hierarchy
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class PlayerConnectionDetail
The PlayerConnectionDetail type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PlayerConnectionDetail() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Endpoints | System.Collections.Generic.List<Amazon.GameLift.Model.PlayerConnectionEndpoint> |
Gets and sets the property Endpoints. List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session. When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint. |
|
|
Expiration | System.DateTime |
Gets and sets the property Expiration.
When player gateway is enabled, this is the timestamp indicating when player gateway
token expires. Your game backend should call GetPlayerConnectionDetails
to retrieve fresh connection information for your game clients before this time. Format
is a number expressed in Unix time as milliseconds (for example This value is empty when player gateway is disabled. |
|
|
PlayerGatewayToken | System.String |
Gets and sets the property PlayerGatewayToken. Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token. This value is empty when player gateway is disabled. |
|
|
PlayerId | System.String |
Gets and sets the property PlayerId. A unique identifier for a player associated with this connection. |
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