Class: Aws::GameLift::Types::GameSessionQueue

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::GameSessionQueue

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

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.

Queue-related operations include:

• CreateGameSessionQueue

• DescribeGameSessionQueues

• UpdateGameSessionQueue

• DeleteGameSessionQueue

See Also:

• AWS API Documentation

Instance Attribute Summary

• #destinations ⇒ Array<Types::GameSessionQueueDestination>

  List of fleets that can be used to fulfill game session placement requests in the queue.

• #game_session_queue_arn ⇒ String

  Amazon Resource Name ([ARN]) that is assigned to a game session queue and uniquely identifies it.

• #name ⇒ String

  Descriptive label that is associated with game session queue.

• #player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

  Collection of latency policies to apply when processing game sessions placement requests with player latency information.

• #timeout_in_seconds ⇒ Integer

  Maximum time, in seconds, that a new game session placement request remains in the queue.

Instance Attribute Details

#destinations ⇒ Array<Types::GameSessionQueueDestination>

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.

Returns:

• (Array<Types::GameSessionQueueDestination>)

# File 'lib/aws-sdk-gamelift/types.rb', line 3693

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#game_session_queue_arn ⇒ String

Amazon Resource Name ([ARN]) that is assigned to a game session queue and uniquely identifies it. Format is ‘arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 3693

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 3693

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

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.

Returns:

• (Array<Types::PlayerLatencyPolicy>)

# File 'lib/aws-sdk-gamelift/types.rb', line 3693

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#timeout_in_seconds ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 3693

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end