/AWS1/CL_GML=>UPDATEGAMESERVERGROUP()¶
About UpdateGameServerGroup¶
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the
updated values. Before applying the updates, the new values are validated to ensure that
Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
GameServerGroup object is returned.
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_ROLEARN TYPE /AWS1/GMLIAMROLEARN /AWS1/GMLIAMROLEARN¶
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
IT_INSTANCEDEFINITIONS TYPE /AWS1/CL_GMLINSTANCEDEFINITION=>TT_INSTANCEDEFINITIONS TT_INSTANCEDEFINITIONS¶
An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
IV_GAMESERVERPROTECTIONPLY TYPE /AWS1/GMLGAMESERVERPROTECTIO00 /AWS1/GMLGAMESERVERPROTECTIO00¶
A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to
NO_PROTECTIONby default.
IV_BALANCINGSTRATEGY TYPE /AWS1/GMLBALANCINGSTRATEGY /AWS1/GMLBALANCINGSTRATEGY¶
Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:
SPOT_ONLY- Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.
SPOT_PREFERRED- (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.
ON_DEMAND_ONLY- Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.