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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::CreateGameSessionQueueInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #tags ⇒ Array<Types::Tag>

  A list of labels to assign to the new game session queue resource.

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

Returns:

• (String)

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

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

#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 'lib/aws-sdk-gamelift/types.rb', line 2579

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_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 'lib/aws-sdk-gamelift/types.rb', line 2579

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

#name ⇒ String

A 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 2579

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_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)

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

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_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.

Returns:

• (Array<Types::PlayerLatencyPolicy>)

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

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_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 'lib/aws-sdk-gamelift/types.rb', line 2579

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

#tags ⇒ Array<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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Array<Types::Tag>)

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

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_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`.

Returns:

• (Integer)

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

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