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

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

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 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

Instance Attribute Details

#maximum_individual_player_latency_millisecondsInteger

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

Returns:

  • (Integer)


4598
4599
4600
4601
4602
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4598

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

#policy_duration_secondsInteger

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.

Returns:

  • (Integer)


4598
4599
4600
4601
4602
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4598

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