blib/lib/Paws/Lightsail/Alarm.pm untested

filter: Statementstmt 0.0% 0 / 43 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 44 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Lightsail::Alarm;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']);
5 has ComparisonOperator => (is => 'ro', isa => 'Str', request_name => 'comparisonOperator', traits => ['NameInRequest']);
6 has ContactProtocols => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'contactProtocols', traits => ['NameInRequest']);
7 has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']);
8 has DatapointsToAlarm => (is => 'ro', isa => 'Int', request_name => 'datapointsToAlarm', traits => ['NameInRequest']);
9 has EvaluationPeriods => (is => 'ro', isa => 'Int', request_name => 'evaluationPeriods', traits => ['NameInRequest']);
10 has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']);
11 has MetricName => (is => 'ro', isa => 'Str', request_name => 'metricName', traits => ['NameInRequest']);
12 has MonitoredResourceInfo => (is => 'ro', isa => 'Paws::Lightsail::MonitoredResourceInfo', request_name => 'monitoredResourceInfo', traits => ['NameInRequest']);
13 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
14 has NotificationEnabled => (is => 'ro', isa => 'Bool', request_name => 'notificationEnabled', traits => ['NameInRequest']);
15 has NotificationTriggers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'notificationTriggers', traits => ['NameInRequest']);
16 has Period => (is => 'ro', isa => 'Int', request_name => 'period', traits => ['NameInRequest']);
17 has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']);
18 has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']);
19 has Statistic => (is => 'ro', isa => 'Str', request_name => 'statistic', traits => ['NameInRequest']);
20 has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']);
21 has Threshold => (is => 'ro', isa => 'Num', request_name => 'threshold', traits => ['NameInRequest']);
22 has TreatMissingData => (is => 'ro', isa => 'Str', request_name => 'treatMissingData', traits => ['NameInRequest']);
23 has Unit => (is => 'ro', isa => 'Str', request_name => 'unit', traits => ['NameInRequest']);
24  
25 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::Lightsail::Alarm
32  
33 =head1 USAGE
34  
35 This class represents one of two things:
36  
37 =head3 Arguments in a call to a service
38  
39 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
40 Each attribute should be used as a named argument in the calls that expect this type of object.
41  
42 As an example, if Att1 is expected to be a Paws::Lightsail::Alarm object:
43  
44 $service_obj->Method(Att1 => { Arn => $value, ..., Unit => $value });
45  
46 =head3 Results returned from an API call
47  
48 Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::Alarm object:
49  
50 $result = $service_obj->Method(...);
51 $result->Att1->Arn
52  
53 =head1 DESCRIPTION
54  
55 Describes an alarm.
56  
57 An alarm is a way to monitor your Amazon Lightsail resource metrics.
58 For more information, see Alarms in Amazon Lightsail
59 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 Arn => Str
65  
66 The Amazon Resource Name (ARN) of the alarm.
67  
68  
69 =head2 ComparisonOperator => Str
70  
71 The arithmetic operation used when comparing the specified statistic
72 and threshold.
73  
74  
75 =head2 ContactProtocols => ArrayRef[Str|Undef]
76  
77 The contact protocols for the alarm, such as C<Email>, C<SMS> (text
78 messaging), or both.
79  
80  
81 =head2 CreatedAt => Str
82  
83 The timestamp when the alarm was created.
84  
85  
86 =head2 DatapointsToAlarm => Int
87  
88 The number of data points that must not within the specified threshold
89 to trigger the alarm.
90  
91  
92 =head2 EvaluationPeriods => Int
93  
94 The number of periods over which data is compared to the specified
95 threshold.
96  
97  
98 =head2 Location => L<Paws::Lightsail::ResourceLocation>
99  
100 An object that lists information about the location of the alarm.
101  
102  
103 =head2 MetricName => Str
104  
105 The name of the metric associated with the alarm.
106  
107  
108 =head2 MonitoredResourceInfo => L<Paws::Lightsail::MonitoredResourceInfo>
109  
110 An object that lists information about the resource monitored by the
111 alarm.
112  
113  
114 =head2 Name => Str
115  
116 The name of the alarm.
117  
118  
119 =head2 NotificationEnabled => Bool
120  
121 Indicates whether the alarm is enabled.
122  
123  
124 =head2 NotificationTriggers => ArrayRef[Str|Undef]
125  
126 The alarm states that trigger a notification.
127  
128  
129 =head2 Period => Int
130  
131 The period, in seconds, over which the statistic is applied.
132  
133  
134 =head2 ResourceType => Str
135  
136 The Lightsail resource type (e.g., C<Alarm>).
137  
138  
139 =head2 State => Str
140  
141 The current state of the alarm.
142  
143 An alarm has the following possible states:
144  
145 =over
146  
147 =item *
148  
149 C<ALARM> - The metric is outside of the defined threshold.
150  
151 =item *
152  
153 C<INSUFFICIENT_DATA> - The alarm has just started, the metric is not
154 available, or not enough data is available for the metric to determine
155 the alarm state.
156  
157 =item *
158  
159 C<OK> - The metric is within the defined threshold.
160  
161 =back
162  
163  
164  
165 =head2 Statistic => Str
166  
167 The statistic for the metric associated with the alarm.
168  
169 The following statistics are available:
170  
171 =over
172  
173 =item *
174  
175 C<Minimum> - The lowest value observed during the specified period. Use
176 this value to determine low volumes of activity for your application.
177  
178 =item *
179  
180 C<Maximum> - The highest value observed during the specified period.
181 Use this value to determine high volumes of activity for your
182 application.
183  
184 =item *
185  
186 C<Sum> - All values submitted for the matching metric added together.
187 You can use this statistic to determine the total volume of a metric.
188  
189 =item *
190  
191 C<Average> - The value of Sum / SampleCount during the specified
192 period. By comparing this statistic with the Minimum and Maximum
193 values, you can determine the full scope of a metric and how close the
194 average use is to the Minimum and Maximum values. This comparison helps
195 you to know when to increase or decrease your resources.
196  
197 =item *
198  
199 C<SampleCount> - The count, or number, of data points used for the
200 statistical calculation.
201  
202 =back
203  
204  
205  
206 =head2 SupportCode => Str
207  
208 The support code. Include this code in your email to support when you
209 have questions about your Lightsail alarm. This code enables our
210 support team to look up your Lightsail information more easily.
211  
212  
213 =head2 Threshold => Num
214  
215 The value against which the specified statistic is compared.
216  
217  
218 =head2 TreatMissingData => Str
219  
220 Specifies how the alarm handles missing data points.
221  
222 An alarm can treat missing data in the following ways:
223  
224 =over
225  
226 =item *
227  
228 C<breaching> - Assume the missing data is not within the threshold.
229 Missing data counts towards the number of times the metric is not
230 within the threshold.
231  
232 =item *
233  
234 C<notBreaching> - Assume the missing data is within the threshold.
235 Missing data does not count towards the number of times the metric is
236 not within the threshold.
237  
238 =item *
239  
240 C<ignore> - Ignore the missing data. Maintains the current alarm state.
241  
242 =item *
243  
244 C<missing> - Missing data is treated as missing.
245  
246 =back
247  
248  
249  
250 =head2 Unit => Str
251  
252 The unit of the metric associated with the alarm.
253  
254  
255  
256 =head1 SEE ALSO
257  
258 This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail>
259  
260 =head1 BUGS and CONTRIBUTIONS
261  
262 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
263  
264 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
265  
266 =cut
267