AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This data type is used with the Amazon GameLift Servers FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameServerGroup

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class GameServerGroup

The GameServerGroup type exposes the following members

Constructors

NameDescription
Public Method GameServerGroup()

Properties

NameTypeDescription
Public Property AutoScalingGroupArn System.String

Gets and sets the property AutoScalingGroupArn.

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

Public Property BalancingStrategy Amazon.GameLift.BalancingStrategy

Gets and sets the property BalancingStrategy.

Indicates how Amazon GameLift Servers 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.

Public Property CreationTime System.Nullable<System.DateTime>

Gets and sets the property CreationTime.

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

Public Property GameServerGroupArn System.String

Gets and sets the property GameServerGroupArn.

A generated unique ID for the game server group.

Public Property GameServerGroupName System.String

Gets and sets the property GameServerGroupName.

A developer-defined identifier for the game server group. The name is unique for each Region in each Amazon Web Services account.

Public Property GameServerProtectionPolicy Amazon.GameLift.GameServerProtectionPolicy

Gets and sets the property GameServerProtectionPolicy.

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.

Public Property InstanceDefinitions System.Collections.Generic.List<Amazon.GameLift.Model.InstanceDefinition>

Gets and sets the property InstanceDefinitions.

The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property LastUpdatedTime System.Nullable<System.DateTime>

Gets and sets the property LastUpdatedTime.

A timestamp that indicates when this game server group was last updated.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.

Public Property Status Amazon.GameLift.GameServerGroupStatus

Gets and sets the property Status.

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

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

  • ACTIVATING - Amazon GameLift Servers FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

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

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

  • DELETING - Amazon GameLift Servers FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon GameLift Servers FleetIQ must first complete and release hosts before it deletes the Auto Scaling 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.

Public Property StatusReason System.String

Gets and sets the property StatusReason.

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

Public Property SuspendedActions System.Collections.Generic.List<System.String>

Gets and sets the property SuspendedActions.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer