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

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

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

Overview

Note:

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

{
  game_session_id: "ArnStringModel", # required
  maximum_player_session_count: 1,
  name: "NonZeroAndMaxString",
  player_session_creation_policy: "ACCEPT_ALL", # accepts ACCEPT_ALL, DENY_ALL
  protection_policy: "NoProtection", # accepts NoProtection, FullProtection
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#game_session_idString

Unique identifier for the game session to update.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5840

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy)
  include Aws::Structure
end

#maximum_player_session_countInteger

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

Returns:

  • (Integer)


5840
5841
5842
5843
5844
5845
5846
5847
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5840

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5840

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy)
  include Aws::Structure
end

#player_session_creation_policyString

Policy determining whether or not the game session accepts new players.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5840

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy)
  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)


5840
5841
5842
5843
5844
5845
5846
5847
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5840

class UpdateGameSessionInput < Struct.new(
  :game_session_id,
  :maximum_player_session_count,
  :name,
  :player_session_creation_policy,
  :protection_policy)
  include Aws::Structure
end