Skip to content
v2.274.0

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ResourceCreationLimitPolicy Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import * as cdk from 'aws-cdk-lib';
const resourceCreationLimitPolicy: gamelift_alpha.ResourceCreationLimitPolicy = {
  newGameSessionsPerCreator: 123,
  policyPeriod: cdk.Duration.minutes(30),
};

Properties ​

newGameSessionsPerCreatoroptionalnumbernew_game_sessions_per_creatoroptionalint | floatnewGameSessionsPerCreatoroptionalNumberNewGameSessionsPerCreatoroptionaldoubleNewGameSessionsPerCreatoroptional*float64#
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

policyPeriodoptionalDurationpolicy_periodoptionalDurationpolicyPeriodoptionalDurationPolicyPeriodoptionalDurationPolicyPeriodoptionalDuration#
The time span used in evaluating the resource creation limit policy.

Default: no policy period