LocationState
Represents a location and its corresponding stream capacity and status.
Contents
Note
In the following list, the required parameters are described first.
- AllocatedCapacity
-
This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- AlwaysOnCapacity
-
The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- IdleCapacity
-
This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- LocationName
-
A location's name. For example,
us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
[a-zA-Z0-9-]+Required: No
- OnDemandCapacity
-
The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- RequestedCapacity
-
This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- Status
-
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
-
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. -
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. -
ERROR: Amazon GameLift Streams failed to set up this location. TheStatusReasonfield describes the error. You can remove this location and try to add it again. -
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
Type: String
Valid Values:
ACTIVATING | ACTIVE | ERROR | REMOVINGRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
