NAME

Paws::CloudWatch::MetricAlarm

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CloudWatch::MetricAlarm object:

  $service_obj->Method(Att1 => { ActionsEnabled => $value, ..., Unit => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricAlarm object:

  $result = $service_obj->Method(...);
  $result->Att1->ActionsEnabled

DESCRIPTION

Represents an alarm.

ATTRIBUTES

ActionsEnabled => Bool

  Indicates whether actions should be executed during any changes to the
alarm state.

AlarmActions => ArrayRef[Str|Undef]

  The actions to execute when this alarm transitions to the C<ALARM>
state from any other state. Each action is specified as an Amazon
Resource Name (ARN).

AlarmArn => Str

  The Amazon Resource Name (ARN) of the alarm.

AlarmConfigurationUpdatedTimestamp => Str

  The time stamp of the last update to the alarm configuration.

AlarmDescription => Str

  The description of the alarm.

AlarmName => Str

  The name of the alarm.

ComparisonOperator => Str

  The arithmetic operation to use when comparing the specified statistic
and threshold. The specified statistic value is used as the first
operand.

DatapointsToAlarm => Int

  The number of datapoints that must be breaching to trigger the alarm.

Dimensions => ArrayRef[Paws::CloudWatch::Dimension]

  The dimensions for the metric associated with the alarm.

EvaluateLowSampleCountPercentile => Str

  Used only for alarms based on percentiles. If C<ignore>, the alarm
state does not change during periods with too few data points to be
statistically significant. If C<evaluate> or this parameter is not
used, the alarm is always evaluated and possibly changes state no
matter how many data points are available.

EvaluationPeriods => Int

  The number of periods over which data is compared to the specified
threshold.

ExtendedStatistic => Str

  The percentile statistic for the metric associated with the alarm.
Specify a value between p0.0 and p100.

InsufficientDataActions => ArrayRef[Str|Undef]

  The actions to execute when this alarm transitions to the
C<INSUFFICIENT_DATA> state from any other state. Each action is
specified as an Amazon Resource Name (ARN).

MetricName => Str

  The name of the metric associated with the alarm.

Metrics => ArrayRef[Paws::CloudWatch::MetricDataQuery]

Namespace => Str

  The namespace of the metric associated with the alarm.

OKActions => ArrayRef[Str|Undef]

  The actions to execute when this alarm transitions to the C<OK> state
from any other state. Each action is specified as an Amazon Resource
Name (ARN).

Period => Int

  The period, in seconds, over which the statistic is applied.

StateReason => Str

  An explanation for the alarm state, in text format.

StateReasonData => Str

  An explanation for the alarm state, in JSON format.

StateUpdatedTimestamp => Str

  The time stamp of the last update to the alarm state.

StateValue => Str

  The state value for the alarm.

Statistic => Str

  The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use C<ExtendedStatistic>.

Threshold => Num

  The value to compare with the specified statistic.

TreatMissingData => Str

  Sets how this alarm is to handle missing data points. If this parameter
is omitted, the default behavior of C<missing> is used.

Unit => Str

  The unit of the metric associated with the alarm.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CloudWatch

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config