class Aws::GameLift::Types::GameSessionQueue

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.

**Related actions**

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue

@!attribute [rw] name

A descriptive label that is associated with game session queue.
Queue names must be unique within each Region.
@return [String]

@!attribute [rw] game_session_queue_arn

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

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [String]

@!attribute [rw] timeout_in_seconds

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.
@return [Integer]

@!attribute [rw] player_latency_policies

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.
@return [Array<Types::PlayerLatencyPolicy>]

@!attribute [rw] 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.
@return [Array<Types::GameSessionQueueDestination>]

@!attribute [rw] filter_configuration

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`. If this parameter is not set, game sessions can
be placed in any queue location.
@return [Types::FilterConfiguration]

@!attribute [rw] 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.
@return [Types::PriorityConfiguration]

@!attribute [rw] custom_event_data

Information that is added to all events that are related to this
game session queue.
@return [String]

@!attribute [rw] notification_target

An SNS topic ARN that is set up to receive game session placement
notifications. See [ Setting up notifications for game session
placement][1].

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionQueue AWS API Documentation

Constants

SENSITIVE