aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty

interface PlayerLatencyPolicyProperty

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnGameSessionQueue.PlayerLatencyPolicyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnGameSessionQueue_PlayerLatencyPolicyProperty
Javasoftware.amazon.awscdk.services.gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty
Pythonaws_cdk.aws_gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty
TypeScript aws-cdk-lib » aws_gamelift » CfnGameSessionQueue » PlayerLatencyPolicyProperty

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 { aws_gamelift as gamelift } from 'aws-cdk-lib';
const playerLatencyPolicyProperty: gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty = {
  maximumIndividualPlayerLatencyMilliseconds: 123,
  policyDurationSeconds: 123,
};

Properties

NameTypeDescription
maximumIndividualPlayerLatencyMilliseconds?numberThe maximum latency value that is allowed for any player, in milliseconds.
policyDurationSeconds?numberThe length of time, in seconds, that the policy is enforced while placing a new game session.

maximumIndividualPlayerLatencyMilliseconds?

Type: number (optional)

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

All policies must have a value set for this property.


policyDurationSeconds?

Type: number (optional)

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.