/AWS1/CL_GML=>CREATEGAMESESSIONQUEUE()¶
About CreateGameSessionQueue¶
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
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/GMLGAMESESSIONQUEUENAME /AWS1/GMLGAMESESSIONQUEUENAME¶
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Optional arguments:¶
IV_TIMEOUTINSECONDS TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER¶
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
TIMED_OUTstatus. By default, this property is set to600.
IT_PLAYERLATENCYPOLICIES TYPE /AWS1/CL_GMLPLAYERLATENCYPLY=>TT_PLAYERLATENCYPOLICYLIST TT_PLAYERLATENCYPOLICYLIST¶
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.
IT_DESTINATIONS TYPE /AWS1/CL_GMLGAMESESSQUEUEDST=>TT_GAMESESSIONQUEUEDSTLIST TT_GAMESESSIONQUEUEDSTLIST¶
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.
IO_FILTERCONFIGURATION TYPE REF TO /AWS1/CL_GMLFILTERCONF /AWS1/CL_GMLFILTERCONF¶
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
us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
IO_PRIORITYCONFIGURATION TYPE REF TO /AWS1/CL_GMLPRIORITYCONF /AWS1/CL_GMLPRIORITYCONF¶
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.
IV_CUSTOMEVENTDATA TYPE /AWS1/GMLQUEUECUSTOMEVENTDATA /AWS1/GMLQUEUECUSTOMEVENTDATA¶
Information to be added to all events that are related to this game session queue.
IV_NOTIFICATIONTARGET TYPE /AWS1/GMLQUEUESNSARNSTRMODEL /AWS1/GMLQUEUESNSARNSTRMODEL¶
An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
IT_TAGS TYPE /AWS1/CL_GMLTAG=>TT_TAGLIST TT_TAGLIST¶
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.