File Coverage

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