Experimental
@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
PlayerLatencyPolicy Struct
The 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 with any fleet in a Region where a player reports latency higher than the cap.
Latency policies are only enforced when the placement request contains player latency information.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import * as cdk from 'aws-cdk-lib';
const playerLatencyPolicy: gamelift_alpha.PlayerLatencyPolicy = {
maximumIndividualPlayerLatency: cdk.Duration.minutes(30),
// the properties below are optional
policyDuration: cdk.Duration.minutes(30),
};
Properties
maximumIndividualPlayerLatencyDurationmaximum_individual_player_latencyDurationmaximumIndividualPlayerLatencyDurationMaximumIndividualPlayerLatencyDurationMaximumIndividualPlayerLatencyDurationrequired#The maximum latency value that is allowed for any player, in milliseconds.
All policies must have a value set for this property.
policyDurationoptionalDurationpolicy_durationoptionalDurationpolicyDurationoptionalDurationPolicyDurationoptionalDurationPolicyDurationoptionalDuration#The length of time, in seconds, that the policy is enforced while placing a new game session.
Default: the policy is enforced until the queue times out.