AWS SDK for C++  1.8.23
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 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.

See Also:

AWS API Reference

Definition at line 38 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 51 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 75 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 57 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 80 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 63 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 85 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 69 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 90 of file ResourceCreationLimitPolicy.h.


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