/AWS1/CL_GML=>DELETEGAMESERVERGROUP()
¶
About DeleteGameServerGroup¶
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
-
The game server group
-
The corresponding Auto Scaling group
-
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify
the type of delete operation to initiate. Game server groups can only be deleted if they
are in ACTIVE
or ERROR
status.
If the delete request is successful, a series of operations are kicked off. The game
server group status is changed to DELETE_SCHEDULED
, which prevents new game
servers from being registered and stops automatic scaling activity. Once all game
servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources.
If any of the delete operations fail, the game server group is placed in
ERROR
status.
Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_GAMESERVERGROUPNAME
TYPE /AWS1/GMLGAMESERVERGRNAMEORARN
/AWS1/GMLGAMESERVERGRNAMEORARN
¶
A unique identifier for the game server group. Use either the name or ARN value.
Optional arguments:¶
IV_DELETEOPTION
TYPE /AWS1/GMLGAMESERVERGRDELOPTION
/AWS1/GMLGAMESERVERGRDELOPTION
¶
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 inUTILIZED
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.