Skip to content

DeleteGameServerGroupInput

Source code in docs_src/capo_gamelift/types/delete_game_server_group_input.py 
12
13
14
15
16
17
18
19
20
class DeleteGameServerGroupInput(TypedDict, closed=True):
    game_server_group_name: NotRequired[
        "capo_gamelift.types.game_server_group_name_or_arn.GameServerGroupNameOrArn"
    ]
    """<p>A unique identifier for the game server group. Use either the name or ARN value.</p>"""
    delete_option: NotRequired[
        "capo_gamelift.types.game_server_group_delete_option.GameServerGroupDeleteOption"
    ]
    """<p>The type of delete to perform. Options include the following:</p> <ul> <li> <p> <code>SAFE_DELETE</code> – (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> – 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> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li> </ul>"""

delete_option instance-attribute 

delete_option: NotRequired[GameServerGroupDeleteOption]

The type of delete to perform. Options include the following:

  • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

  • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

  • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

game_server_group_name instance-attribute 

game_server_group_name: NotRequired[GameServerGroupNameOrArn]

A unique identifier for the game server group. Use either the name or ARN value.