Interface CfnGameSessionQueue.IPlayerLatencyPolicyProperty

The queue setting that determines the highest latency allowed for individual players when placing a game session.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IPlayerLatencyPolicyProperty

Syntax (vb)

Public Interface IPlayerLatencyPolicyProperty

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;

var playerLatencyPolicyProperty = new PlayerLatencyPolicyProperty {
    MaximumIndividualPlayerLatencyMilliseconds = 123,
    PolicyDurationSeconds = 123
};

Synopsis

Properties

MaximumIndividualPlayerLatencyMilliseconds	The maximum latency value that is allowed for any player, in milliseconds.
PolicyDurationSeconds	The length of time, in seconds, that the policy is enforced while placing a new game session.

Properties

MaximumIndividualPlayerLatencyMilliseconds

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

virtual Nullable<double> MaximumIndividualPlayerLatencyMilliseconds { get; }

Property Value

System.Nullable<System.Double>

Remarks

All policies must have a value set for this property.

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

PolicyDurationSeconds

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

virtual Nullable<double> PolicyDurationSeconds { get; }

Property Value

System.Nullable<System.Double>

Remarks

A null value for this property means that the policy is enforced until the queue times out.