Class: Aws::GameLift::Types::UpdateGameSessionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::UpdateGameSessionInput
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#game_properties ⇒ Array<Types::GameProperty>
A set of key-value pairs that can store custom data in a game session.
-
#game_session_id ⇒ String
A unique identifier for the game session to update.
-
#maximum_player_session_count ⇒ Integer
The maximum number of players that can be connected simultaneously to the game session.
-
#name ⇒ String
A descriptive label that is associated with a game session.
-
#player_session_creation_policy ⇒ String
A policy that determines whether the game session is accepting new players.
-
#protection_policy ⇒ String
Game session protection policy to apply to this game session only.
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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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.
9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9150 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 |