Documentation

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.

See: newPlayerLatencyPolicy smart constructor.

Create a value of PlayerLatencyPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policyDurationSeconds:PlayerLatencyPolicy', playerLatencyPolicy_policyDurationSeconds - 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.

$sel:maximumIndividualPlayerLatencyMilliseconds:PlayerLatencyPolicy', playerLatencyPolicy_maximumIndividualPlayerLatencyMilliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

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.

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