Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Interface CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Jsii$Proxy

Enclosing class:

CfnFleetPropsMixin

@Stability(Stable)
public static interface CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.gamelift.*;
 ResourceCreationLimitPolicyProperty resourceCreationLimitPolicyProperty = ResourceCreationLimitPolicyProperty.builder()
         .newGameSessionsPerCreator(123)
         .policyPeriodInMinutes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Builder	A builder for CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty
static final class	CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Jsii$Proxy	An implementation for CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Builder	builder()
default Number	getNewGameSessionsPerCreator()	A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
default Number	getPolicyPeriodInMinutes()	The time span used in evaluating the resource creation limit policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNewGameSessionsPerCreator

@Stability(Stable)
@Nullable
default Number getNewGameSessionsPerCreator()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator

getPolicyPeriodInMinutes

@Stability(Stable)
@Nullable
default Number getPolicyPeriodInMinutes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes

builder

@Stability(Stable)
static CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Builder builder()

Returns:

a CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty.Builder of CfnFleetPropsMixin.ResourceCreationLimitPolicyProperty