Package software.amazon.awscdk.services.gamelift

Interface CfnContainerFleet.GameSessionCreationLimitPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerFleet.GameSessionCreationLimitPolicyProperty.Jsii$Proxy

Enclosing class:

CfnContainerFleet

@Stability(Stable)
public static interface CfnContainerFleet.GameSessionCreationLimitPolicyProperty
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.services.gamelift.*;
 GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicyProperty = GameSessionCreationLimitPolicyProperty.builder()
         .newGameSessionsPerCreator(123)
         .policyPeriodInMinutes(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerFleet.GameSessionCreationLimitPolicyProperty.Builder	builder()
default Number	getNewGameSessionsPerCreator()	The maximum number of game sessions that an individual can create during the policy period.
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()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-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-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-policyperiodinminutes

builder

@Stability(Stable)
static CfnContainerFleet.GameSessionCreationLimitPolicyProperty.Builder builder()

Returns:

a CfnContainerFleet.GameSessionCreationLimitPolicyProperty.Builder of CfnContainerFleet.GameSessionCreationLimitPolicyProperty