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

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

Overview

Note:

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

{
  key: "GamePropertyKey", # required
  value: "GamePropertyValue", # required
}

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the [ Amazon GameLift Developer Guide].

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

Game property identifier.

Returns:

  • (String) 


3224
3225
3226
3227
3228
 
# File 'lib/aws-sdk-gamelift/types.rb', line 3224

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

#value ⇒ String

Game property value.

Returns:

  • (String) 


3224
3225
3226
3227
3228
 
# File 'lib/aws-sdk-gamelift/types.rb', line 3224

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