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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass DesiredPlayerSession data as a hash:

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#player_dataString

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)


2530
2531
2532
2533
2534
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2530

class DesiredPlayerSession < Struct.new(
  :player_id,
  :player_data)
  include Aws::Structure
end

#player_idString

Unique identifier for a player to associate with the player session.

Returns:

  • (String)


2530
2531
2532
2533
2534
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2530

class DesiredPlayerSession < Struct.new(
  :player_id,
  :player_data)
  include Aws::Structure
end