AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameSessionQueue

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class GameSessionQueue

The GameSessionQueue type exposes the following members

Constructors

NameDescription
Public Method GameSessionQueue()

Properties

NameTypeDescription
Public Property CustomEventData System.String

Gets and sets the property CustomEventData.

Information that is added to all events that are related to this game session queue.

Public Property 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.

Public Property 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 us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

Public Property GameSessionQueueArn System.String

Gets and sets the property GameSessionQueueArn.

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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 TIMED_OUT status. By default, this property is set to 600.

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