interface PlayerLatencyPolicyProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.GameLift.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsgamelift#CfnGameSessionQueuePropsMixin_PlayerLatencyPolicyProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty |
 Python | aws_cdk.cfn_property_mixins.aws_gamelift.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_gamelift » 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.
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/cfn-property-mixins';
const playerLatencyPolicyProperty: gamelift.CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty = {
maximumIndividualPlayerLatencyMilliseconds: 123,
policyDurationSeconds: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| maximum | number | The maximum latency value that is allowed for any player, in milliseconds. |
| policy | 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.
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.