PlayerLatencyPolicy

class aws_cdk.aws_gamelift_alpha.PlayerLatencyPolicy(*, maximum_individual_player_latency, policy_duration=None)

Bases: object

(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.

Parameters:

• maximum_individual_player_latency (Duration) – (experimental) The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

• policy_duration (Optional[Duration]) – (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.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift_alpha as gamelift_alpha
import aws_cdk as cdk

player_latency_policy = gamelift_alpha.PlayerLatencyPolicy(
    maximum_individual_player_latency=cdk.Duration.minutes(30),

    # the properties below are optional
    policy_duration=cdk.Duration.minutes(30)
)

Attributes

maximum_individual_player_latency

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

All policies must have a value set for this property.

Stability:

experimental

policy_duration

(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.

Stability:

experimental