Builder

class Builder

Properties

Link copied to clipboard

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

Link copied to clipboard

Time stamp indicating when this request was completed, canceled, or timed out.

Link copied to clipboard

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

Link copied to clipboard

Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is FULFILLED.

Link copied to clipboard

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session.

Link copied to clipboard

A unique identifier for the game session. This value isn't final until placement status is FULFILLED.

Link copied to clipboard

A descriptive label that is associated with a game session. Session names do not need to be unique.

Link copied to clipboard

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Link copied to clipboard

Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED.

Link copied to clipboard

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. This value isn't final until placement status is FULFILLED.

Link copied to clipboard

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

Link copied to clipboard

The maximum number of players that can be connected simultaneously to the game session.

Link copied to clipboard

A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

Link copied to clipboard

A unique identifier for a game session placement.

Link copied to clipboard

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.

Link copied to clipboard
var port: Int?

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. This value isn't final until placement status is FULFILLED.

Link copied to clipboard

An alternative priority list of locations that's included with a game session placement request. When provided, the list overrides a queue's location order list for this game session placement request only. The list might include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). The fallback strategy tells Amazon GameLift Servers what action to take (if any) in the event that it failed to place a new game session.

Link copied to clipboard

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Link copied to clipboard

Current status of the game session placement request.