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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/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: {"Key": "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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The game property identifier.

* Avoid using periods (".") in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.

  • If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.

Returns:

  • (String) 


6173
6174
6175
6176
6177
6178
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6173

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

#value ⇒ String

The game property value.

Returns:

  • (String) 


6173
6174
6175
6176
6177
6178
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6173

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