You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::ResourceCreationLimitPolicy

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::ResourceCreationLimitPolicy

show all

Defined in:: gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass ResourceCreationLimitPolicy data as a hash:

{
  new_game_sessions_per_creator: 1,
  policy_period_in_minutes: 1,
}

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.

Instance Attribute Summary collapse

#new_game_sessions_per_creator ⇒ Integer
The maximum number of game sessions that an individual can create during the policy period.
#policy_period_in_minutes ⇒ Integer
The time span used in evaluating the resource creation limit policy.

Instance Attribute Details

#new_game_sessions_per_creator ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5923

class ResourceCreationLimitPolicy < Struct.new(
  :new_game_sessions_per_creator,
  :policy_period_in_minutes)
  include Aws::Structure
end

#policy_period_in_minutes ⇒ `Integer`

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