AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::ResourceCreationLimitPolicy Class Reference

#include <ResourceCreationLimitPolicy.h>

Public Member Functions

 ResourceCreationLimitPolicy ()
 
 ResourceCreationLimitPolicy (Aws::Utils::Json::JsonView jsonValue)
 
ResourceCreationLimitPolicyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetNewGameSessionsPerCreator () const
 
bool NewGameSessionsPerCreatorHasBeenSet () const
 
void SetNewGameSessionsPerCreator (int value)
 
ResourceCreationLimitPolicyWithNewGameSessionsPerCreator (int value)
 
int GetPolicyPeriodInMinutes () const
 
bool PolicyPeriodInMinutesHasBeenSet () const
 
void SetPolicyPeriodInMinutes (int value)
 
ResourceCreationLimitPolicyWithPolicyPeriodInMinutes (int value)
 

Detailed Description

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, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

The resource creation limit policy is included in FleetAttributes.

See Also:

AWS API Reference

Definition at line 36 of file ResourceCreationLimitPolicy.h.

Constructor & Destructor Documentation

◆ ResourceCreationLimitPolicy() [1/2]

Aws::GameLift::Model::ResourceCreationLimitPolicy::ResourceCreationLimitPolicy ( )

◆ ResourceCreationLimitPolicy() [2/2]

Aws::GameLift::Model::ResourceCreationLimitPolicy::ResourceCreationLimitPolicy ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetNewGameSessionsPerCreator()

int Aws::GameLift::Model::ResourceCreationLimitPolicy::GetNewGameSessionsPerCreator ( ) const
inline

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

Definition at line 49 of file ResourceCreationLimitPolicy.h.

◆ GetPolicyPeriodInMinutes()

int Aws::GameLift::Model::ResourceCreationLimitPolicy::GetPolicyPeriodInMinutes ( ) const
inline

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

Definition at line 73 of file ResourceCreationLimitPolicy.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::ResourceCreationLimitPolicy::Jsonize ( ) const

◆ NewGameSessionsPerCreatorHasBeenSet()

bool Aws::GameLift::Model::ResourceCreationLimitPolicy::NewGameSessionsPerCreatorHasBeenSet ( ) const
inline

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

Definition at line 55 of file ResourceCreationLimitPolicy.h.

◆ operator=()

ResourceCreationLimitPolicy& Aws::GameLift::Model::ResourceCreationLimitPolicy::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PolicyPeriodInMinutesHasBeenSet()

bool Aws::GameLift::Model::ResourceCreationLimitPolicy::PolicyPeriodInMinutesHasBeenSet ( ) const
inline

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

Definition at line 78 of file ResourceCreationLimitPolicy.h.

◆ SetNewGameSessionsPerCreator()

void Aws::GameLift::Model::ResourceCreationLimitPolicy::SetNewGameSessionsPerCreator ( int  value)
inline

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

Definition at line 61 of file ResourceCreationLimitPolicy.h.

◆ SetPolicyPeriodInMinutes()

void Aws::GameLift::Model::ResourceCreationLimitPolicy::SetPolicyPeriodInMinutes ( int  value)
inline

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

Definition at line 83 of file ResourceCreationLimitPolicy.h.

◆ WithNewGameSessionsPerCreator()

ResourceCreationLimitPolicy& Aws::GameLift::Model::ResourceCreationLimitPolicy::WithNewGameSessionsPerCreator ( int  value)
inline

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

Definition at line 67 of file ResourceCreationLimitPolicy.h.

◆ WithPolicyPeriodInMinutes()

ResourceCreationLimitPolicy& Aws::GameLift::Model::ResourceCreationLimitPolicy::WithPolicyPeriodInMinutes ( int  value)
inline

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

Definition at line 88 of file ResourceCreationLimitPolicy.h.


The documentation for this class was generated from the following file: