Connectez-vous à la console
AWS CloudFormation
Guide de l'utilisateur (Version de l'API 2010-05-15)

Documentation AWS » AWS CloudFormation » Guide de l'utilisateur » Référence de modèles » Référence des types de propriété et de ressource AWS » CloudWatch Référence de type de ressource » AWS::CloudWatch::Alarm

AWS::CloudWatch::Alarm

Le type AWS::CloudWatch::Alarm spécifie une alarme et l'associe à la métrique spécifiée ou à l'expression mathématique de la métrique.

Lorsque cette opération crée une alarme, l'état de l'alarme est immédiatement défini sur INSUFFICIENT_DATA. L'alarme est ensuite évaluée et son état est défini de manière appropriée. Toutes les actions associées au nouvel état sont ensuite exécutées.

Lorsque vous mettez à jour une alarme, son état reste inchangé, mais la mise à jour écrase complètement la précédente configuration de l'alarme.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS CloudFormation, utilisez la syntaxe suivante :

JSON

{
  "Type" : "AWS::CloudWatch::Alarm",
  "Properties" : {
      "ActionsEnabled" : Boolean,
      "AlarmActions" : [ String, ... ],
      "AlarmDescription" : String,
      "AlarmName" : String,
      "ComparisonOperator" : String,
      "DatapointsToAlarm" : Integer,
      "Dimensions" : [ Dimension, ... ],
      "EvaluateLowSampleCountPercentile" : String,
      "EvaluationPeriods" : Integer,
      "ExtendedStatistic" : String,
      "InsufficientDataActions" : [ String, ... ],
      "MetricName" : String,
      "Metrics" : [ MetricDataQuery, ... ],
      "Namespace" : String,
      "OKActions" : [ String, ... ],
      "Period" : Integer,
      "Statistic" : String,
      "Threshold" : Double,
      "TreatMissingData" : String,
      "Unit" : String
    }
}

YAML

Type: AWS::CloudWatch::Alarm
Properties: 
  ActionsEnabled: Boolean
  AlarmActions: 
    - String
  AlarmDescription: String
  AlarmName: String
  ComparisonOperator: String
  DatapointsToAlarm: Integer
  Dimensions: 
    - Dimension
  EvaluateLowSampleCountPercentile: String
  EvaluationPeriods: Integer
  ExtendedStatistic: String
  InsufficientDataActions: 
    - String
  MetricName: String
  Metrics: 
    - MetricDataQuery
  Namespace: String
  OKActions: 
    - String
  Period: Integer
  Statistic: String
  Threshold: Double
  TreatMissingData: String
  Unit: String

Propriétés

ActionsEnabled

Indique si des actions doivent être exécutées lorsque l'état de l'alarme change.

Obligatoire : Non

Type : valeur booléenne

Update requires: No interruption

AlarmActions

Liste des actions à exécuter lorsque cette alarme active l'état ALARM à partir de n'importe quel autre état. Précisez chaque action en tant qu'Amazon Resource Name (ARN). Pour de plus amples informations sur la création d'alarmes et les actions que vous pouvez spécifier, veuillez consulter PutMetricAlarm dans la Référence d'API Amazon CloudWatch.

Obligatoire : Non

Type : liste de chaînes

Maximum : 5

Update requires: No interruption

AlarmDescription

Description de l'alarme.

Obligatoire : Non

Type : chaîne

Minimum : 0

Maximum : 1024

Update requires: No interruption

AlarmName

Nom de l'alarme. Si vous ne spécifiez pas de nom, AWS CloudFormation génère un ID physique unique et l'utilise comme nom d'alarme.

Important

Si vous spécifiez un nom, vous ne pouvez pas effectuer de mises à jour nécessitant le remplacement de cette ressource. Vous pouvez effectuer des mises à jour qui ne nécessitent aucune interruption ou en nécessitent une. Si vous devez remplacer la ressource, spécifiez un nouveau nom.

Obligatoire : Non

Type : chaîne

Minimum : 1

Maximum : 255

Update requires: Replacement

ComparisonOperator

Opération arithmétique à utiliser lors de la comparaison de la statistique et du seuil spécifiés. La valeur de statistique spécifiée est utilisée comme premier opérateur.

Vous pouvez spécifier les valeurs suivantes : GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold ou LessThanOrEqualToThreshold.

Obligatoire : Oui

Type : chaîne

Valeurs autorisées : GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanOrEqualToThreshold | LessThanThreshold

Update requires: No interruption

DatapointsToAlarm

Nombre de points de données qui doivent être en violation pour déclencher l'alarme. Elle n'est utilisée que si vous définissez une alarme « M sur N ». Dans ce cas, cette valeur est le M. Pour de plus amples informations, veuillez consulter Évaluation d'une alarme dans le Guide de l'utilisateur Amazon CloudWatch.

Obligatoire : Non

Type : entier

Minimum : 1

Update requires: No interruption

Dimensions

Dimensions de la métrique associée à l'alarme. Pour une alarme basée sur une expression mathématique, vous ne pouvez pas spécifier Dimensions. Au lieu de cela, vous utilisez Metrics.

Obligatoire : Non

Type : liste des Dimension

Maximum : 10

Update requires: No interruption

EvaluateLowSampleCountPercentile

Utilisé uniquement pour les alarmes basées sur les centiles. Si la valeur est ignore, l'état de l'alarme ne change pas pendant les périodes avec trop peu de points de données pour que cela soit significatif statistiquement. Si la valeur est evaluate ou que ce paramètre n'est pas utilisé, l'alarme est toujours évaluée et modifie éventuellement l'état quel que soit le nombre de points de données disponibles.

