Class GameSessionQueueProps
(experimental) Properties for a new Fleet gameSessionQueue.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class GameSessionQueueProps : Object, IGameSessionQueueProps
Syntax (vb)
Public Class GameSessionQueueProps
Inherits Object
Implements IGameSessionQueueProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
BuildFleet fleet;
Alias alias;
var queue = new GameSessionQueue(this, "GameSessionQueue", new GameSessionQueueProps {
GameSessionQueueName = "my-queue-name",
Destinations = new [] { fleet }
});
queue.AddDestination(alias);
Synopsis
Constructors
GameSessionQueueProps() |
Properties
AllowedLocations | (experimental) A list of locations where a queue is allowed to place new game sessions. |
CustomEventData | (experimental) Information to be added to all events that are related to this game session queue. |
Destinations | (experimental) A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue. |
GameSessionQueueName | (experimental) Name of this gameSessionQueue. |
NotificationTarget | (experimental) An SNS topic is set up to receive game session placement notifications. |
PlayerLatencyPolicies | (experimental) A set of policies that act as a sliding cap on player latency. |
PriorityConfiguration | (experimental) Custom settings to use when prioritizing destinations and locations for game session placements. |
Timeout | (experimental) The maximum time, that a new game session placement request remains in the queue. |
Constructors
GameSessionQueueProps()
public GameSessionQueueProps()
Properties
AllowedLocations
(experimental) A list of locations where a queue is allowed to place new game sessions.
public string[] AllowedLocations { get; set; }
Property Value
System.String[]
Remarks
Locations are specified in the form of AWS Region codes, such as us-west-2
.
For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.
Default: game sessions can be placed in any queue location
Stability: Experimental
CustomEventData
(experimental) Information to be added to all events that are related to this game session queue.
public string CustomEventData { get; set; }
Property Value
System.String
Remarks
Default: no customer event data
Stability: Experimental
Destinations
(experimental) A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue.
public IGameSessionQueueDestination[] Destinations { get; set; }
Property Value
IGameSessionQueueDestination[]
Remarks
Destinations are listed in order of placement preference.
Stability: Experimental
GameSessionQueueName
(experimental) Name of this gameSessionQueue.
public string GameSessionQueueName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
NotificationTarget
(experimental) An SNS topic is set up to receive game session placement notifications.
public ITopic NotificationTarget { get; set; }
Property Value
Remarks
Default: no notification
Stability: Experimental
See: https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html
PlayerLatencyPolicies
(experimental) A set of policies that act as a sliding cap on player latency.
public IPlayerLatencyPolicy[] PlayerLatencyPolicies { get; set; }
Property Value
Remarks
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.
Default: no player latency policy
Stability: Experimental
PriorityConfiguration
(experimental) Custom settings to use when prioritizing destinations and locations for game session placements.
public IPriorityConfiguration PriorityConfiguration { get; set; }
Property Value
Remarks
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.
Default: no priority configuration
Stability: Experimental
Timeout
(experimental) The maximum time, that a new game session placement request remains in the queue.
public Duration Timeout { get; set; }
Property Value
Remarks
When a request exceeds this time, the game session placement changes to a TIMED_OUT
status.
Default: 50 seconds
Stability: Experimental