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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-gamelift/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,
}

Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.

Latency policies are part of a GameSessionQueue.

Constant Summary collapse

SENSITIVE =

[]

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

class PlayerLatencyPolicy < Struct.new(
  :maximum_individual_player_latency_milliseconds,
  :policy_duration_seconds)
  SENSITIVE = []
  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.