Class: Aws::GameLift::Types::UpdateGameSessionQueueInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::UpdateGameSessionQueueInput
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#custom_event_data ⇒ String
Information to be 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.
-
#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 act as a sliding cap on player latency.
-
#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 to be added to all events that are related to this game session queue.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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. When updating this list, provide a complete list of destinations.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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. To remove an
existing filter configuration, pass in an empty set.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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. You can use either the queue ID or ARN value.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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 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. When updating policies, provide a complete collection of policies.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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. To remove an existing priority configuration, pass in an empty set.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :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. By default,
this property is set to 600
.
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9239 class UpdateGameSessionQueueInput < Struct.new( :name, :timeout_in_seconds, :player_latency_policies, :destinations, :filter_configuration, :priority_configuration, :custom_event_data, :notification_target) SENSITIVE = [] include Aws::Structure end |