Package software.amazon.awscdk.services.gamelift.alpha

Interface PlayerLatencyPolicy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PlayerLatencyPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.566Z")
@Stability(Experimental)
public interface PlayerLatencyPolicy
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.services.gamelift.alpha.*;
 import software.amazon.awscdk.*;
 PlayerLatencyPolicy playerLatencyPolicy = PlayerLatencyPolicy.builder()
         .maximumIndividualPlayerLatency(Duration.minutes(30))
         // the properties below are optional
         .policyDuration(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlayerLatencyPolicy.Builder	builder()
Duration	getMaximumIndividualPlayerLatency()	(experimental) The maximum latency value that is allowed for any player, in milliseconds.
default Duration	getPolicyDuration()	(experimental) 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

getMaximumIndividualPlayerLatency

@Stability(Experimental)
@NotNull
Duration getMaximumIndividualPlayerLatency()

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

All policies must have a value set for this property.

getPolicyDuration

@Stability(Experimental)
@Nullable
default Duration getPolicyDuration()

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

Default: the policy is enforced until the queue times out.

builder

@Stability(Experimental)
static PlayerLatencyPolicy.Builder builder()

Returns:

a PlayerLatencyPolicy.Builder of PlayerLatencyPolicy