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

Interface ResourceCreationLimitPolicy

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ResourceCreationLimitPolicy.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:25.570Z") @Stability(Experimental) public interface ResourceCreationLimitPolicy extends software.amazon.jsii.JsiiSerializable
(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.

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.*;
 ResourceCreationLimitPolicy resourceCreationLimitPolicy = ResourceCreationLimitPolicy.builder()
         .newGameSessionsPerCreator(123)
         .policyPeriod(Duration.minutes(30))
         .build();

  • Method Details

    • getNewGameSessionsPerCreator

      @Stability(Experimental) @Nullable default Number getNewGameSessionsPerCreator()
      (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

    • getPolicyPeriod

      @Stability(Experimental) @Nullable default Duration getPolicyPeriod()
      (experimental) The time span used in evaluating the resource creation limit policy.

      Default: no policy period

    • builder

      @Stability(Experimental) static ResourceCreationLimitPolicy.Builder builder()
      Returns:
      a ResourceCreationLimitPolicy.Builder of ResourceCreationLimitPolicy