Class: Aws::GameLift::Types::UpdateGameSessionInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#game_properties ⇒ Array<Types::GameProperty>

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

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.

Returns:



12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_id ⇒ String

A unique identifier for the game session to update.

Returns:

  • (String) 


12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_player_session_count ⇒ Integer

The maximum number of players that can be connected simultaneously to the game session.

Returns:

  • (Integer) 


12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A descriptive label that is associated with a game session. Session names do not need to be unique.

Returns:

  • (String) 


12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end

#player_session_creation_policy ⇒ String

A policy that determines whether the game session is accepting new players.

Returns:

  • (String) 


12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end

#protection_policy ⇒ String

Game session protection policy to apply to this game session only.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

  • (String) 


12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12264

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy,
  :game_properties)
  SENSITIVE = []
  include Aws::Structure
end