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

Class: Aws::GameLift::Types::DesiredPlayerSession

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

Overview

Note:

When passing DesiredPlayerSession as input to an Aws::Client method, you can use a vanilla Hash:

{
  player_id: "NonZeroAndMaxString",
  player_data: "PlayerData",
}

Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#player_data ⇒ String

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

  • (String) —

    Developer-defined information related to a player.

#player_id ⇒ String

A unique identifier for a player to associate with the player session.

Returns:

  • (String) —

    A unique identifier for a player to associate with the player session.