ResourceCreationLimitPolicy

class aws_cdk.aws_gamelift_alpha.ResourceCreationLimitPolicy(*, new_game_sessions_per_creator=None, policy_period=None)

Bases: object

(experimental) A policy that limits the number of game sessions a player can create on the same fleet.

This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: “An individual player can create a maximum number of new game sessions within a specified time period”.

The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

Parameters:

  • new_game_sessions_per_creator (Union[int, float, None]) – (experimental) The maximum number of game sessions that an individual can create during the policy period. Default: no limit on the number of game sessions that an individual can create during the policy period

  • policy_period (Optional[Duration]) – (experimental) The time span used in evaluating the resource creation limit policy. Default: no policy period

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

resource_creation_limit_policy = gamelift_alpha.ResourceCreationLimitPolicy(
    new_game_sessions_per_creator=123,
    policy_period=cdk.Duration.minutes(30)
)

Attributes

new_game_sessions_per_creator

(experimental) The maximum number of game sessions that an individual can create during the policy period.

Default:

no limit on the number of game sessions that an individual can create during the policy period

Stability:

experimental

policy_period

(experimental) The time span used in evaluating the resource creation limit policy.

Default:

no policy period

Stability:

experimental