GameServerGroup class

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

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding 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.

Constructors

GameServerGroup({String? autoScalingGroupArn, BalancingStrategy? balancingStrategy, DateTime? creationTime, String? gameServerGroupArn, String? gameServerGroupName, GameServerProtectionPolicy? gameServerProtectionPolicy, List<InstanceDefinition>? instanceDefinitions, DateTime? lastUpdatedTime, String? roleArn, GameServerGroupStatus? status, String? statusReason, List<GameServerGroupAction>? suspendedActions})
GameServerGroup.fromJson(Map<String, dynamic> json)
factory

Properties

autoScalingGroupArn → String?
A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
final
balancingStrategy → BalancingStrategy?
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:
final
creationTime → DateTime?
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
final
gameServerGroupArn → String?
A generated unique ID for the game server group.
final
gameServerGroupName → String?
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.
final
gameServerProtectionPolicy → 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 AWS regardless of protection status.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceDefinitions → List<InstanceDefinition>?
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
final
lastUpdatedTime → DateTime?
A timestamp that indicates when this game server group was last updated.
final
roleArn → String?
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → GameServerGroupStatus?
The current status of the game server group. Possible statuses include:
final
statusReason → String?
Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.
final
suspendedActions → List<GameServerGroupAction>?
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited