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 =
[:custom_event_data]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_event_data ⇒ String

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

Returns:

  • (String)


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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.



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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.



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

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

#log_configuration ⇒ Types::GameSessionQueueLogConfiguration

An optional configuration that delivers game session placement insight logs to one or more destinations of your choice. Use these logs to diagnose why a game session placement is FULFILLED, CANCELLED, TIMED_OUT, or FAILED, which locations were evaluated, and the latency and cost factors that influenced each decision.



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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)


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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)


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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 Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

Returns:



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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 default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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 is 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:



2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations,
  :filter_configuration,
  :priority_configuration,
  :custom_event_data,
  :notification_target,
  :tags,
  :log_configuration)
  SENSITIVE = [:custom_event_data]
  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. If you don't specify a request timeout, the queue uses a default value.

The minimum value is 10 and the maximum value is 600.

Returns:

  • (Integer)


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2918

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