File Coverage

blib/lib/Paws/AutoScaling/StepAdjustment.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::AutoScaling::StepAdjustment;
2 1     1   401 use Moose;
  1         4  
  1         7  
3             has MetricIntervalLowerBound => (is => 'ro', isa => 'Num');
4             has MetricIntervalUpperBound => (is => 'ro', isa => 'Num');
5             has ScalingAdjustment => (is => 'ro', isa => 'Int', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::AutoScaling::StepAdjustment
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::AutoScaling::StepAdjustment object:
24              
25             $service_obj->Method(Att1 => { MetricIntervalLowerBound => $value, ..., ScalingAdjustment => $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::AutoScaling::StepAdjustment object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->MetricIntervalLowerBound
33              
34             =head1 DESCRIPTION
35              
36             Describes an adjustment based on the difference between the value of
37             the aggregated CloudWatch metric and the breach threshold that you've
38             defined for the alarm.
39              
40             For the following examples, suppose that you have an alarm with a
41             breach threshold of 50:
42              
43             =over
44              
45             =item *
46              
47             If you want the adjustment to be triggered when the metric is greater
48             than or equal to 50 and less than 60, specify a lower bound of 0 and an
49             upper bound of 10.
50              
51             =item *
52              
53             If you want the adjustment to be triggered when the metric is greater
54             than 40 and less than or equal to 50, specify a lower bound of -10 and
55             an upper bound of 0.
56              
57             =back
58              
59             There are a few rules for the step adjustments for your step policy:
60              
61             =over
62              
63             =item *
64              
65             The ranges of your step adjustments can't overlap or have a gap.
66              
67             =item *
68              
69             At most one step adjustment can have a null lower bound. If one step
70             adjustment has a negative lower bound, then there must be a step
71             adjustment with a null lower bound.
72              
73             =item *
74              
75             At most one step adjustment can have a null upper bound. If one step
76             adjustment has a positive upper bound, then there must be a step
77             adjustment with a null upper bound.
78              
79             =item *
80              
81             The upper and lower bound can't be null in the same step adjustment.
82              
83             =back
84              
85              
86             =head1 ATTRIBUTES
87              
88              
89             =head2 MetricIntervalLowerBound => Num
90              
91             The lower bound for the difference between the alarm threshold and the
92             CloudWatch metric. If the metric value is above the breach threshold,
93             the lower bound is inclusive (the metric must be greater than or equal
94             to the threshold plus the lower bound). Otherwise, it is exclusive (the
95             metric must be greater than the threshold plus the lower bound). A null
96             value indicates negative infinity.
97              
98              
99             =head2 MetricIntervalUpperBound => Num
100              
101             The upper bound for the difference between the alarm threshold and the
102             CloudWatch metric. If the metric value is above the breach threshold,
103             the upper bound is exclusive (the metric must be less than the
104             threshold plus the upper bound). Otherwise, it is inclusive (the metric
105             must be less than or equal to the threshold plus the upper bound). A
106             null value indicates positive infinity.
107              
108             The upper bound must be greater than the lower bound.
109              
110              
111             =head2 B<REQUIRED> ScalingAdjustment => Int
112              
113             The amount by which to scale, based on the specified adjustment type. A
114             positive value adds to the current capacity while a negative number
115             removes from the current capacity.
116              
117              
118              
119             =head1 SEE ALSO
120              
121             This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
122              
123             =head1 BUGS and CONTRIBUTIONS
124              
125             The source code is located here: https://github.com/pplu/aws-sdk-perl
126              
127             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
128              
129             =cut
130