File Coverage

blib/lib/Paws/GameLift/ResourceCreationLimitPolicy.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::GameLift::ResourceCreationLimitPolicy;
2 1     1   416 use Moose;
  1         3  
  1         6  
3             has NewGameSessionsPerCreator => (is => 'ro', isa => 'Int');
4             has PolicyPeriodInMinutes => (is => 'ro', isa => 'Int');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::GameLift::ResourceCreationLimitPolicy
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::GameLift::ResourceCreationLimitPolicy object:
23              
24             $service_obj->Method(Att1 => { NewGameSessionsPerCreator => $value, ..., PolicyPeriodInMinutes => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::ResourceCreationLimitPolicy object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->NewGameSessionsPerCreator
32              
33             =head1 DESCRIPTION
34              
35             Policy that limits the number of game sessions a player can create on
36             the same fleet. This optional policy gives game owners control over how
37             players can consume available game server resources. A resource
38             creation policy makes the following statement: "An individual player
39             can create a maximum number of new game sessions within a specified
40             time period".
41              
42             The policy is evaluated when a player tries to create a new game
43             session. For example, with a policy of 10 new game sessions and a time
44             period of 60 minutes, on receiving a C<CreateGameSession> request,
45             Amazon GameLift checks that the player (identified by C<CreatorId>) has
46             created fewer than 10 game sessions in the past 60 minutes.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 NewGameSessionsPerCreator => Int
52              
53             Maximum number of game sessions that an individual can create during
54             the policy period.
55              
56              
57             =head2 PolicyPeriodInMinutes => Int
58              
59             Time span used in evaluating the resource creation limit policy.
60              
61              
62              
63             =head1 SEE ALSO
64              
65             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
66              
67             =head1 BUGS and CONTRIBUTIONS
68              
69             The source code is located here: https://github.com/pplu/aws-sdk-perl
70              
71             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
72              
73             =cut
74