[ aws . gamelift ]

suspend-game-server-group

Description

This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.

Temporarily stops activity on a game server group without terminating instances or the game server group. Activity can be restarted by calling ResumeGameServerGroup . Activities that can suspended are:

• Instance type replacement. This activity evaluates the current Spot viability of all instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot instance types (which have a higher chance of game server interruptions) and rebalances capacity across the remaining viable Spot instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity autoscaling activities continue to be active.

To suspend activity, specify a game server group ARN and the type of activity to be suspended.

Learn more

GameLift FleetIQ Guide

Related operations

• CreateGameServerGroup

• ListGameServerGroups

• DescribeGameServerGroup

• UpdateGameServerGroup

• DeleteGameServerGroup

• ResumeGameServerGroup

• SuspendGameServerGroup

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  suspend-game-server-group
--game-server-group-name <value>
--suspend-actions <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--game-server-group-name (string)

The unique identifier of the game server group to stop activity on. Use either the GameServerGroup name or ARN value.

--suspend-actions (list)

The action to suspend for this game server group.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  REPLACE_INSTANCE_TYPES

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

GameServerGroup -> (structure)

An object that describes the game server group resource, with the SuspendedActions property updated to reflect the suspended activity.

GameServerGroupName -> (string)

A developer-defined identifier for the game server group. The name is unique per Region per AWS account.

GameServerGroupArn -> (string)

A generated unique ID for the game server group.

RoleArn -> (string)

The Amazon Resource Name (ARN ) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

InstanceDefinitions -> (list)

The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling instances in the group.

(structure)

This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.

An allowed instance type for your game server group. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

InstanceType -> (string)

An EC2 instance type designation.

WeightedCapacity -> (string)

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type’s cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide . Default value is “1”.

BalancingStrategy -> (string)

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

GameServerProtectionPolicy -> (string)

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may 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 DeleteGameServerGroup ). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.

AutoScalingGroupArn -> (string)

A generated unique ID for the EC2 Auto Scaling group with is associated with this game server group.

Status -> (string)

The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an autoscaling group in your AWS account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the autoscaling group and the game server group.

• DELETED - The game server group has been successfully deleted.

• ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

StatusReason -> (string)

Additional information about the current game server group status. This information may provide additional insight on groups that in ERROR status.

SuspendedActions -> (list)

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

(string)

CreationTime -> (timestamp)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).

LastUpdatedTime -> (timestamp)

A time stamp indicating when this game server group was last updated.