Aws::GameLift::Model::GameSessionQueue Class Reference

#include <GameSessionQueue.h>

Public Member Functions
	GameSessionQueue ()
	GameSessionQueue (Aws::Utils::Json::JsonView jsonValue)
GameSessionQueue &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
GameSessionQueue &	WithName (const Aws::String &value)
GameSessionQueue &	WithName (Aws::String &&value)
GameSessionQueue &	WithName (const char *value)
const Aws::String &	GetGameSessionQueueArn () const
bool	GameSessionQueueArnHasBeenSet () const
void	SetGameSessionQueueArn (const Aws::String &value)
void	SetGameSessionQueueArn (Aws::String &&value)
void	SetGameSessionQueueArn (const char *value)
GameSessionQueue &	WithGameSessionQueueArn (const Aws::String &value)
GameSessionQueue &	WithGameSessionQueueArn (Aws::String &&value)
GameSessionQueue &	WithGameSessionQueueArn (const char *value)
int	GetTimeoutInSeconds () const
bool	TimeoutInSecondsHasBeenSet () const
void	SetTimeoutInSeconds (int value)
GameSessionQueue &	WithTimeoutInSeconds (int value)
const Aws::Vector< PlayerLatencyPolicy > &	GetPlayerLatencyPolicies () const
bool	PlayerLatencyPoliciesHasBeenSet () const
void	SetPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
void	SetPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
GameSessionQueue &	WithPlayerLatencyPolicies (const Aws::Vector< PlayerLatencyPolicy > &value)
GameSessionQueue &	WithPlayerLatencyPolicies (Aws::Vector< PlayerLatencyPolicy > &&value)
GameSessionQueue &	AddPlayerLatencyPolicies (const PlayerLatencyPolicy &value)
GameSessionQueue &	AddPlayerLatencyPolicies (PlayerLatencyPolicy &&value)
const Aws::Vector< GameSessionQueueDestination > &	GetDestinations () const
bool	DestinationsHasBeenSet () const
void	SetDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
void	SetDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
GameSessionQueue &	WithDestinations (const Aws::Vector< GameSessionQueueDestination > &value)
GameSessionQueue &	WithDestinations (Aws::Vector< GameSessionQueueDestination > &&value)
GameSessionQueue &	AddDestinations (const GameSessionQueueDestination &value)
GameSessionQueue &	AddDestinations (GameSessionQueueDestination &&value)

Detailed Description

Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:

• The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.

• The length of time that placement requests can wait in the queue before timing out.

• A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.

• CreateGameSessionQueue

• DescribeGameSessionQueues

• UpdateGameSessionQueue

• DeleteGameSessionQueue

See Also:

AWS API Reference

Definition at line 58 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

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 362 of file GameSessionQueue.h.

AddDestinations() [2/2]

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 369 of file GameSessionQueue.h.

AddPlayerLatencyPolicies() [1/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 300 of file GameSessionQueue.h.

AddPlayerLatencyPolicies() [2/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 312 of file GameSessionQueue.h.

DestinationsHasBeenSet()

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 327 of file GameSessionQueue.h.

GameSessionQueueArnHasBeenSet()

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 132 of file GameSessionQueue.h.

GetDestinations()

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 320 of file GameSessionQueue.h.

GetGameSessionQueueArn()

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 123 of file GameSessionQueue.h.

GetName()

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

inline

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.

GetPlayerLatencyPolicies()

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 228 of file GameSessionQueue.h.

GetTimeoutInSeconds()

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

inline

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 194 of file GameSessionQueue.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::GameSessionQueue::Jsonize

(

)

const

NameHasBeenSet()

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

inline

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.

operator=()

GameSessionQueue& Aws::GameLift::Model::GameSessionQueue::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

PlayerLatencyPoliciesHasBeenSet()

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 240 of file GameSessionQueue.h.

SetDestinations() [1/2]

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 334 of file GameSessionQueue.h.

SetDestinations() [2/2]

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 341 of file GameSessionQueue.h.

SetGameSessionQueueArn() [1/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 141 of file GameSessionQueue.h.

SetGameSessionQueueArn() [2/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 150 of file GameSessionQueue.h.

SetGameSessionQueueArn() [3/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 159 of file GameSessionQueue.h.

SetName() [1/3]

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

inline

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.

SetName() [2/3]

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

inline

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.

SetName() [3/3]

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

inline

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.

SetPlayerLatencyPolicies() [1/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 252 of file GameSessionQueue.h.

SetPlayerLatencyPolicies() [2/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 264 of file GameSessionQueue.h.

SetTimeoutInSeconds()

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

inline

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 208 of file GameSessionQueue.h.

TimeoutInSecondsHasBeenSet()

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

inline

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 201 of file GameSessionQueue.h.

WithDestinations() [1/2]

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 348 of file GameSessionQueue.h.

WithDestinations() [2/2]

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

inline

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Definition at line 355 of file GameSessionQueue.h.

WithGameSessionQueueArn() [1/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 168 of file GameSessionQueue.h.

WithGameSessionQueueArn() [2/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 177 of file GameSessionQueue.h.

WithGameSessionQueueArn() [3/3]

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

inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

Definition at line 186 of file GameSessionQueue.h.

WithName() [1/3]

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

inline

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 101 of file GameSessionQueue.h.

WithName() [2/3]

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

inline

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 107 of file GameSessionQueue.h.

WithName() [3/3]

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

inline

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Definition at line 113 of file GameSessionQueue.h.

WithPlayerLatencyPolicies() [1/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 276 of file GameSessionQueue.h.

WithPlayerLatencyPolicies() [2/2]

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

inline

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Definition at line 288 of file GameSessionQueue.h.

WithTimeoutInSeconds()

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

inline

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 215 of file GameSessionQueue.h.

---

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

• aws-cpp-sdk-gamelift/include/aws/gamelift/model/GameSessionQueue.h