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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_event_data ⇒ String

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

Returns:

  • (String) 


6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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:



6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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:



6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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.

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

Returns:

  • (String) 


6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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) 


6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html

Returns:

  • (String) 


6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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:



6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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:



6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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) 


6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
 
# File '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