Amazon GameLift · JSON Structure

Gamelift Delete Game Server Group Input Structure

DeleteGameServerGroupInput schema from Amazon GameLift API

Type: object Properties: 2 Required: 1
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

DeleteGameServerGroupInput is a JSON Structure definition published by Amazon GameLift, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

GameServerGroupName DeleteOption

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-delete-game-server-group-input-structure.json",
  "name": "DeleteGameServerGroupInput",
  "description": "DeleteGameServerGroupInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "GameServerGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerGroupNameOrArn"
        },
        {
          "description": "A unique identifier for the game server group. Use either the name or ARN value."
        }
      ]
    },
    "DeleteOption": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerGroupDeleteOption"
        },
        {
          "description": "<p>The type of delete to perform. Options include the following:</p> <ul> <li> <p> <code>SAFE_DELETE</code> \u2013 (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li> <li> <p> <code>FORCE_DELETE</code> \u2013 Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </p> </li> <li> <p> <code>RETAIN</code> \u2013 Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li> </ul>"
        }
      ]
    }
  },
  "required": [
    "GameServerGroupName"
  ]
}