:doc:`CloudWatch <../../cloudwatch>` / Resource / Alarm

=====
Alarm
=====



.. note::

  Before using anything on this page, please refer to the resources :doc:`user guide <../../../../guide/resources>` for the most recent guidance on using resources.



.. py:class:: CloudWatch.Alarm(name)

  A resource representing an Amazon CloudWatch Alarm::

    
    import boto3
    
    cloudwatch = boto3.resource('cloudwatch')
    alarm = cloudwatch.Alarm('name')

  :type name: string
  :param name: The Alarm's name identifier. This **must** be set.
  




-----------
Identifiers
-----------



Identifiers are properties of a resource that are set upon instantiation of the resource.
For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.

These are the resource's available identifiers:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  name



----------
Attributes
----------



Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.

These are the resource's available attributes:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  actions_enabled
  alarm_actions
  alarm_arn
  alarm_configuration_updated_timestamp
  alarm_description
  alarm_name
  comparison_operator
  datapoints_to_alarm
  dimensions
  evaluate_low_sample_count_percentile
  evaluation_periods
  evaluation_state
  extended_statistic
  insufficient_data_actions
  metric_name
  metrics
  namespace
  ok_actions
  period
  state_reason
  state_reason_data
  state_transitioned_timestamp
  state_updated_timestamp
  state_value
  statistic
  threshold
  threshold_metric_id
  treat_missing_data
  unit



----------
References
----------



References are related resource instances that have a belongs-to relationship.
For more information about references refer to the :ref:`Resources Introduction Guide<references_intro>`.

These are the resource's available references:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  metric



-------
Actions
-------



Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.

These are the resource's available actions:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  delete
  describe_history
  disable_actions
  enable_actions
  get_available_subresources
  load
  reload
  set_state
