Class CfnGameSessionQueue.PlayerLatencyPolicyProperty

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

Inheritance

object

CfnGameSessionQueue.PlayerLatencyPolicyProperty

Implements

CfnGameSessionQueue.IPlayerLatencyPolicyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGameSessionQueue.PlayerLatencyPolicyProperty : CfnGameSessionQueue.IPlayerLatencyPolicyProperty

Syntax (vb)

Public Class CfnGameSessionQueue.PlayerLatencyPolicyProperty Implements CfnGameSessionQueue.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

Constructors

PlayerLatencyPolicyProperty()

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

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.

Constructors

PlayerLatencyPolicyProperty()

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

public PlayerLatencyPolicyProperty()

Remarks

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
             };

Properties

MaximumIndividualPlayerLatencyMilliseconds

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

public double? MaximumIndividualPlayerLatencyMilliseconds { get; set; }

Property Value

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.

public double? PolicyDurationSeconds { get; set; }

Property Value

double?

Remarks

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

Implements

CfnGameSessionQueue.IPlayerLatencyPolicyProperty