Class: Aws::GameLift::Types::GameProperty

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

Overview

This key-value pair can store custom data about a game session. For example, you might use a ‘GameProperty` to track a game session’s map, level of difficulty, or remaining time. The difficulty level could be specified like this: ‘“difficulty”, “Value”:“Novice”`.

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can’t delete game properties from a game session.

For examples of working with game properties, see [Create a game session with properties].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The game property identifier.

Returns:

  • (String)


5843
5844
5845
5846
5847
5848
# File 'lib/aws-sdk-gamelift/types.rb', line 5843

class GameProperty < Struct.new(
  :key,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

The game property value.

Returns:

  • (String)


5843
5844
5845
5846
5847
5848
# File 'lib/aws-sdk-gamelift/types.rb', line 5843

class GameProperty < Struct.new(
  :key,
  :value)
  SENSITIVE = []
  include Aws::Structure
end