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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

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 Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #custom_event_data ⇒ String

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

• #destinations ⇒ Array<Types::GameSessionQueueDestination>

  A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

• #filter_configuration ⇒ Types::FilterConfiguration

  A list of locations where a queue is allowed to place new game sessions.

• #game_session_queue_arn ⇒ String

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

• #name ⇒ String

  A descriptive label that is associated with game session queue.

• #notification_target ⇒ String

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

• #player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

  A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

• #priority_configuration ⇒ Types::PriorityConfiguration

  Custom settings to use when prioritizing destinations and locations for game session placements.

• #timeout_in_seconds ⇒ Integer

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

Instance Attribute Details

#custom_event_data ⇒ String

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

Returns:

• (String)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::GameSessionQueueDestination>

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.

Returns:

• (Array<Types::GameSessionQueueDestination>)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#filter_configuration ⇒ Types::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.

Returns:

• (Types::FilterConfiguration)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_queue_arn ⇒ String

The Amazon Resource Name (ARN) that is assigned to a Amazon 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 Amazon GameLift game session queue ARN, the resource ID matches the Name value.

Returns:

• (String)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#notification_target ⇒ String

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

Returns:

• (String)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

Returns:

• (Array<Types::PlayerLatencyPolicy>)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#priority_configuration ⇒ Types::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.

Returns:

• (Types::PriorityConfiguration)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_seconds ⇒ Integer

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.

Returns:

• (Integer)

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

class GameSessionQueue < Struct.new(
  :name,
  :game_session_queue_arn,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target)
  SENSITIVE = []
  include Aws::Structure
end