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.
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public class GameServerGroup
The GameServerGroup type exposes the following members
Name | Description | |
---|---|---|
![]() |
GameServerGroup() |
Name | Type | Description | |
---|---|---|---|
![]() |
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. |
![]() |
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:
|
![]() |
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 |
![]() |
GameServerGroupArn | System.String |
Gets and sets the property GameServerGroupArn. A generated unique ID for the game server group. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
LastUpdatedTime | System.Nullable<System.DateTime> |
Gets and sets the property LastUpdatedTime. A timestamp that indicates when this game server group was last updated. |
![]() |
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. |
![]() |
Status | Amazon.GameLift.GameServerGroupStatus |
Gets and sets the property Status. The current status of the game server group. Possible statuses include:
|
![]() |
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 |
![]() |
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. |
.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