File Coverage

blib/lib/Paws/CloudWatch/MetricAlarm.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             package Paws::CloudWatch::MetricAlarm;
2 1     1   299 use Moose;
  1     1   2  
  1         5  
  1         365  
  1         3  
  1         29  
3             has ActionsEnabled => (is => 'ro', isa => 'Bool');
4             has AlarmActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has AlarmArn => (is => 'ro', isa => 'Str');
6             has AlarmConfigurationUpdatedTimestamp => (is => 'ro', isa => 'Str');
7             has AlarmDescription => (is => 'ro', isa => 'Str');
8             has AlarmName => (is => 'ro', isa => 'Str');
9             has ComparisonOperator => (is => 'ro', isa => 'Str');
10             has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]');
11             has EvaluateLowSampleCountPercentile => (is => 'ro', isa => 'Str');
12             has EvaluationPeriods => (is => 'ro', isa => 'Int');
13             has ExtendedStatistic => (is => 'ro', isa => 'Str');
14             has InsufficientDataActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
15             has MetricName => (is => 'ro', isa => 'Str');
16             has Namespace => (is => 'ro', isa => 'Str');
17             has OKActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
18             has Period => (is => 'ro', isa => 'Int');
19             has StateReason => (is => 'ro', isa => 'Str');
20             has StateReasonData => (is => 'ro', isa => 'Str');
21             has StateUpdatedTimestamp => (is => 'ro', isa => 'Str');
22             has StateValue => (is => 'ro', isa => 'Str');
23             has Statistic => (is => 'ro', isa => 'Str');
24             has Threshold => (is => 'ro', isa => 'Num');
25             has TreatMissingData => (is => 'ro', isa => 'Str');
26             has Unit => (is => 'ro', isa => 'Str');
27             1;
28              
29             ### main pod documentation begin ###
30              
31             =head1 NAME
32              
33             Paws::CloudWatch::MetricAlarm
34              
35             =head1 USAGE
36              
37             This class represents one of two things:
38              
39             =head3 Arguments in a call to a service
40              
41             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
42             Each attribute should be used as a named argument in the calls that expect this type of object.
43              
44             As an example, if Att1 is expected to be a Paws::CloudWatch::MetricAlarm object:
45              
46             $service_obj->Method(Att1 => { ActionsEnabled => $value, ..., Unit => $value });
47              
48             =head3 Results returned from an API call
49              
50             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricAlarm object:
51              
52             $result = $service_obj->Method(...);
53             $result->Att1->ActionsEnabled
54              
55             =head1 DESCRIPTION
56              
57             Represents an alarm.
58              
59             =head1 ATTRIBUTES
60              
61              
62             =head2 ActionsEnabled => Bool
63              
64             Indicates whether actions should be executed during any changes to the
65             alarm state.
66              
67              
68             =head2 AlarmActions => ArrayRef[Str|Undef]
69              
70             The actions to execute when this alarm transitions to the C<ALARM>
71             state from any other state. Each action is specified as an Amazon
72             Resource Name (ARN).
73              
74              
75             =head2 AlarmArn => Str
76              
77             The Amazon Resource Name (ARN) of the alarm.
78              
79              
80             =head2 AlarmConfigurationUpdatedTimestamp => Str
81              
82             The time stamp of the last update to the alarm configuration.
83              
84              
85             =head2 AlarmDescription => Str
86              
87             The description of the alarm.
88              
89              
90             =head2 AlarmName => Str
91              
92             The name of the alarm.
93              
94              
95             =head2 ComparisonOperator => Str
96              
97             The arithmetic operation to use when comparing the specified statistic
98             and threshold. The specified statistic value is used as the first
99             operand.
100              
101              
102             =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]
103              
104             The dimensions for the metric associated with the alarm.
105              
106              
107             =head2 EvaluateLowSampleCountPercentile => Str
108              
109             Used only for alarms based on percentiles. If C<ignore>, the alarm
110             state does not change during periods with too few data points to be
111             statistically significant. If C<evaluate> or this parameter is not
112             used, the alarm is always evaluated and possibly changes state no
113             matter how many data points are available.
114              
115              
116             =head2 EvaluationPeriods => Int
117              
118             The number of periods over which data is compared to the specified
119             threshold.
120              
121              
122             =head2 ExtendedStatistic => Str
123              
124             The percentile statistic for the metric associated with the alarm.
125             Specify a value between p0.0 and p100.
126              
127              
128             =head2 InsufficientDataActions => ArrayRef[Str|Undef]
129              
130             The actions to execute when this alarm transitions to the
131             C<INSUFFICIENT_DATA> state from any other state. Each action is
132             specified as an Amazon Resource Name (ARN).
133              
134              
135             =head2 MetricName => Str
136              
137             The name of the metric associated with the alarm.
138              
139              
140             =head2 Namespace => Str
141              
142             The namespace of the metric associated with the alarm.
143              
144              
145             =head2 OKActions => ArrayRef[Str|Undef]
146              
147             The actions to execute when this alarm transitions to the C<OK> state
148             from any other state. Each action is specified as an Amazon Resource
149             Name (ARN).
150              
151              
152             =head2 Period => Int
153              
154             The period, in seconds, over which the statistic is applied.
155              
156              
157             =head2 StateReason => Str
158              
159             An explanation for the alarm state, in text format.
160              
161              
162             =head2 StateReasonData => Str
163              
164             An explanation for the alarm state, in JSON format.
165              
166              
167             =head2 StateUpdatedTimestamp => Str
168              
169             The time stamp of the last update to the alarm state.
170              
171              
172             =head2 StateValue => Str
173              
174             The state value for the alarm.
175              
176              
177             =head2 Statistic => Str
178              
179             The statistic for the metric associated with the alarm, other than
180             percentile. For percentile statistics, use C<ExtendedStatistic>.
181              
182              
183             =head2 Threshold => Num
184              
185             The value to compare with the specified statistic.
186              
187              
188             =head2 TreatMissingData => Str
189              
190             Sets how this alarm is to handle missing data points. If this parameter
191             is omitted, the default behavior of C<missing> is used.
192              
193              
194             =head2 Unit => Str
195              
196             The unit of the metric associated with the alarm.
197              
198              
199              
200             =head1 SEE ALSO
201              
202             This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatch>
203              
204             =head1 BUGS and CONTRIBUTIONS
205              
206             The source code is located here: https://github.com/pplu/aws-sdk-perl
207              
208             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
209              
210             =cut
211