Skip to content
v2.278.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),
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift_alpha as gamelift_alpha
import aws_cdk as cdk

resource_creation_limit_policy = gamelift_alpha.ResourceCreationLimitPolicy(
    new_game_sessions_per_creator=123,
    policy_period=cdk.Duration.minutes(30)
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift.Alpha;
using Amazon.CDK;

var resourceCreationLimitPolicy = new ResourceCreationLimitPolicy {
    NewGameSessionsPerCreator = 123,
    PolicyPeriod = Duration.Minutes(30)
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import gamelift_alpha "github.com/aws/aws-cdk-go/awscdkgameliftalpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"

resourceCreationLimitPolicy := &ResourceCreationLimitPolicy{
	NewGameSessionsPerCreator: jsii.Number(123),
	PolicyPeriod: cdk.Duration_Minutes(jsii.Number(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