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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#game_propertiesArray<Types::GameProperty>

A set of key-value pairs that can store custom data in a game session. For example: ‘“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].

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

Returns:



12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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_idString

A unique identifier for the game session to update.

Returns:

  • (String)


12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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_countInteger

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

Returns:

  • (Integer)


12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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

#nameString

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

Returns:

  • (String)


12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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_policyString

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

Returns:

  • (String)


12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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_policyString

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)


12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
# File 'lib/aws-sdk-gamelift/types.rb', line 12012

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