interface ResourceCreationLimitPolicyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnFleet.ResourceCreationLimitPolicyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleet_ResourceCreationLimitPolicyProperty`
Java	`software.amazon.awscdk.services.gamelift.CfnFleet.ResourceCreationLimitPolicyProperty`
Python	`aws_cdk.aws_gamelift.CfnFleet.ResourceCreationLimitPolicyProperty`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnFleet` » `ResourceCreationLimitPolicyProperty`

Obtainable from FleetBase.parseResourceCreationLimitPolicy()

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 { aws_gamelift as gamelift } from 'aws-cdk-lib';
const resourceCreationLimitPolicyProperty: gamelift.CfnFleet.ResourceCreationLimitPolicyProperty = {
  newGameSessionsPerCreator: 123,
  policyPeriodInMinutes: 123,
};

Properties

Name	Type	Description
newGameSessionsPerCreator?	`number`	A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
policyPeriodInMinutes?	`number`	The time span used in evaluating the resource creation limit policy.

newGameSessionsPerCreator?

Type: number (optional)

A policy that puts limits on the number of game sessions that a player can create within a specified span of time.

With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId ) has created fewer than game session limit in the specified time period.

policyPeriodInMinutes?

Type: number (optional)

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