Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Interface CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Jsii$Proxy

Enclosing class:

CfnGameSessionQueuePropsMixin

@Stability(Stable)
public static interface CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.gamelift.*;
 PlayerLatencyPolicyProperty playerLatencyPolicyProperty = PlayerLatencyPolicyProperty.builder()
         .maximumIndividualPlayerLatencyMilliseconds(123)
         .policyDurationSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Builder	A builder for CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty
static final class	CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Jsii$Proxy	An implementation for CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Builder	builder()
default Number	getMaximumIndividualPlayerLatencyMilliseconds()	The maximum latency value that is allowed for any player, in milliseconds.
default Number	getPolicyDurationSeconds()	The length of time, in seconds, that the policy is enforced while placing a new game session.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaximumIndividualPlayerLatencyMilliseconds

@Stability(Stable)
@Nullable
default Number getMaximumIndividualPlayerLatencyMilliseconds()

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

getPolicyDurationSeconds

@Stability(Stable)
@Nullable
default Number getPolicyDurationSeconds()

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

builder

@Stability(Stable)
static CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Builder builder()

Returns:

a CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty.Builder of CfnGameSessionQueuePropsMixin.PlayerLatencyPolicyProperty