You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateGameSessionQueueInput data as a hash:

{
  name: "GameSessionQueueName", # required
  timeout_in_seconds: 1,
  player_latency_policies: [
    {
      maximum_individual_player_latency_milliseconds: 1,
      policy_duration_seconds: 1,
    },
  ],
  destinations: [
    {
      destination_arn: "ArnStringModel",
    },
  ],
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#destinationsArray<Types::GameSessionQueueDestination>

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.



771
772
773
774
775
776
777
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 771

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#nameString

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Returns:

  • (String)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 771

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#player_latency_policiesArray<Types::PlayerLatencyPolicy>

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

Returns:



771
772
773
774
775
776
777
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 771

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end

#timeout_in_secondsInteger

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)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 771

class CreateGameSessionQueueInput < Struct.new(
  :name,
  :timeout_in_seconds,
  :player_latency_policies,
  :destinations)
  include Aws::Structure
end