Container for the parameters to the CreateGameSessionQueue operation. Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.
The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.
To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.
If successful, a new GameSessionQueue object is returned with an assigned queue
ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement
or StartMatchmaking,
reference a queue's name or ARN.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.CreateGameSessionQueueRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class CreateGameSessionQueueRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The CreateGameSessionQueueRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateGameSessionQueueRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CustomEventData | System.String |
Gets and sets the property CustomEventData. Information to be added to all events that are related to this game session queue. |
|
|
Destinations | System.Collections.Generic.List<Amazon.GameLift.Model.GameSessionQueueDestination> |
Gets and sets the property Destinations. A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. |
|
|
FilterConfiguration | Amazon.GameLift.Model.FilterConfiguration |
Gets and sets the property FilterConfiguration.
A list of locations where a queue is allowed to place new game sessions. Locations
are specified in the form of Amazon Web Services Region codes, such as |
|
|
Name | System.String |
Gets and sets the property Name. A descriptive label that is associated with game session queue. Queue names must be unique within each Region. |
|
|
NotificationTarget | System.String |
Gets and sets the property NotificationTarget. An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement. |
|
|
PlayerLatencyPolicies | System.Collections.Generic.List<Amazon.GameLift.Model.PlayerLatencyPolicy> |
Gets and sets the property PlayerLatencyPolicies. A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. |
|
|
PriorityConfiguration | Amazon.GameLift.Model.PriorityConfiguration |
Gets and sets the property PriorityConfiguration. Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. |
|
|
Tags | System.Collections.Generic.List<Amazon.GameLift.Model.Tag> |
Gets and sets the property Tags. A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. |
|
|
TimeoutInSeconds | System.Int32 |
Gets and sets the property TimeoutInSeconds.
The maximum time, in seconds, that a new game session placement request remains in
the queue. When a request exceeds this time, the game session placement changes to
a |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5