File Coverage

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