File Coverage

blib/lib/Paws/GameLift/RuntimeConfiguration.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	sub	time	code
1				package Paws::GameLift::RuntimeConfiguration;
2	1	1	506	use Moose;
	1		3
	1		7
3				has GameSessionActivationTimeoutSeconds => (is => 'ro', isa => 'Int');
4				has MaxConcurrentGameSessionActivations => (is => 'ro', isa => 'Int');
5				has ServerProcesses => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::ServerProcess]');
6				1;
7
8				### main pod documentation begin ###
9
10				=head1 NAME
11
12				Paws::GameLift::RuntimeConfiguration
13
14				=head1 USAGE
15
16				This class represents one of two things:
17
18				=head3 Arguments in a call to a service
19
20				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21				Each attribute should be used as a named argument in the calls that expect this type of object.
22
23				As an example, if Att1 is expected to be a Paws::GameLift::RuntimeConfiguration object:
24
25				$service_obj->Method(Att1 => { GameSessionActivationTimeoutSeconds => $value, ..., ServerProcesses => $value });
26
27				=head3 Results returned from an API call
28
29				Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::RuntimeConfiguration object:
30
31				$result = $service_obj->Method(...);
32				$result->Att1->GameSessionActivationTimeoutSeconds
33
34				=head1 DESCRIPTION
35
36				A collection of server process configurations that describe what
37				processes to run on each instance in a fleet. All fleets must have a
38				runtime configuration. Each instance in the fleet launches the server
39				processes specified in the run-time configuration and launches new ones
40				as existing processes end. Each instance regularly checks for an
41				updated run-time configuration and follows the new instructions.
42
43				The run-time configuration enables the instances in a fleet to run
44				multiple processes simultaneously. Potential scenarios are as follows:
45				(1) Run multiple processes of a single game server executable to
46				maximize usage of your hosting resources. (2) Run one or more processes
47				of different build executables, such as your game server executable and
48				a related program, or two or more different versions of a game server.
49				(3) Run multiple processes of a single game server but with different
50				launch parameters, for example to run one process on each instance in
51				debug mode.
52
53				A Amazon GameLift instance is limited to 50 processes running
54				simultaneously. A run-time configuration must specify fewer than this
55				limit. To calculate the total number of processes specified in a
56				run-time configuration, add the values of the C<ConcurrentExecutions>
57				parameter for each C< ServerProcess > object in the run-time
58				configuration.
59
60				Fleet-related operations include:
61
62				=over
63
64				=item *
65
66				CreateFleet
67
68				=item *
69
70				ListFleets
71
72				=item *
73
74				Describe fleets:
75
76				=over
77
78				=item *
79
80				DescribeFleetAttributes
81
82				=item *
83
84				DescribeFleetPortSettings
85
86				=item *
87
88				DescribeFleetUtilization
89
90				=item *
91
92				DescribeRuntimeConfiguration
93
94				=item *
95
96				DescribeFleetEvents
97
98				=back
99
100				=item *
101
102				Update fleets:
103
104				=over
105
106				=item *
107
108				UpdateFleetAttributes
109
110				=item *
111
112				UpdateFleetCapacity
113
114				=item *
115
116				UpdateFleetPortSettings
117
118				=item *
119
120				UpdateRuntimeConfiguration
121
122				=back
123
124				=item *
125
126				Manage fleet capacity:
127
128				=over
129
130				=item *
131
132				DescribeFleetCapacity
133
134				=item *
135
136				UpdateFleetCapacity
137
138				=item *
139
140				PutScalingPolicy (automatic scaling)
141
142				=item *
143
144				DescribeScalingPolicies (automatic scaling)
145
146				=item *
147
148				DeleteScalingPolicy (automatic scaling)
149
150				=item *
151
152				DescribeEC2InstanceLimits
153
154				=back
155
156				=item *
157
158				DeleteFleet
159
160				=back
161
162
163				=head1 ATTRIBUTES
164
165
166				=head2 GameSessionActivationTimeoutSeconds => Int
167
168				Maximum amount of time (in seconds) that a game session can remain in
169				status C<ACTIVATING>. If the game session is not active before the
170				timeout, activation is terminated and the game session status is
171				changed to C<TERMINATED>.
172
173
174				=head2 MaxConcurrentGameSessionActivations => Int
175
176				Maximum number of game sessions with status C<ACTIVATING> to allow on
177				an instance simultaneously. This setting limits the amount of instance
178				resources that can be used for new game activations at any one time.
179
180
181				=head2 ServerProcesses => ArrayRef[L<Paws::GameLift::ServerProcess>]
182
183				Collection of server process configurations that describe which server
184				processes to run on each instance in a fleet.
185
186
187
188				=head1 SEE ALSO
189
190				This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
191
192				=head1 BUGS and CONTRIBUTIONS
193
194				The source code is located here: https://github.com/pplu/aws-sdk-perl
195
196				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
197
198				=cut
199