@aws-cdk_aws-gamelift-alpha.PlayerLatencyPolicy

interface PlayerLatencyPolicy ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.PlayerLatencyPolicy
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#PlayerLatencyPolicy
Javasoftware.amazon.awscdk.services.gamelift.alpha.PlayerLatencyPolicy
Pythonaws_cdk.aws_gamelift_alpha.PlayerLatencyPolicy
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป PlayerLatencyPolicy

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

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

NameTypeDescription
maximumIndividualPlayerLatency๐Ÿ”นDurationThe maximum latency value that is allowed for any player, in milliseconds.
policyDuration?๐Ÿ”นDurationThe length of time, in seconds, that the policy is enforced while placing a new game session.

maximumIndividualPlayerLatency๐Ÿ”น

Type: Duration

The maximum latency value that is allowed for any player, in milliseconds.

All policies must have a value set for this property.


policyDuration?๐Ÿ”น

Type: Duration (optional, default: the policy is enforced until the queue times out.)

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