interface GameSessionQueueProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.Alpha.GameSessionQueueProps`
Go	`github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#GameSessionQueueProps`
Java	`software.amazon.awscdk.services.gamelift.alpha.GameSessionQueueProps`
Python	`aws_cdk.aws_gamelift_alpha.GameSessionQueueProps`
TypeScript (source)	`@aws-cdk/aws-gamelift-alpha` » `GameSessionQueueProps`

Properties for a new Fleet gameSessionQueue.

Example

declare const fleet: gamelift.BuildFleet;
declare const alias: gamelift.Alias;

const queue = new gamelift.GameSessionQueue(this, 'GameSessionQueue', {
  gameSessionQueueName: 'my-queue-name',
  destinations: [fleet]
});
queue.addDestination(alias);

Properties

Name	Type	Description
destinations🔹	`IGameSessionQueueDestination[]`	A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue.
gameSessionQueueName🔹	`string`	Name of this gameSessionQueue.
allowedLocations?🔹	`string[]`	A list of locations where a queue is allowed to place new game sessions.
customEventData?🔹	`string`	Information to be added to all events that are related to this game session queue.
notificationTarget?🔹	`ITopic`	An SNS topic is set up to receive game session placement notifications.
playerLatencyPolicies?🔹	`PlayerLatencyPolicy[]`	A set of policies that act as a sliding cap on player latency.
priorityConfiguration?🔹	`PriorityConfiguration`	Custom settings to use when prioritizing destinations and locations for game session placements.
timeout?🔹	`Duration`	The maximum time, that a new game session placement request remains in the queue.

destinations🔹

Type: IGameSessionQueueDestination[]

A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue.

Destinations are listed in order of placement preference.

gameSessionQueueName🔹

Type: string

Name of this gameSessionQueue.

allowedLocations?🔹

Type: string[] (optional, default: game sessions can be placed in any queue location)

A list of locations where a queue is allowed to place new game sessions.

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.

customEventData?🔹

Type: string (optional, default: no customer event data)

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

notificationTarget?🔹

Type: ITopic (optional, default: no notification)

An SNS topic is set up to receive game session placement notifications.

playerLatencyPolicies?🔹

Type: PlayerLatencyPolicy[] (optional, default: no player latency policy)

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?🔹

Type: PriorityConfiguration (optional, default: no priority configuration)

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.

timeout?🔹

Type: Duration (optional, default: 50 seconds)

The maximum time, 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.