Module Values.RegisterGameServerInputSource

This API works with the following fleet types: EC2 (FleetIQ) Creates a new game server resource and notifies Amazon GameLift Servers FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift Servers FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session. To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity. Learn more Amazon GameLift Servers FleetIQ Guide

Sourcetype nonrec t = {
  1. gameServerGroupName : GameServerGroupNameOrArn.t;
    (*

    A unique identifier for the game server group where the game server is running.

    *)
  2. gameServerId : GameServerId.t;
    (*

    A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

    *)
  3. instanceId : GameServerInstanceId.t;
    (*

    The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

    *)
  4. connectionInfo : GameServerConnectionInfo.t option;
    (*

    Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

    *)
  5. gameServerData : GameServerData.t option;
    (*

    A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

    *)
}
Sourceval context_ : string
Sourceval make : ?connectionInfo:??? -> ?gameServerData:??? -> gameServerGroupName:GameServerGroupNameOrArn.t -> gameServerId:GameServerId.t -> instanceId:GameServerInstanceId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of GameServerGroupNameOrArn.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