Module Values.GameSessionConnectionInfoSource

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.

Sourcetype nonrec t = {
  1. gameSessionArn : ArnStringModel.t option;
    (*

    An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string>.

    *)
  2. ipAddress : IpAddress.t option;
    (*

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

    *)
  3. dnsName : DnsName.t option;
    (*

    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.

    *)
  4. port : PositiveInteger.t option;
    (*

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

    *)
  5. matchedPlayerSessions : MatchedPlayerSessionList.t option;
    (*

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

    *)
  6. playerGatewayStatus : PlayerGatewayStatus.t option;
    (*

    The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations. Possible values include: ENABLED -- Player gateway is available for this game session. DISABLED -- Player gateway is not available for this game session.

    *)
}
Sourceval make : ?gameSessionArn:??? -> ?ipAddress:??? -> ?dnsName:??? -> ?port:??? -> ?matchedPlayerSessions:??? -> ?playerGatewayStatus:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of PositiveInteger.t | `List of [> `Structure of (string * [> `String of PlayerId.t ]) list ] list | `String of ArnStringModel.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t