register-game-server¶
Description¶
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This action is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift 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; when a game client or service requests a game server by calling ClaimGameServer , this information is returned in response.
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 in the process of shutting down as part of instance rebalancing or scale-down activity.
RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
register-game-server
--game-server-group-name <value>
--game-server-id <value>
--instance-id <value>
[--connection-info <value>]
[--game-server-data <value>]
[--custom-sort-key <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--game-server-group-name (string)
An identifier for the game server group where the game server is running. You can use either the GameServerGroup name or ARN value.
--game-server-id (string)
A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.
--instance-id (string)
The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.
--connection-info (string)
Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.
--game-server-data (string)
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 a game servers using ListGameServers or ClaimGameServer .
--custom-sort-key (string)
A game server tag that can be used to request sorted lists of game servers using ListGameServers . Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.
--tags (list)
A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource , UntagResource , and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
(structure)
A label that can be assigned to a GameLift resource.
TagResource
UntagResource
ListTagsForResource
Key -> (string)
The key for a developer-defined key:value pair for tagging an AWS resource.
Value -> (string)
The value for a developer-defined key:value pair for tagging an AWS resource.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
GameServer -> (structure)
Object that describes the newly created game server resource.
GameServerGroupName -> (string)
The name identifier for the game server group where the game server is located.
GameServerGroupArn -> (string)
The ARN identifier for the game server group where the game server is located.
GameServerId -> (string)
A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.
InstanceId -> (string)
The unique identifier for the instance where the game server is located.
ConnectionInfo -> (string)
The port and IP address that must be used to establish a client connection to the game server.
GameServerData -> (string)
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer . This property can be updated using UpdateGameServer .
CustomSortKey -> (string)
A game server tag that can be used to request sorted lists of game servers when calling ListGameServers . Custom sort keys are developer-defined. This property can be updated using UpdateGameServer .
ClaimStatus -> (string)
Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.
UtilizationStatus -> (string)
Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.
IN_USE - The game server is currently hosting a game session with players.
RegistrationTime -> (timestamp)
Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).
LastClaimTime -> (timestamp)
Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). This value is used to calculate when the game server’s claim status.
LastHealthCheckTime -> (timestamp)
Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). After game server registration, this property is only changed when a game server update specifies a health check value.