Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data GameSessionQueue = GameSessionQueue' {
- customEventData :: Maybe Text
- destinations :: Maybe [GameSessionQueueDestination]
- filterConfiguration :: Maybe FilterConfiguration
- gameSessionQueueArn :: Maybe Text
- name :: Maybe Text
- notificationTarget :: Maybe Text
- playerLatencyPolicies :: Maybe [PlayerLatencyPolicy]
- priorityConfiguration :: Maybe PriorityConfiguration
- timeoutInSeconds :: Maybe Natural
- newGameSessionQueue :: GameSessionQueue
- gameSessionQueue_customEventData :: Lens' GameSessionQueue (Maybe Text)
- gameSessionQueue_destinations :: Lens' GameSessionQueue (Maybe [GameSessionQueueDestination])
- gameSessionQueue_filterConfiguration :: Lens' GameSessionQueue (Maybe FilterConfiguration)
- gameSessionQueue_gameSessionQueueArn :: Lens' GameSessionQueue (Maybe Text)
- gameSessionQueue_name :: Lens' GameSessionQueue (Maybe Text)
- gameSessionQueue_notificationTarget :: Lens' GameSessionQueue (Maybe Text)
- gameSessionQueue_playerLatencyPolicies :: Lens' GameSessionQueue (Maybe [PlayerLatencyPolicy])
- gameSessionQueue_priorityConfiguration :: Lens' GameSessionQueue (Maybe PriorityConfiguration)
- gameSessionQueue_timeoutInSeconds :: Lens' GameSessionQueue (Maybe Natural)
Documentation
data GameSessionQueue Source #
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.
See: newGameSessionQueue
smart constructor.
GameSessionQueue' | |
|
Instances
newGameSessionQueue :: GameSessionQueue Source #
Create a value of GameSessionQueue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customEventData:GameSessionQueue'
, gameSessionQueue_customEventData
- Information that is added to all events that are related to this game
session queue.
$sel:destinations:GameSessionQueue'
, gameSessionQueue_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.
$sel:filterConfiguration:GameSessionQueue'
, gameSessionQueue_filterConfiguration
- A list of locations where a queue is allowed to place new game sessions.
Locations are specified in the form of Amazon Web Services Region codes,
such as us-west-2
. If this parameter is not set, game sessions can be
placed in any queue location.
$sel:gameSessionQueueArn:GameSessionQueue'
, gameSessionQueue_gameSessionQueueArn
- The Amazon Resource Name
(ARN)
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.
$sel:name:GameSessionQueue'
, gameSessionQueue_name
- A descriptive label that is associated with game session queue. Queue
names must be unique within each Region.
$sel:notificationTarget:GameSessionQueue'
, gameSessionQueue_notificationTarget
- An SNS topic ARN that is set up to receive game session placement
notifications. See
Setting up notifications for game session placement.
$sel:playerLatencyPolicies:GameSessionQueue'
, gameSessionQueue_playerLatencyPolicies
- 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.
$sel:priorityConfiguration:GameSessionQueue'
, gameSessionQueue_priorityConfiguration
- 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.
$sel:timeoutInSeconds:GameSessionQueue'
, gameSessionQueue_timeoutInSeconds
- 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.
gameSessionQueue_customEventData :: Lens' GameSessionQueue (Maybe Text) Source #
Information that is added to all events that are related to this game session queue.
gameSessionQueue_destinations :: Lens' GameSessionQueue (Maybe [GameSessionQueueDestination]) Source #
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.
gameSessionQueue_filterConfiguration :: Lens' GameSessionQueue (Maybe FilterConfiguration) Source #
A list of locations where a queue is allowed to place new game sessions.
Locations are specified in the form of Amazon Web Services Region codes,
such as us-west-2
. If this parameter is not set, game sessions can be
placed in any queue location.
gameSessionQueue_gameSessionQueueArn :: Lens' GameSessionQueue (Maybe Text) Source #
The Amazon Resource Name
(ARN)
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.
gameSessionQueue_name :: Lens' GameSessionQueue (Maybe Text) Source #
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
gameSessionQueue_notificationTarget :: Lens' GameSessionQueue (Maybe Text) Source #
An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
gameSessionQueue_playerLatencyPolicies :: Lens' GameSessionQueue (Maybe [PlayerLatencyPolicy]) Source #
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.
gameSessionQueue_priorityConfiguration :: Lens' GameSessionQueue (Maybe PriorityConfiguration) Source #
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.
gameSessionQueue_timeoutInSeconds :: Lens' GameSessionQueue (Maybe Natural) Source #
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.