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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::GameProperty

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key ⇒ String

  The game property identifier.

• #value ⇒ String

  The game property value.

Instance Attribute Details

#key ⇒ String

The game property identifier.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 5843

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

#value ⇒ String

The game property value.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 5843

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