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

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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-gamelift/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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #key ⇒ String

  Game property identifier.

• #value ⇒ String

  Game property value.

Instance Attribute Details

#key ⇒ String

Game property identifier.

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/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)

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

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