interface ResourceCreationLimitPolicyProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.GameLift.Mixins.CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgamelift/mixins#CfnFleetPropsMixin_ResourceCreationLimitPolicyProperty |
 Java | software.amazon.awscdk.mixins.preview.services.gamelift.mixins.CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty |
 Python | aws_cdk.mixins_preview.aws_gamelift.mixins.CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_gamelift » mixins » CfnFleetPropsMixin » ResourceCreationLimitPolicyProperty |
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 { mixins as gamelift_mixins } from '@aws-cdk/mixins-preview/aws-gamelift';
const resourceCreationLimitPolicyProperty: gamelift_mixins.CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty = {
newGameSessionsPerCreator: 123,
policyPeriodInMinutes: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| new | number | A policy that puts limits on the number of game sessions that a player can create within a specified span of time. |
| policy | 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 Servers 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.