File Coverage

blib/lib/Paws/GameLift/PutScalingPolicy.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::GameLift::PutScalingPolicy;
3 1     1   506 use Moose;
  1         3  
  1         7  
4             has ComparisonOperator => (is => 'ro', isa => 'Str', required => 1);
5             has EvaluationPeriods => (is => 'ro', isa => 'Int', required => 1);
6             has FleetId => (is => 'ro', isa => 'Str', required => 1);
7             has MetricName => (is => 'ro', isa => 'Str', required => 1);
8             has Name => (is => 'ro', isa => 'Str', required => 1);
9             has ScalingAdjustment => (is => 'ro', isa => 'Int', required => 1);
10             has ScalingAdjustmentType => (is => 'ro', isa => 'Str', required => 1);
11             has Threshold => (is => 'ro', isa => 'Num', required => 1);
12              
13 1     1   6807 use MooseX::ClassAttribute;
  1         3  
  1         9  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutScalingPolicy');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::PutScalingPolicyOutput');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::GameLift::PutScalingPolicy - Arguments for method PutScalingPolicy on Paws::GameLift
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method PutScalingPolicy on the
29             Amazon GameLift service. Use the attributes of this class
30             as arguments to method PutScalingPolicy.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScalingPolicy.
33              
34             As an example:
35              
36             $service_obj->PutScalingPolicy(Att1 => $value1, Att2 => $value2, ...);
37              
38             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> ComparisonOperator => Str
44              
45             Comparison operator to use when measuring the metric against the
46             threshold value.
47              
48             Valid values are: C<"GreaterThanOrEqualToThreshold">, C<"GreaterThanThreshold">, C<"LessThanThreshold">, C<"LessThanOrEqualToThreshold">
49              
50             =head2 B<REQUIRED> EvaluationPeriods => Int
51              
52             Length of time (in minutes) the metric must be at or beyond the
53             threshold before a scaling event is triggered.
54              
55              
56              
57             =head2 B<REQUIRED> FleetId => Str
58              
59             Unique identifier for a fleet to apply this policy to.
60              
61              
62              
63             =head2 B<REQUIRED> MetricName => Str
64              
65             Name of the Amazon GameLift-defined metric that is used to trigger an
66             adjustment.
67              
68             =over
69              
70             =item *
71              
72             B<ActivatingGameSessions> E<ndash> number of game sessions in the
73             process of being created (game session status = C<ACTIVATING>).
74              
75             =item *
76              
77             B<ActiveGameSessions> E<ndash> number of game sessions currently
78             running (game session status = C<ACTIVE>).
79              
80             =item *
81              
82             B<CurrentPlayerSessions> E<ndash> number of active or reserved player
83             sessions (player session status = C<ACTIVE> or C<RESERVED>).
84              
85             =item *
86              
87             B<AvailablePlayerSessions> E<ndash> number of player session slots
88             currently available in active game sessions across the fleet,
89             calculated by subtracting a game session's current player session count
90             from its maximum player session count. This number includes game
91             sessions that are not currently accepting players (game session
92             C<PlayerSessionCreationPolicy> = C<DENY_ALL>).
93              
94             =item *
95              
96             B<ActiveInstances> E<ndash> number of instances currently running a
97             game session.
98              
99             =item *
100              
101             B<IdleInstances> E<ndash> number of instances not currently running a
102             game session.
103              
104             =back
105              
106              
107             Valid values are: C<"ActivatingGameSessions">, C<"ActiveGameSessions">, C<"ActiveInstances">, C<"AvailableGameSessions">, C<"AvailablePlayerSessions">, C<"CurrentPlayerSessions">, C<"IdleInstances">, C<"PercentAvailableGameSessions">, C<"PercentIdleInstances">, C<"QueueDepth">, C<"WaitTime">
108              
109             =head2 B<REQUIRED> Name => Str
110              
111             Descriptive label that is associated with a scaling policy. Policy
112             names do not need to be unique. A fleet can have only one scaling
113             policy with the same name.
114              
115              
116              
117             =head2 B<REQUIRED> ScalingAdjustment => Int
118              
119             Amount of adjustment to make, based on the scaling adjustment type.
120              
121              
122              
123             =head2 B<REQUIRED> ScalingAdjustmentType => Str
124              
125             Type of adjustment to make to a fleet's instance count (see
126             FleetCapacity):
127              
128             =over
129              
130             =item *
131              
132             B<ChangeInCapacity> E<ndash> add (or subtract) the scaling adjustment
133             value from the current instance count. Positive values scale up while
134             negative values scale down.
135              
136             =item *
137              
138             B<ExactCapacity> E<ndash> set the instance count to the scaling
139             adjustment value.
140              
141             =item *
142              
143             B<PercentChangeInCapacity> E<ndash> increase or reduce the current
144             instance count by the scaling adjustment, read as a percentage.
145             Positive values scale up while negative values scale down; for example,
146             a value of "-10" scales the fleet down by 10%.
147              
148             =back
149              
150              
151             Valid values are: C<"ChangeInCapacity">, C<"ExactCapacity">, C<"PercentChangeInCapacity">
152              
153             =head2 B<REQUIRED> Threshold => Num
154              
155             Metric value used to trigger a scaling event.
156              
157              
158              
159              
160             =head1 SEE ALSO
161              
162             This class forms part of L<Paws>, documenting arguments for method PutScalingPolicy in L<Paws::GameLift>
163              
164             =head1 BUGS and CONTRIBUTIONS
165              
166             The source code is located here: https://github.com/pplu/aws-sdk-perl
167              
168             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
169              
170             =cut
171