GameServerGroup

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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:

Link copied to clipboard

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

Link copied to clipboard

A generated unique ID for the game server group.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: GameServerGroup.Builder.() -> Unit = {}): GameServerGroup
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String