AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::GameSessionQueue Class Reference

#include <GameSessionQueue.h>

Public Member Functions

 GameSessionQueue ()
 
 GameSessionQueue (Aws::Utils::Json::JsonView jsonValue)
 
GameSessionQueueoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GameSessionQueueWithName (const Aws::String &value)
 
GameSessionQueueWithName (Aws::String &&value)
 
GameSessionQueueWithName (const char *value)
 
const Aws::StringGetGameSessionQueueArn () const
 
bool GameSessionQueueArnHasBeenSet () const
 
void SetGameSessionQueueArn (const Aws::String &value)
 
void SetGameSessionQueueArn (Aws::String &&value)
 
void SetGameSessionQueueArn (const char *value)
 
GameSessionQueueWithGameSessionQueueArn (const Aws::String &value)
 
GameSessionQueueWithGameSessionQueueArn (Aws::String &&value)
 
GameSessionQueueWithGameSessionQueueArn (const char *value)
 
int GetTimeoutInSeconds () const
 
bool TimeoutInSecondsHasBeenSet () const
 
void SetTimeoutInSeconds (int value)
 
GameSessionQueueWithTimeoutInSeconds (int value)
 
const Aws::Vector< PlayerLatencyPolicy > & GetPlayerLatencyPolicies () const
 
bool PlayerLatencyPoliciesHasBeenSet () const
 
void SetPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
void SetPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
GameSessionQueueWithPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
 
GameSessionQueueWithPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
 
GameSessionQueueAddPlayerLatencyPolicies (const PlayerLatencyPolicy &value)
 
GameSessionQueueAddPlayerLatencyPolicies (PlayerLatencyPolicy &&value)
 
const Aws::Vector< GameSessionQueueDestination > & GetDestinations () const
 
bool DestinationsHasBeenSet () const
 
void SetDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
void SetDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
GameSessionQueueWithDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
 
GameSessionQueueWithDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
 
GameSessionQueueAddDestinations (const GameSessionQueueDestination &value)
 
GameSessionQueueAddDestinations (GameSessionQueueDestination &&value)
 
const FilterConfigurationGetFilterConfiguration () const
 
bool FilterConfigurationHasBeenSet () const
 
void SetFilterConfiguration (const FilterConfiguration &value)
 
void SetFilterConfiguration (FilterConfiguration &&value)
 
GameSessionQueueWithFilterConfiguration (const FilterConfiguration &value)
 
GameSessionQueueWithFilterConfiguration (FilterConfiguration &&value)
 
const PriorityConfigurationGetPriorityConfiguration () const
 
bool PriorityConfigurationHasBeenSet () const
 
void SetPriorityConfiguration (const PriorityConfiguration &value)
 
void SetPriorityConfiguration (PriorityConfiguration &&value)
 
GameSessionQueueWithPriorityConfiguration (const PriorityConfiguration &value)
 
GameSessionQueueWithPriorityConfiguration (PriorityConfiguration &&value)
 
const Aws::StringGetCustomEventData () const
 
bool CustomEventDataHasBeenSet () const
 
void SetCustomEventData (const Aws::String &value)
 
void SetCustomEventData (Aws::String &&value)
 
void SetCustomEventData (const char *value)
 
GameSessionQueueWithCustomEventData (const Aws::String &value)
 
GameSessionQueueWithCustomEventData (Aws::String &&value)
 
GameSessionQueueWithCustomEventData (const char *value)
 
const Aws::StringGetNotificationTarget () const
 
bool NotificationTargetHasBeenSet () const
 
void SetNotificationTarget (const Aws::String &value)
 
void SetNotificationTarget (Aws::String &&value)
 
void SetNotificationTarget (const char *value)
 
GameSessionQueueWithNotificationTarget (const Aws::String &value)
 
GameSessionQueueWithNotificationTarget (Aws::String &&value)
 
