Class: Aws::GameLift::Types::UpdateGameSessionQueueInput

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::UpdateGameSessionQueueInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass UpdateGameSessionQueueInput 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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #destinations ⇒ Array<Types::GameSessionQueueDestination>

  List of fleets that can be used to fulfill game session placement requests in the queue.

• #name ⇒ String

  Descriptive label that is associated with game session queue.

• #player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

  Collection of latency policies to apply when processing game sessions placement requests with player latency information.

• #timeout_in_seconds ⇒ Integer

  Maximum time, in seconds, that a new game session placement request remains in the queue.

Instance Attribute Details

#destinations ⇒ Array<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. When updating this list, provide a complete list of destinations.

Returns:

• (Array<Types::GameSessionQueueDestination>)

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

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

#name ⇒ String

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 6512

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

#player_latency_policies ⇒ Array<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. When updating policies, provide a complete collection of policies.

Returns:

• (Array<Types::PlayerLatencyPolicy>)

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

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

#timeout_in_seconds ⇒ Integer

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)

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

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