You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::GameSessionPlacement

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Returns:

  • (Time)

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

#game_propertiesArray<Types::GameProperty>

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:

  • (Array<Types::GameProperty>)

    Set of developer-defined properties for a game session, formatted as a set of type:value pairs.

#game_session_arnString

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

Returns:

  • (String)

    Identifier for the game session created by this placement request.

#game_session_dataString

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

Returns:

  • (String)

    Set of developer-defined game session properties, formatted as a single string value.

#game_session_idString

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

  • (String)

    Unique identifier for the game session.

#game_session_nameString

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

Returns:

  • (String)

    Descriptive label that is associated with a game session.

#game_session_queue_nameString

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Returns:

  • (String)

    Descriptive label that is associated with game session queue.

#game_session_regionString

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

  • (String)

    Name of the region where the game session created by this placement request is running.

#ip_addressString

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

  • (String)

    IP address of the game session.

#maximum_player_session_countInteger

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

Returns:

  • (Integer)

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

#placed_player_sessionsArray<Types::PlacedPlayerSession>

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Returns:

  • (Array<Types::PlacedPlayerSession>)

    Collection of information on player sessions created in response to the game session placement request.

#placement_idString

Unique identifier for a game session placement.

Returns:

  • (String)

    Unique identifier for a game session placement.

#player_latenciesArray<Types::PlayerLatency>

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

Returns:

  • (Array<Types::PlayerLatency>)

    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

#portInteger

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

  • (Integer)

    Port number for the game session.

#start_timeTime

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\").

Returns:

  • (Time)

    Time stamp indicating when this request was placed in the queue.

#statusString

Current status of the game session placement request.

  • PENDING -- The placement request is currently in the queue waiting to be processed.

  • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

  • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

  • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

    Possible values:

    • PENDING
    • FULFILLED
    • CANCELLED
    • TIMED_OUT

Returns:

  • (String)

    Current status of the game session placement request.