Class ResourceCreationLimitPolicy

(experimental) A policy that limits the number of game sessions a player can create on the same fleet.

Inheritance

object

ResourceCreationLimitPolicy

Implements

IResourceCreationLimitPolicy

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public class ResourceCreationLimitPolicy : IResourceCreationLimitPolicy

Syntax (vb)

Public Class ResourceCreationLimitPolicy Implements IResourceCreationLimitPolicy

Remarks

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.

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// 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)
             };

Synopsis

Constructors

ResourceCreationLimitPolicy()

(experimental) A policy that limits the number of game sessions a player can create on the same fleet.

Properties

NewGameSessionsPerCreator	(experimental) The maximum number of game sessions that an individual can create during the policy period.
PolicyPeriod	(experimental) The time span used in evaluating the resource creation limit policy.

Constructors

ResourceCreationLimitPolicy()

(experimental) A policy that limits the number of game sessions a player can create on the same fleet.

public ResourceCreationLimitPolicy()

Remarks

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.

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// 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)
             };

Properties

NewGameSessionsPerCreator

(experimental) The maximum number of game sessions that an individual can create during the policy period.

public double? NewGameSessionsPerCreator { get; set; }

Property Value

double?

Remarks

Default: - no limit on the number of game sessions that an individual can create during the policy period

Stability: Experimental

PolicyPeriod

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

public Duration? PolicyPeriod { get; set; }

Property Value

Duration

Remarks

Default: - no policy period

Stability: Experimental

Implements

IResourceCreationLimitPolicy