interface ResourceCreationLimitPolicy
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.GameLift.Alpha.ResourceCreationLimitPolicy |
 Go | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#ResourceCreationLimitPolicy |
 Java | software.amazon.awscdk.services.gamelift.alpha.ResourceCreationLimitPolicy |
 Python | aws_cdk.aws_gamelift_alpha.ResourceCreationLimitPolicy |
 TypeScript (source) | @aws-cdk/aws-gamelift-alpha » ResourceCreationLimitPolicy |
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 * 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
| Name | Type | Description |
|---|---|---|
| new | number | The maximum number of game sessions that an individual can create during the policy period. |
| policy | Duration | The time span used in evaluating the resource creation limit policy. |
newGameSessionsPerCreator?
Type:
number
(optional, default: no limit on the number of game sessions that an individual can create during the policy period)
The maximum number of game sessions that an individual can create during the policy period.
policyPeriod?
Type:
Duration
(optional, default: no policy period)
The time span used in evaluating the resource creation limit policy.