Class: Aws::GameLift::Types::CreateGameSessionQueueInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_event_dataString

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

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#destinationsArray<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.



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#filter_configurationTypes::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.



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#nameString

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

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#notification_targetString

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

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#player_latency_policiesArray<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.

Returns:



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#priority_configurationTypes::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.



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#tagsArray<Types::Tag>

A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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

#timeout_in_secondsInteger

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.

Returns:

  • (Integer)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1387

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