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

Class: Aws::GameLift::Types::CreatePlayerSessionsInput

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

Overview

Note:

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

{
  game_session_id: "ArnStringModel", # required
  player_ids: ["NonZeroAndMaxString"], # required
  player_data_map: {
    "NonZeroAndMaxString" => "PlayerData",
  },
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#game_session_idString

Unique identifier for the game session to add players to.

Returns:

  • (String)

    Unique identifier for the game session to add players to.

#player_data_mapHash<String,String>

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

Returns:

  • (Hash<String,String>)

    Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.

#player_idsArray<String>

List of unique identifiers for the players to be added.

Returns:

  • (Array<String>)

    List of unique identifiers for the players to be added.