AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GameSessionQueueProps Struct ​

Properties for a new Fleet gameSessionQueue.

Stability
Experimental
Source
lib/game-session-queue.ts

Example ​

ts
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 ​

allowedLocationsoptionalstring[]allowed_locationsoptionaltyping.List[str]allowedLocationsoptionalList<String>AllowedLocationsoptionalstring[]AllowedLocationsoptional*[]*string#
A list of locations where a queue is allowed to place new game sessions.

Default: game sessions can be placed in any queue location

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.

customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string#
Information to be added to all events that are related to this game session queue.

Default: no customer event data

destinationsIGameSessionQueueDestination[]destinationstyping.List[IGameSessionQueueDestination]destinationsList<IGameSessionQueueDestination>DestinationsIGameSessionQueueDestination[]Destinations*[]IGameSessionQueueDestinationrequired#
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.

gameSessionQueueNamestringgame_session_queue_namestrgameSessionQueueNameStringGameSessionQueueNamestringGameSessionQueueName*stringrequired#
Name of this gameSessionQueue.
notificationTargetoptionalITopicnotification_targetoptionalITopicnotificationTargetoptionalITopicNotificationTargetoptionalITopicNotificationTargetoptionalITopic#
An SNS topic is set up to receive game session placement notifications.

Default: no notification

playerLatencyPoliciesoptionalPlayerLatencyPolicy[]player_latency_policiesoptionaltyping.List[PlayerLatencyPolicy]playerLatencyPoliciesoptionalList<PlayerLatencyPolicy>PlayerLatencyPoliciesoptionalPlayerLatencyPolicy[]PlayerLatencyPoliciesoptional*[]PlayerLatencyPolicy#
A set of policies that act as a sliding cap on player latency.

Default: no player latency policy

notes

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.

priorityConfigurationoptionalPriorityConfigurationpriority_configurationoptionalPriorityConfigurationpriorityConfigurationoptionalPriorityConfigurationPriorityConfigurationoptionalPriorityConfigurationPriorityConfigurationoptionalPriorityConfiguration#
Custom settings to use when prioritizing destinations and locations for game session placements.

Default: no priority configuration

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.

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration#
The maximum time, that a new game session placement request remains in the queue.

Default: 50 seconds

When a request exceeds this time, the game session placement changes to a TIMED_OUT status.