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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateGameSessionInput as input to an Aws::Client method, you can use a vanilla 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)

    Unique identifier for the game session to update.

#maximum_player_session_countInteger

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

Returns:

  • (Integer)

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

#nameString

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

Returns:

  • (String)

    Descriptive label that is associated with a game session.

#player_session_creation_policyString

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

Possible values:

  • ACCEPT_ALL
  • DENY_ALL

Returns:

  • (String)

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

#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.

    Possible values:

    • NoProtection
    • FullProtection

Returns:

  • (String)

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