Class: Aws::GameLift::Types::PlayerLatencyPolicy

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::PlayerLatencyPolicy

show all

Includes:: Structure

Defined in:: lib/aws-sdk-gamelift/types.rb

Overview

Note:

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

{
  maximum_individual_player_latency_milliseconds: 1,
  policy_duration_seconds: 1,
}

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

Queue-related operations include:

CreateGameSessionQueue
DescribeGameSessionQueues
UpdateGameSessionQueue
DeleteGameSessionQueue

Instance Attribute Summary collapse

#maximum_individual_player_latency_milliseconds ⇒ Integer

The maximum latency value that is allowed for any player, in milliseconds.
#policy_duration_seconds ⇒ Integer

The length of time, in seconds, that the policy is enforced while placing a new game session.

Instance Attribute Details

#maximum_individual_player_latency_milliseconds ⇒ `Integer`

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Returns:

(Integer)

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

class PlayerLatencyPolicy < Struct.new(
  :maximum_individual_player_latency_milliseconds,
  :policy_duration_seconds)
  include Aws::Structure
end

#policy_duration_seconds ⇒ `Integer`

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.