UpdateGameServerGroup

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

Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Request Syntax

{
   "BalancingStrategy": "string",
   "GameServerGroupName": "string",
   "GameServerProtectionPolicy": "string",
   "InstanceDefinitions": [ 
      { 
         "InstanceType": "string",
         "WeightedCapacity": "string"
      }
   ],
   "RoleArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "GameServerGroup": { 
      "AutoScalingGroupArn": "string",
      "BalancingStrategy": "string",
      "CreationTime": number,
      "GameServerGroupArn": "string",
      "GameServerGroupName": "string",
      "GameServerProtectionPolicy": "string",
      "InstanceDefinitions": [ 
         { 
            "InstanceType": "string",
            "WeightedCapacity": "string"
         }
      ],
      "LastUpdatedTime": number,
      "RoleArn": "string",
      "Status": "string",
      "StatusReason": "string",
      "SuspendedActions": [ "string" ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Update instance definitions for the game server group

This example specifies a new set of instance definitions for the game server group. Previously, the game server group used a Spot-only balancing strategy with c3.xlarge and c4.xlarge instance types. This request removes the old instance definitions and replaces them. As shown in the response, because the new definitions do not specify WeightedCapacity, these are set to the default value of 1.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request

{
   "GameServerGroupName": "MegaFrogServers_NA",
     "InstanceDefinitions": [
        {"InstanceType": "c4.xlarge"}, 
        {"InstanceType": "c5.xlarge"}
     ]
}

CLI command:

aws gamelift update-game-server-group \
    --game-server-group MegaFrogServers_NA \
    --instance-definitions '[{"InstanceType": "c4.xlarge"}, {"InstanceType": "c5.xlarge"}]'

Sample Response

{
   "GameServerGroup": { 
      "AutoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:1111aaaa-22bb-33cc-44dd-5555eeee66ff:autoScalingGroupName/MegaFrogServers_NA",
      "BalancingStrategy": "SPOT_ONLY",
      "CreationTime": 1496365885.44,
      "GameServerGroupArn": "arn:aws:gamelift:us-west-2::GameServerGroup/MegaFrogServers_NA",
      "GameServerGroupName": " MegaFrogServers_NA",
      "GameServerProtectionPolicy": "NO_PROTECTION",
      "InstanceDefinitions": [ 
         { 
            "InstanceType": "c4.xlarge",
            "WeightedCapacity": "1"
         },
         { 
            "InstanceType": "c5.xlarge",
            "WeightedCapacity": "1"
         }
      ],
      "LastUpdatedTime": 1496365885.44,
      "RoleArn": "arn:aws:iam:123456789012::role/GameLiftGsgRole",
      "Status": "ACTIVE", 
      "StatusReason": "",
      "SuspendedActions": []
}

Change the balancing strategy for a game server group

This example changes the game server group's balancing strategy from preferring Spot instances to using On-Demand instances only. In this example scenario, the game developer wants to eliminate the possibility of game session interruptions during an upcoming highly-anticipated content launch. Later, once player demand settles, the balancing strategy can be updated again to use Spot instances for cost savings.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request

{
   "GameServerGroupName": "MegaFrogServers_NA",
      "BalancingStrategy": "ON_DEMAND_ONLY"
}

CLI command:

aws gamelift update-game-server-group \
    --game-server-group MegaFrogServers_NA \
    --balancing-strategy ON_DEMAND_ONLY

Sample Response

{
   "GameServerGroup": { 
      "AutoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:1111aaaa-22bb-33cc-44dd-5555eeee66ff:autoScalingGroupName/MegaFrogServers_NA",
      "BalancingStrategy": "ON_DEMAND_ONLY",
      "CreationTime": 1496365885.44,
      "GameServerGroupArn": "arn:aws:gamelift:us-west-2::GameServerGroup/MegaFrogServers_NA",
      "GameServerGroupName": " MegaFrogServers_NA",
      "GameServerProtectionPolicy": "FULL_PROTECTION",
      "InstanceDefinitions": [ 
         { 
            "InstanceType": "c4.xlarge",
            "WeightedCapacity": "1"
         },
         { 
            "InstanceType": "c5.xlarge",
            "WeightedCapacity": "1"
         }
      ],
      "LastUpdatedTime": 1496365885.44,
      "RoleArn": "arn:aws:iam:123456789012::role/GameLiftGsgRole",
      "Status": "ACTIVE", 
      "StatusReason": "",
      "SuspendedActions": []
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: