EC2InstanceCounts - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

EC2InstanceCounts

Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.

Contents

Note

In the following list, the required parameters are described first.

ACTIVE

Actual number of instances that are ready to host game sessions.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

DESIRED

Requested number of active instances. Amazon GameLift takes action as needed to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. A change in the desired instances value can take up to 1 minute to be reflected when viewing a fleet's capacity settings.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

IDLE

Number of active instances that are not currently hosting a game session.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

MAXIMUM

The maximum instance count value allowed.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

MINIMUM

The minimum instance count value allowed.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

PENDING

Number of instances that are starting but not yet active.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

TERMINATING

Number of instances that are no longer active but haven't yet been terminated.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

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