Obligatoire : Non

Type : chaîne

Minimum : 1

Maximum : 255

Update requires: No interruption

EvaluationPeriods

Nombre de périodes au cours desquelles les données sont comparées au seuil défini.

Obligatoire : Oui

Type : entier

Minimum : 1

Update requires: No interruption

ExtendedStatistic

Statistique sur les centiles pour la métrique associée à l'alarme. Spécifiez une valeur comprise entre p0.0 et p100.

Pour une alarme basée sur une expression mathématique, vous ne pouvez pas spécifier ExtendedStatistic. Au lieu de cela, vous utilisez Metrics.

Obligatoire : Non

Type : chaîne

Modèle : p(\d{1,2}(\.\d{0,2})?|100)

Update requires: No interruption

InsufficientDataActions

Actions à exécuter lorsque cette alarme passe à l'état INSUFFICIENT_DATA à partir de n'importe quel autre état. Chaque action est spécifiée en tant qu'Amazon Resource Name (ARN).

Obligatoire : Non

Type : liste de chaînes

Maximum : 5

Update requires: No interruption

MetricName

Nom de la métrique associée à l'alarme. Il est obligatoire pour une alarme basée sur une métrique. Pour une alarme basée sur une expression mathématique, vous utilisez Metrics à la place et vous ne pouvez pas spécifier MetricName.

Obligatoire : Non

Type : chaîne

Minimum : 1

Maximum : 255

Update requires: No interruption

Metrics

Tableau qui vous permet de créer une alarme basée sur le résultat d'une expression mathématique de métrique. Chaque élément du tableau récupère une métrique ou exécute une expression mathématique.

Si vous spécifiez le paramètre Metrics, vous ne pouvez pas spécifier MetricName, Dimensions, Period, Namespace, Statistic ni ExtendedStatistic.

Obligatoire : Non

Type : Liste pour MetricDataQuery

Update requires: No interruption

Namespace

Espace de noms de la métrique associée à l'alarme. Il est obligatoire pour une alarme basée sur une métrique. Pour une alarme basée sur une expression mathématique, vous ne pouvez pas spécifier Namespace et vous utilisez Metrics à la place.

Obligatoire : Non

Type : chaîne

Minimum : 1

Maximum : 255

Modèle : [^:].*

Update requires: No interruption

OKActions

Actions à exécuter lorsque cette alarme passe à l'état OK à partir de n'importe quel autre état. Chaque action est spécifiée en tant qu'Amazon Resource Name (ARN).

Obligatoire : Non

Type : liste de chaînes

Maximum : 5

Update requires: No interruption

Period

La période, en secondes, au cours de laquelle la statistique est appliquée. Il est obligatoire pour une alarme basée sur une métrique. Pour une alarme basée sur une expression mathématique, vous ne pouvez pas spécifier Period et vous utilisez le paramètre Metrics à la place.

Obligatoire : Non

Type : entier

Minimum : 1

Update requires: No interruption

Statistic

Statistique pour la métrique associée à l'alarme, autre que sur les centiles. Pour les statistiques sur les centiles, utilisez ExtendedStatistic.

Pour une alarme basée sur une expression mathématique, vous ne pouvez pas spécifier Statistic. Au lieu de cela, vous utilisez Metrics.

Obligatoire : Non

Type : chaîne

Valeurs autorisées : Average | Maximum | Minimum | SampleCount | Sum

Update requires: No interruption

Threshold

Valeur à comparer à la statistique spécifiée.

Obligatoire : Oui

Type : double

Update requires: No interruption

TreatMissingData

Définit la façon dont cette alarme doit gérer les points de données manquants. Les valeurs valides sont breaching, notBreaching, ignore et missing. Pour de plus amples informations, veuillez consulter Configuration de la manière dont les alarmes CloudWatch traitent les données manquantes dans le Guide de l'utilisateur Amazon CloudWatch.

Si vous ne spécifiez pas ce paramètre, le comportement par défaut de missing est utilisé.

Obligatoire : Non

Type : chaîne

Minimum : 1

Maximum : 255

Update requires: No interruption

Unit

Unité de la métrique associée à l'alarme. Vous pouvez spécifier les valeurs suivantes : Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second ou None.

Obligatoire : Non

Type : chaîne

Valeurs autorisées : Bits | Bits/Second | Bytes | Bytes/Second | Count | Count/Second | Gigabits | Gigabits/Second | Gigabytes | Gigabytes/Second | Kilobits | Kilobits/Second | Kilobytes | Kilobytes/Second | Megabits | Megabits/Second | Megabytes | Megabytes/Second | Microseconds | Milliseconds | None | Percent | Seconds | Terabits | Terabits/Second | Terabytes | Terabytes/Second

Update requires: No interruption

Valeurs renvoyées

Réf

Lorsque vous transmettez l'ID logique de cette ressource à la fonction intrinsèque Ref, Ref renvoie le nom de l'alarme (TestAlarm, par exemple).

For more information about using the Ref function, see Ref.

Fn::GetAtt

La fonction intrinsèque Fn::GetAtt renvoie une valeur pour un attribut spécifié de ce type. Voici les attributs disponibles et des exemples de valeurs de retour.

Pour plus d'informations sur l'utilisation de la fonction intrinsèque Fn::GetAtt, voir Fn::GetAtt.

Arn

ARN de l'alarme CloudWatch (arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z, par exemple).

Voir aussi