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