Skip to content
AWS for Query.Farm

aws.gamelift.describe_game_server_group

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_game_server_group
WHERE
"game_server_group_name" = 'VALUE';

Description

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Table Definition

Column NameColumn Data Type
game_server_group_name Required Input Column

A unique identifier for the game server group. Use either the name or ARN value.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
game_server_group

An object with the property settings for the requested game server group resource. 

STRUCT(
    "game_server_group_name" VARCHAR,
    "game_server_group_arn" VARCHAR,
    "role_arn" VARCHAR,
    "instance_definitions" STRUCT(
        "instance_type" VARCHAR,
        "weighted_capacity" VARCHAR
    )[],
    "balancing_strategy" VARCHAR,
    "game_server_protection_policy" VARCHAR,
    "auto_scaling_group_arn" VARCHAR,
    "status" VARCHAR,
    "status_reason" VARCHAR,
    "suspended_actions" VARCHAR[],
    "creation_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S
)
Show child fields
game_server_group.auto_scaling_group_arn

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

game_server_group.balancing_strategy

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

game_server_group.creation_time

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

game_server_group.game_server_group_arn

A generated unique ID for the game server group.

game_server_group.game_server_group_name

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

game_server_group.game_server_protection_policy

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.

game_server_group.instance_definitions[]
Show child fields
game_server_group.instance_definitions[].instance_type

An Amazon EC2 instance type designation.

game_server_group.instance_definitions[].weighted_capacity

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon 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 Elastic Compute Cloud Auto Scaling User Guide. Default value is "1".

game_server_group.last_updated_time

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

game_server_group.role_arn

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

game_server_group.status

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

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

  • ACTIVATING - Amazon GameLift 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 FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon GameLift 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.

game_server_group.status_reason

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

game_server_group.suspended_actions[]