interface PlayerLatencyPolicyProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.GameLift.Mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgamelift/mixins#CfnGameSessionQueuePropsMixin_PlayerLatencyPolicyProperty
Java	software.amazon.awscdk.mixins.preview.services.gamelift.mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty
Python	aws_cdk.mixins_preview.aws_gamelift.mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty
TypeScript	@aws-cdk/mixins-preview » aws_gamelift » mixins » CfnGameSessionQueuePropsMixin » 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as gamelift_mixins } from '@aws-cdk/mixins-preview/aws-gamelift';
const playerLatencyPolicyProperty: gamelift_mixins.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty = {
  maximumIndividualPlayerLatencyMilliseconds: 123,
  policyDurationSeconds: 123,
};

Properties

Name	Type	Description
maximumIndividualPlayerLatencyMilliseconds?	number	The maximum latency value that is allowed for any player, in milliseconds.
policyDurationSeconds?	number	The 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds