Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.Types.GameSessionConnectionInfo

Description

Documentation

data GameSessionConnectionInfo Source #

Connection information for a new game session that is created in response to a start matchmaking 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 matchmaking ticket.

See: newGameSessionConnectionInfo smart constructor.

Constructors

GameSessionConnectionInfo'

Fields

dnsName :: Maybe Text
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.
gameSessionArn :: Maybe Text
A unique identifier for the game session. Use the game session ID.
ipAddress :: Maybe Text
The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
matchedPlayerSessions :: Maybe [MatchedPlayerSession]
A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
port :: Maybe Natural
The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Instances

Instances details

FromJSON GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods parseJSON :: Value -> Parser GameSessionConnectionInfo # parseJSONList :: Value -> Parser [GameSessionConnectionInfo] #
Generic GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Associated Types type Rep GameSessionConnectionInfo :: Type -> Type # Methods from :: GameSessionConnectionInfo -> Rep GameSessionConnectionInfo x # to :: Rep GameSessionConnectionInfo x -> GameSessionConnectionInfo #
Read GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods readsPrec :: Int -> ReadS GameSessionConnectionInfo # readList :: ReadS [GameSessionConnectionInfo] # readPrec :: ReadPrec GameSessionConnectionInfo # readListPrec :: ReadPrec [GameSessionConnectionInfo] #
Show GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods showsPrec :: Int -> GameSessionConnectionInfo -> ShowS # show :: GameSessionConnectionInfo -> String # showList :: [GameSessionConnectionInfo] -> ShowS #
NFData GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods rnf :: GameSessionConnectionInfo -> () #
Eq GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods (==) :: GameSessionConnectionInfo -> GameSessionConnectionInfo -> Bool # (/=) :: GameSessionConnectionInfo -> GameSessionConnectionInfo -> Bool #
Hashable GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo Methods hashWithSalt :: Int -> GameSessionConnectionInfo -> Int # hash :: GameSessionConnectionInfo -> Int #
type Rep GameSessionConnectionInfo Source #
Instance details Defined in Amazonka.GameLift.Types.GameSessionConnectionInfo type Rep GameSessionConnectionInfo = D1 ('MetaData "GameSessionConnectionInfo" "Amazonka.GameLift.Types.GameSessionConnectionInfo" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GameSessionConnectionInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gameSessionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "matchedPlayerSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MatchedPlayerSession])) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newGameSessionConnectionInfo :: GameSessionConnectionInfo Source #

Create a value of GameSessionConnectionInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dnsName:GameSessionConnectionInfo', gameSessionConnectionInfo_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.

$sel:gameSessionArn:GameSessionConnectionInfo', gameSessionConnectionInfo_gameSessionArn - A unique identifier for the game session. Use the game session ID.

$sel:ipAddress:GameSessionConnectionInfo', gameSessionConnectionInfo_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.

$sel:matchedPlayerSessions:GameSessionConnectionInfo', gameSessionConnectionInfo_matchedPlayerSessions - A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

$sel:port:GameSessionConnectionInfo', gameSessionConnectionInfo_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.

gameSessionConnectionInfo_dnsName :: Lens' GameSessionConnectionInfo (Maybe Text) Source #

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.

gameSessionConnectionInfo_gameSessionArn :: Lens' GameSessionConnectionInfo (Maybe Text) Source #

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

gameSessionConnectionInfo_ipAddress :: Lens' GameSessionConnectionInfo (Maybe Text) Source #

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

gameSessionConnectionInfo_matchedPlayerSessions :: Lens' GameSessionConnectionInfo (Maybe [MatchedPlayerSession]) Source #

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

gameSessionConnectionInfo_port :: Lens' GameSessionConnectionInfo (Maybe Natural) Source #

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