Container for the parameters to the GetPlayerConnectionDetails operation. This API works with the following fleet types: EC2 (server SDK 5.x or later), Container
Retrieves connection details for game clients to connect to game sessions.
Player gateway benefits: DDoS protection with negligible impact to latency.
To enable player gateway on your fleet, set PlayerGatewayMode to ENABLED
or REQUIRED when calling CreateFleet
or CreateContainerFleet.
How to use: After creating a game session and adding players, call this operation with the game session ID and player IDs. When player gateway is enabled, the response includes connection endpoints and player gateway tokens that your game clients can use to connect to the game session through player gateway. To learn more about player gateway integration, see DDoS protection with Amazon GameLift Servers player gateway.
When player gateway is disabled or in locations where player gateway is not supported, this operation returns game server connection information without player gateway tokens, so that your game clients directly connect to the game server endpoint.
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.GetPlayerConnectionDetailsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class GetPlayerConnectionDetailsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The GetPlayerConnectionDetailsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetPlayerConnectionDetailsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GameSessionId | System.String |
Gets and sets the property GameSessionId. A unique identifier for the game session for which to retrieve player connection details. |
|
|
PlayerIds | System.Collections.Generic.List<System.String> |
Gets and sets the property PlayerIds. List of unique identifiers for players. Connection details are returned for each player in this list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer