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

The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.

ATTRIBUTES

ActionsEnabled => Bool

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

AlarmActions => ArrayRef[Str]

  The list of actions to execute when this alarm transitions into an
C<ALARM> state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only actions supported are
publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.

AlarmArn => Str

  The Amazon Resource Name (ARN) of the alarm.

AlarmConfigurationUpdatedTimestamp => Str

  The time stamp of the last update to the alarm configuration. Amazon
CloudWatch uses Coordinated Universal Time (UTC) when returning time
stamps, which do not accommodate seasonal adjustments such as daylight
savings time. For more information, see Time stamps in the I<Amazon
CloudWatch Developer Guide>.

AlarmDescription => Str

  The description for the alarm.

AlarmName => Str

  The name of the alarm.

ComparisonOperator => Str

  The arithmetic operation to use when comparing the specified
C<Statistic> and C<Threshold>. The specified C<Statistic> value is used
as the first operand.

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

  The list of dimensions associated with the alarm's associated metric.

EvaluationPeriods => Int

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

InsufficientDataActions => ArrayRef[Str]

  The list of actions to execute when this alarm transitions into an
C<INSUFFICIENT_DATA> state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic or triggering
an Auto Scaling policy.

The current WSDL lists this attribute as UnknownActions.

MetricName => Str

  The name of the alarm's metric.

Namespace => Str

  The namespace of alarm's associated metric.

OKActions => ArrayRef[Str]

  The list of actions to execute when this alarm transitions into an
C<OK> state from any other state. Each action is specified as an Amazon
Resource Number (ARN). Currently the only actions supported are
publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.

Period => Int

  The period in seconds over which the statistic is applied.

StateReason => Str

  A human-readable explanation for the alarm's state.

StateReasonData => Str

  An explanation for the alarm's state in machine-readable JSON format

StateUpdatedTimestamp => Str

  The time stamp of the last update to the alarm's state. Amazon
CloudWatch uses Coordinated Universal Time (UTC) when returning time
stamps, which do not accommodate seasonal adjustments such as daylight
savings time. For more information, see Time stamps in the I<Amazon
CloudWatch Developer Guide>.

StateValue => Str

  The state value for the alarm.

Statistic => Str

  The statistic to apply to the alarm's associated metric.

Threshold => Num

  The value against which the specified statistic is compared.

Unit => Str

  The unit of the alarm's associated metric.

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