Class: Aws::GameLift::Types::TerminateGameSessionInput

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::TerminateGameSessionInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-gamelift/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#game_session_id ⇒ String

A unique identifier for the game session to be terminated.
#termination_mode ⇒ String

The method to use to terminate the game session.

Instance Attribute Details

#game_session_id ⇒ `String`

A unique identifier for the game session to be terminated. A game session ARN has the following format: ‘arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 11122

class TerminateGameSessionInput < Struct.new(
  :game_session_id,
  :termination_mode)
  SENSITIVE = []
  include Aws::Structure
end

#termination_mode ⇒ `String`

The method to use to terminate the game session. Available methods include:

‘TRIGGER_ON_PROCESS_TERMINATE` – Sends an `OnProcessTerminate()` callback to the server process to initiate the normal game session shutdown sequence. At a minimum, the callback method must include a call to the server SDK action `ProcessEnding()`, which is how the server process signals that a game session is ending. If the server process doesn’t call ‘ProcessEnding()`, this termination method won’t be successful.
‘FORCE_TERMINATE` – Takes action to stop the server process, using existing methods to control how server processes run on an Amazon GameLift managed compute.

<note markdown=“1”> This method is not available for game sessions that are running on Anywhere fleets unless the fleet is deployed with the Amazon GameLift Agent. In this scenario, a force terminate request results in an invalid or bad request exception.
```
</note>
```