GameSessionQueueWithNotificationTarget (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 40 of file GameSessionQueue.h.

Constructor & Destructor Documentation

◆ GameSessionQueue() [1/2]

Aws::GameLift::Model::GameSessionQueue::GameSessionQueue ( )

◆ GameSessionQueue() [2/2]

Aws::GameLift::Model::GameSessionQueue::GameSessionQueue ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDestinations() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::AddDestinations ( const GameSessionQueueDestination value)
inline

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.

Definition at line 351 of file GameSessionQueue.h.

◆ AddDestinations() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::AddDestinations ( GameSessionQueueDestination &&  value)
inline

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.

Definition at line 359 of file GameSessionQueue.h.

◆ AddPlayerLatencyPolicies() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::AddPlayerLatencyPolicies ( const PlayerLatencyPolicy value)
inline

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.

Definition at line 284 of file GameSessionQueue.h.

◆ AddPlayerLatencyPolicies() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::AddPlayerLatencyPolicies ( PlayerLatencyPolicy &&  value)
inline

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.

Definition at line 294 of file GameSessionQueue.h.

◆ CustomEventDataHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::CustomEventDataHasBeenSet ( ) const
inline

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

Definition at line 470 of file GameSessionQueue.h.

◆ DestinationsHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::DestinationsHasBeenSet ( ) const
inline

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.

Definition at line 311 of file GameSessionQueue.h.

◆ FilterConfigurationHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::FilterConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 376 of file GameSessionQueue.h.

◆ GameSessionQueueArnHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::GameSessionQueueArnHasBeenSet ( ) const
inline

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.

Definition at line 118 of file GameSessionQueue.h.

◆ GetCustomEventData()

const Aws::String& Aws::GameLift::Model::GameSessionQueue::GetCustomEventData ( ) const
inline

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

Definition at line 464 of file GameSessionQueue.h.

◆ GetDestinations()

const Aws::Vector<GameSessionQueueDestination>& Aws::GameLift::Model::GameSessionQueue::GetDestinations ( ) const
inline

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.

Definition at line 303 of file GameSessionQueue.h.

◆ GetFilterConfiguration()

const FilterConfiguration& Aws::GameLift::Model::GameSessionQueue::GetFilterConfiguration ( ) const
inline

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.

Definition at line 368 of file GameSessionQueue.h.

◆ GetGameSessionQueueArn()

const Aws::String& Aws::GameLift::Model::GameSessionQueue::GetGameSessionQueueArn ( ) const
inline

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.

Definition at line 107 of file GameSessionQueue.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::GameSessionQueue::GetName ( ) const
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 53 of file GameSessionQueue.h.

◆ GetNotificationTarget()

const Aws::String& Aws::GameLift::Model::GameSessionQueue::GetNotificationTarget ( ) const
inline

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

Definition at line 515 of file GameSessionQueue.h.

◆ GetPlayerLatencyPolicies()

const Aws::Vector<PlayerLatencyPolicy>& Aws::GameLift::Model::GameSessionQueue::GetPlayerLatencyPolicies ( ) const
inline

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.

Definition at line 224 of file GameSessionQueue.h.

◆ GetPriorityConfiguration()

const PriorityConfiguration& Aws::GameLift::Model::GameSessionQueue::GetPriorityConfiguration ( ) const
inline

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.

Definition at line 417 of file GameSessionQueue.h.

◆ GetTimeoutInSeconds()

int Aws::GameLift::Model::GameSessionQueue::GetTimeoutInSeconds ( ) const
inline

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.

Definition at line 192 of file GameSessionQueue.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::GameSessionQueue::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::NameHasBeenSet ( ) const
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 59 of file GameSessionQueue.h.

◆ NotificationTargetHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::NotificationTargetHasBeenSet ( ) const
inline

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

Definition at line 523 of file GameSessionQueue.h.

◆ operator=()

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PlayerLatencyPoliciesHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::PlayerLatencyPoliciesHasBeenSet ( ) const
inline

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.

Definition at line 234 of file GameSessionQueue.h.

◆ PriorityConfigurationHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::PriorityConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 425 of file GameSessionQueue.h.

◆ SetCustomEventData() [1/3]

void Aws::GameLift::Model::GameSessionQueue::SetCustomEventData ( Aws::String &&  value)
inline

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

Definition at line 482 of file GameSessionQueue.h.

◆ SetCustomEventData() [2/3]

void Aws::GameLift::Model::GameSessionQueue::SetCustomEventData ( const Aws::String value)
inline

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

Definition at line 476 of file GameSessionQueue.h.

◆ SetCustomEventData() [3/3]

void Aws::GameLift::Model::GameSessionQueue::SetCustomEventData ( const char *  value)
inline

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

Definition at line 488 of file GameSessionQueue.h.

◆ SetDestinations() [1/2]

void Aws::GameLift::Model::GameSessionQueue::SetDestinations ( Aws::Vector< GameSessionQueueDestination > &&  value)
inline

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.

Definition at line 327 of file GameSessionQueue.h.

◆ SetDestinations() [2/2]

void Aws::GameLift::Model::GameSessionQueue::SetDestinations ( const Aws::Vector< GameSessionQueueDestination > &  value)
inline

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.

Definition at line 319 of file GameSessionQueue.h.

◆ SetFilterConfiguration() [1/2]

void Aws::GameLift::Model::GameSessionQueue::SetFilterConfiguration ( const FilterConfiguration value)
inline

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.

Definition at line 384 of file GameSessionQueue.h.

◆ SetFilterConfiguration() [2/2]

void Aws::GameLift::Model::GameSessionQueue::SetFilterConfiguration ( FilterConfiguration &&  value)
inline

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.

Definition at line 392 of file GameSessionQueue.h.

◆ SetGameSessionQueueArn() [1/3]

void Aws::GameLift::Model::GameSessionQueue::SetGameSessionQueueArn ( Aws::String &&  value)
inline

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.

Definition at line 140 of file GameSessionQueue.h.

◆ SetGameSessionQueueArn() [2/3]

void Aws::GameLift::Model::GameSessionQueue::SetGameSessionQueueArn ( const Aws::String value)
inline

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.

Definition at line 129 of file GameSessionQueue.h.

◆ SetGameSessionQueueArn() [3/3]

void Aws::GameLift::Model::GameSessionQueue::SetGameSessionQueueArn ( const char *  value)
inline

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.

Definition at line 151 of file GameSessionQueue.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::GameSessionQueue::SetName ( Aws::String &&  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 71 of file GameSessionQueue.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::GameSessionQueue::SetName ( const Aws::String value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 65 of file GameSessionQueue.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::GameSessionQueue::SetName ( const char *  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 77 of file GameSessionQueue.h.

◆ SetNotificationTarget() [1/3]

void Aws::GameLift::Model::GameSessionQueue::SetNotificationTarget ( Aws::String &&  value)
inline

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

Definition at line 539 of file GameSessionQueue.h.

◆ SetNotificationTarget() [2/3]

void Aws::GameLift::Model::GameSessionQueue::SetNotificationTarget ( const Aws::String value)
inline

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

Definition at line 531 of file GameSessionQueue.h.

◆ SetNotificationTarget() [3/3]

void Aws::GameLift::Model::GameSessionQueue::SetNotificationTarget ( const char *  value)
inline

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

Definition at line 547 of file GameSessionQueue.h.

◆ SetPlayerLatencyPolicies() [1/2]

void Aws::GameLift::Model::GameSessionQueue::SetPlayerLatencyPolicies ( Aws::Vector< PlayerLatencyPolicy > &&  value)
inline

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.

Definition at line 254 of file GameSessionQueue.h.

◆ SetPlayerLatencyPolicies() [2/2]

void Aws::GameLift::Model::GameSessionQueue::SetPlayerLatencyPolicies ( const Aws::Vector< PlayerLatencyPolicy > &  value)
inline

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.

Definition at line 244 of file GameSessionQueue.h.

◆ SetPriorityConfiguration() [1/2]

void Aws::GameLift::Model::GameSessionQueue::SetPriorityConfiguration ( const PriorityConfiguration value)
inline

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.

Definition at line 433 of file GameSessionQueue.h.

◆ SetPriorityConfiguration() [2/2]

void Aws::GameLift::Model::GameSessionQueue::SetPriorityConfiguration ( PriorityConfiguration &&  value)
inline

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.

Definition at line 441 of file GameSessionQueue.h.

◆ SetTimeoutInSeconds()

void Aws::GameLift::Model::GameSessionQueue::SetTimeoutInSeconds ( int  value)
inline

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.

Definition at line 206 of file GameSessionQueue.h.

◆ TimeoutInSecondsHasBeenSet()

bool Aws::GameLift::Model::GameSessionQueue::TimeoutInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 199 of file GameSessionQueue.h.

◆ WithCustomEventData() [1/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithCustomEventData ( Aws::String &&  value)
inline

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

Definition at line 500 of file GameSessionQueue.h.

◆ WithCustomEventData() [2/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithCustomEventData ( const Aws::String value)
inline

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

Definition at line 494 of file GameSessionQueue.h.

◆ WithCustomEventData() [3/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithCustomEventData ( const char *  value)
inline

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

Definition at line 506 of file GameSessionQueue.h.

◆ WithDestinations() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithDestinations ( Aws::Vector< GameSessionQueueDestination > &&  value)
inline

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.

Definition at line 343 of file GameSessionQueue.h.

◆ WithDestinations() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithDestinations ( const Aws::Vector< GameSessionQueueDestination > &  value)
inline

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.

Definition at line 335 of file GameSessionQueue.h.

◆ WithFilterConfiguration() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithFilterConfiguration ( const FilterConfiguration value)
inline

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.

Definition at line 400 of file GameSessionQueue.h.

◆ WithFilterConfiguration() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithFilterConfiguration ( FilterConfiguration &&  value)
inline

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.

Definition at line 408 of file GameSessionQueue.h.

◆ WithGameSessionQueueArn() [1/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithGameSessionQueueArn ( Aws::String &&  value)
inline

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.

Definition at line 173 of file GameSessionQueue.h.

◆ WithGameSessionQueueArn() [2/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithGameSessionQueueArn ( const Aws::String value)
inline

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.

Definition at line 162 of file GameSessionQueue.h.

◆ WithGameSessionQueueArn() [3/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithGameSessionQueueArn ( const char *  value)
inline

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.

Definition at line 184 of file GameSessionQueue.h.

◆ WithName() [1/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithName ( Aws::String &&  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 89 of file GameSessionQueue.h.

◆ WithName() [2/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithName ( const Aws::String value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 83 of file GameSessionQueue.h.

◆ WithName() [3/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithName ( const char *  value)
inline

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Definition at line 95 of file GameSessionQueue.h.

◆ WithNotificationTarget() [1/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithNotificationTarget ( Aws::String &&  value)
inline

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

Definition at line 563 of file GameSessionQueue.h.

◆ WithNotificationTarget() [2/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithNotificationTarget ( const Aws::String value)
inline

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

Definition at line 555 of file GameSessionQueue.h.

◆ WithNotificationTarget() [3/3]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithNotificationTarget ( const char *  value)
inline

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

Definition at line 571 of file GameSessionQueue.h.

◆ WithPlayerLatencyPolicies() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithPlayerLatencyPolicies ( Aws::Vector< PlayerLatencyPolicy > &&  value)
inline

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.

Definition at line 274 of file GameSessionQueue.h.

◆ WithPlayerLatencyPolicies() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithPlayerLatencyPolicies ( const Aws::Vector< PlayerLatencyPolicy > &  value)
inline

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.

Definition at line 264 of file GameSessionQueue.h.

◆ WithPriorityConfiguration() [1/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithPriorityConfiguration ( const PriorityConfiguration value)
inline

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.

Definition at line 449 of file GameSessionQueue.h.

◆ WithPriorityConfiguration() [2/2]

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithPriorityConfiguration ( PriorityConfiguration &&  value)
inline

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.

Definition at line 457 of file GameSessionQueue.h.

◆ WithTimeoutInSeconds()

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::WithTimeoutInSeconds ( int  value)
inline

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.

Definition at line 213 of file GameSessionQueue.h.


The documentation for this class was generated from the following file: