File Coverage

blib/lib/Paws/GameLift/FleetUtilization.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::FleetUtilization;
2 1     1   494 use Moose;
  1         2  
  1         8  
3             has ActiveGameSessionCount => (is => 'ro', isa => 'Int');
4             has ActiveServerProcessCount => (is => 'ro', isa => 'Int');
5             has CurrentPlayerSessionCount => (is => 'ro', isa => 'Int');
6             has FleetId => (is => 'ro', isa => 'Str');
7             has MaximumPlayerSessionCount => (is => 'ro', isa => 'Int');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::GameLift::FleetUtilization
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::GameLift::FleetUtilization object:
26              
27             $service_obj->Method(Att1 => { ActiveGameSessionCount => $value, ..., MaximumPlayerSessionCount => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::FleetUtilization object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->ActiveGameSessionCount
35              
36             =head1 DESCRIPTION
37              
38             Current status of fleet utilization, including the number of game and
39             player sessions being hosted.
40              
41             Fleet-related operations include:
42              
43             =over
44              
45             =item *
46              
47             CreateFleet
48              
49             =item *
50              
51             ListFleets
52              
53             =item *
54              
55             Describe fleets:
56              
57             =over
58              
59             =item *
60              
61             DescribeFleetAttributes
62              
63             =item *
64              
65             DescribeFleetPortSettings
66              
67             =item *
68              
69             DescribeFleetUtilization
70              
71             =item *
72              
73             DescribeRuntimeConfiguration
74              
75             =item *
76              
77             DescribeFleetEvents
78              
79             =back
80              
81             =item *
82              
83             Update fleets:
84              
85             =over
86              
87             =item *
88              
89             UpdateFleetAttributes
90              
91             =item *
92              
93             UpdateFleetCapacity
94              
95             =item *
96              
97             UpdateFleetPortSettings
98              
99             =item *
100              
101             UpdateRuntimeConfiguration
102              
103             =back
104              
105             =item *
106              
107             Manage fleet capacity:
108              
109             =over
110              
111             =item *
112              
113             DescribeFleetCapacity
114              
115             =item *
116              
117             UpdateFleetCapacity
118              
119             =item *
120              
121             PutScalingPolicy (automatic scaling)
122              
123             =item *
124              
125             DescribeScalingPolicies (automatic scaling)
126              
127             =item *
128              
129             DeleteScalingPolicy (automatic scaling)
130              
131             =item *
132              
133             DescribeEC2InstanceLimits
134              
135             =back
136              
137             =item *
138              
139             DeleteFleet
140              
141             =back
142              
143              
144             =head1 ATTRIBUTES
145              
146              
147             =head2 ActiveGameSessionCount => Int
148              
149             Number of active game sessions currently being hosted on all instances
150             in the fleet.
151              
152              
153             =head2 ActiveServerProcessCount => Int
154              
155             Number of server processes in an C<ACTIVE> status currently running
156             across all instances in the fleet
157              
158              
159             =head2 CurrentPlayerSessionCount => Int
160              
161             Number of active player sessions currently being hosted on all
162             instances in the fleet.
163              
164              
165             =head2 FleetId => Str
166              
167             Unique identifier for a fleet.
168              
169              
170             =head2 MaximumPlayerSessionCount => Int
171              
172             Maximum players allowed across all game sessions currently being hosted
173             on all instances in the fleet.
174              
175              
176              
177             =head1 SEE ALSO
178              
179             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
180              
181             =head1 BUGS and CONTRIBUTIONS
182              
183             The source code is located here: https://github.com/pplu/aws-sdk-perl
184              
185             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
186              
187             =cut
188