GameSessionConnectionInfo - GameLift Service

GameSessionConnectionInfo

Connection information for a new game session that is created in response to a StartMatchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket , which can be retrieved by calling DescribeMatchmaking .

Contents

Note

In the following list, the required parameters are described first.

DnsName

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Type: String

Required: No

GameSessionArn

A unique identifier for the game session. Use the game session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9:/-]+

Required: No

IpAddress

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Type: String

Required: No

MatchedPlayerSessions

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Type: Array of MatchedPlayerSession objects

Required: No

Port

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: