Container for the parameters to the UpdateFleetCapacity operation. This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.
Use this operation to set these fleet capacity properties:
-
Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.
-
Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.
To update capacity for a fleet's home Region, or if the fleet has no remote locations,
omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, set the Location parameter
to the location to update. The location must be in ACTIVE status.
If successful, Amazon GameLift updates the capacity settings and returns the identifiers
for the updated fleet and/or location. If a requested change to desired capacity exceeds
the instance type's limit, the LimitExceeded exception occurs.
Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.UpdateFleetCapacityRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class UpdateFleetCapacityRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The UpdateFleetCapacityRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateFleetCapacityRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DesiredInstances | System.Int32 |
Gets and sets the property DesiredInstances. The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings. |
|
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value. |
|
|
Location | System.String |
Gets and sets the property Location.
The name of a remote location to update fleet capacity settings for, in the form of
an Amazon Web Services Region code such as |
|
|
MaxSize | System.Int32 |
Gets and sets the property MaxSize. The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1. |
|
|
MinSize | System.Int32 |
Gets and sets the property MinSize. The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5