Class PriorityConfiguration
(experimental) Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class PriorityConfiguration : Object, IPriorityConfiguration
Syntax (vb)
Public Class PriorityConfiguration
Inherits Object
Implements IPriorityConfiguration
Remarks
When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:
Changing the priority order will affect how game sessions are placed.
Stability: Experimental
ExampleMetadata: infused
Examples
BuildFleet fleet;
Topic topic;
new GameSessionQueue(this, "MyGameSessionQueue", new GameSessionQueueProps {
GameSessionQueueName = "test-gameSessionQueue",
CustomEventData = "test-event-data",
AllowedLocations = new [] { "eu-west-1", "eu-west-2" },
Destinations = new [] { fleet },
NotificationTarget = topic,
PlayerLatencyPolicies = new [] { new PlayerLatencyPolicy {
MaximumIndividualPlayerLatency = Duration.Millis(100),
PolicyDuration = Duration.Seconds(300)
} },
PriorityConfiguration = new PriorityConfiguration {
LocationOrder = new [] { "eu-west-1", "eu-west-2" },
PriorityOrder = new [] { PriorityType.LATENCY, PriorityType.COST, PriorityType.DESTINATION, PriorityType.LOCATION }
},
Timeout = Duration.Seconds(300)
});
Synopsis
Constructors
PriorityConfiguration() |
Properties
LocationOrder | (experimental) The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. |
PriorityOrder | (experimental) The recommended sequence to use when prioritizing where to place new game sessions. |
Constructors
PriorityConfiguration()
public PriorityConfiguration()
Properties
LocationOrder
(experimental) The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.
public string[] LocationOrder { get; set; }
Property Value
System.String[]
Remarks
Locations are identified by AWS Region codes such as `us-west-2.
Each location can only be listed once.
Stability: Experimental
PriorityOrder
(experimental) The recommended sequence to use when prioritizing where to place new game sessions.
public PriorityType[] PriorityOrder { get; set; }
Property Value
Remarks
Each type can only be listed once.
Stability: Experimental