ReplicaContainerGroupCounts
This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
The number and status of replica container groups that are deployed across a fleet with
compute type CONTAINER. This information, combined with the number of server
processes being hosted per container group (see RuntimeConfiguration), tells you
how many game sessions the fleet is currently capable of hosting concurrently.
Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity
Contents
Note
In the following list, the required parameters are described first.
- ACTIVE
-
The number of container groups that have active game sessions.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- IDLE
-
The number of container groups that have no active game sessions.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- PENDING
-
The number of container groups that are starting up but have not yet registered.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- TERMINATING
-
The number of container groups that are in the process of shutting down.
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: