PlayerConnectionDetail
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.
Contents
Note
In the following list, the required parameters are described first.
- 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.
Type: Array of PlayerConnectionEndpoint objects
Required: No
- 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
"1469498468.057").This value is empty when player gateway is disabled.
Type: Timestamp
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- PlayerId
-
A unique identifier for a player associated with this connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
