mon-put-metric-alarm

Description

Crée ou met à jour une alarme et l'associe à la métrique CloudWatch spécifiée. Vous pouvez également utiliser cette commande pour associer une ou plusieurs ressources Amazon Simple Notification Service (Amazon SNS) à une alarme.

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

Note

Lors de la mise à jour d'une alarme existante, la StateValue reste inchangée.

Syntaxe

mon-put-metric-alarm AlarmName --comparison-operator value --evaluation-periods value --metric-name value --namespace value --period value [--statistic value] [--extendedstatistic value] --threshold value [--actions-enabled value] [--alarm-actions value[,value...] ] [--alarm-description value] [--dimensions "key1=value1,key2=value2..."] [--ok-actions value[,value...] ] [--unit value] [--insufficient-data-actions value[,value...]] [Common Options]

Options

Name (Nom)	Description
AlarmName	Nom de l'alarme à mettre à jour ou à créer. Le nom doit être unique au sein de votre compte AWS. Vous pouvez également définir cette valeur à l'aide de --alarm-name. Type : argument Valeurs valides : chaîne UTF-8. Par défaut : S.o. Obligatoire : oui
--actions-enabled VALUE	Indique si les actions doivent être exécutées lorsque l'état de l'alarme change. Type : booléen Valeurs valides : VRAI ou FAUX Par défaut : VRAI Obligatoire : non
--alarm-actions VALUE1,VALUE2,VALUE3...	Actions (jusqu'à cinq) à exécuter lorsque cette alarme active l'état ALARM à partir de n'importe quel autre état. Chaque action est spécifiée en tant qu'Amazon Resource Name (ARN). À l'aide des actions d'alarme, vous pouvez publier sur une rubrique Amazon SNS, activer une stratégie Amazon EC2 Auto Scaling, ou arrêter, résilier ou récupérer une instance Amazon EC2. Note Si vous utilisez un compte AWS Identity and Access Management (IAM) pour créer ou modifier une alarme, vous devez disposer des autorisations Amazon EC2 suivantes : ec2:DescribeInstanceStatus et ec2:DescribeInstances pour toutes les alarmes sur des métriques de statut d'instance Amazon EC2. ec2:StopInstances pour les alarmes avec des actions d'arrêt. ec2:TerminateInstances pour les alarmes avec des actions de fin. ec2:DescribeInstanceRecoveryAttribute et ec2:RecoverInstances pour les alarmes avec des actions de récupération. Si vous disposez des permissions en lecture/écriture pour Amazon CloudWatch, mais pas pour Amazon EC2, vous pouvez toujours créer une alarme, mais les actions d'arrêt ou de fin ne seront pas exécutées sur l'instance Amazon EC2. Toutefois, si vous êtes autorisé ultérieurement à utiliser les API Amazon EC2 associées, les actions d'alarme que vous avez créées précédemment seront exécutées. Pour plus d'informations sur les autorisations IAM, consultez Autorisations et stratégies dans le IAM Guide de l'utilisateur. Si vous utilisez un rôle IAM (par exemple, un profil d'instance Amazon EC2), vous ne pouvez pas arrêter ou résilier une instance à l'aide d'actions d'alarme. Toutefois, vous pouvez quand même afficher l'état de l'alarme et effectuer d'autres actions comme des notifications Amazon SNS ou des stratégies Amazon EC2 Auto Scaling. Si vous utilisez des informations d'identification temporaires octroyées à l'aide de AWS Security Token Service (AWS STS), vous ne pouvez pas arrêter ou supprimer une instance Amazon EC2 à l'aide d'actions d'alarme. Type : String Valeurs valides : ARN pour une rubrique Amazon SNS, une stratégie Auto Scaling ou un ARN pour arrêter, résilier ou récupérer une instance Amazon EC2. Par défaut : S.o. Obligatoire : non
--alarm-description VALUE	Description de l'alarme. Type : String Valeurs valides : n'importe quelle chaîne Unicode comportant entre 1 et 255 caractères. Par défaut : S.o. Obligatoire : non
--comparison-operator VALUE	Opérateur de comparaison utilisé pour comparer des points de données au seuil. Type : énumération Valeurs valides : parmi GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold ou LessThanOrEqualToThreshold Par défaut : S.o. Obligatoire : oui
--dimensions "key1=value1,key2=value2..."	Dimensions de la métrique à créer pour laquelle vous voulez créer une alarme. Vous pouvez spécifier les dimensions de deux manières et les formats peuvent être combinés ou utilisés de façon interchangeable : Une option par dimension : --dimensions "key1=value1" --dimensions "key2=value2" Option tout en un : --dimensions "key1=value1,key2=value2" Type : carte Valeurs valides : une chaîne au format name=value, où la clé est le nom de la dimension et la valeur est la valeur de la dimension. Les noms de dimension et les valeurs doivent être une chaîne ANSI comportant entre 1 et 250 caractères. 10 dimensions au maximum sont autorisées. Par défaut : S.o. Obligatoire : non
--evaluation-periods VALUE	Nombre de périodes consécutives pour lesquelles la valeur de la métrique est comparée au seuil pour déterminer le statut de l'alarme. Type : entier Valeurs valides : un nombre supérieur à zéro. Par défaut : S.o. Obligatoire : oui
--metric-name VALUE	Nom de la métrique sur laquelle créer l'alarme. Type : argument Valeurs valides : une chaîne ANSI comportant entre 1 et 250 caractères. Par défaut : S.o. Obligatoire : oui
--namespace VALUE	Espace de noms de la métrique sur laquelle créer l'alarme. Pour plus d'informations sur les espaces de noms, consultez AWS Espaces de noms. Type : String Valeurs valides : une chaîne ANSI comportant entre 1 et 250 caractères. Par défaut : S.o. Obligatoire : oui
--ok-actions VALUE1,VALUE2,VALUE3...	Actions (jusqu'à cinq) à exécuter lorsque cette alarme active l'état OK à partir de n'importe quel autre état. Chaque action est spécifiée en tant qu'Amazon Resource Name (ARN). Type : String Valeurs valides : un identifiant ARN valide. Par défaut : S.o. Obligatoire : non
--period VALUE	Période de la métrique sur laquelle créer l'alarme (en secondes). Type : argument Valeurs valides : un nombre (en secondes) qui est un multiple de 60 secondes. Par défaut : S.o. Obligatoire : oui
--statistic VALUE	Statistique de la métrique sur laquelle créer l'alarme. Type : énumération Valeurs valides : exemple de comptage, Moyenne, Somme, Minimum ou Maximum Par défaut : S.o. Obligatoire : vous devez spécifier --statistic ou --extendedstatistic.
--extendedstatistic VALUE	Statistique des percentiles de la métrique sur laquelle créer l'alarme. Type : String Valeurs valides : n'importe quel centile avec deux décimales maximum (par exemple, p95.45). Par défaut : S.o. Obligatoire : vous devez spécifier --statistic ou --extendedstatistic.
--threshold VALUE	Seuil auquel les points de données sont comparés pour déterminer l'état de l'alarme. Type : double Valeurs valides : une valeur double. Toutes les valeurs doivent être un nombre compris entre et 1E-130 et 1E130. Par défaut : S.o. Obligatoire : oui
--unit VALUE	Unité de la métrique sur laquelle créer l'alarme. Type : énumération Valeurs valides : l'une des valeurs suivantes : Secondes Microsecondes Millisecondes Octets Kilooctets Mégaoctets Gigaoctets Téra-octets Bits Kilobits Megabits Gigabits Terabits Pourcentage Nombre Octets/seconde Kilo-octets/seconde Mega-octets/seconde Giga-octets/seconde Tera-octets/seconde Bits/seconde Kilobits/seconde Megabits/seconde Gigabits/seconde Terabits/seconde Nombre/seconde Aucun Par défaut : S.o. Obligatoire : non
--insufficient-data-actions VALUE1,VALUE2,VALUE3...	Actions (jusqu'à cinq) à exécuter lorsque cette alarme active l'état INSUFFICIENT_DATA à partir de n'importe quel autre état. Chaque action est spécifiée en tant qu'Amazon Resource Name (ARN). Type : String Valeurs valides : un identifiant ARN valide. Par défaut : S.o. Obligatoire : non

Options courantes

Nom	Description
--aws-credential-file VALUE	Emplacement du fichier avec vos informations d'identification AWS. Vous pouvez définir cette valeur à l'aide de la variable d'environnement AWS_CREDENTIAL_FILE. Si vous définissez la variable d'environnement ou si vous fournissez le chemin d'accès au fichier d'informations d'identification, le fichier doit exister ou la demande échoue. Toutes les demandes CloudWatch doivent être signées à l'aide de votre identifiant de clé d'accès et de votre clé d'accès secrète. Type : String Valeurs valides : chemin d'accès valide à un fichier contenant votre identifiant de clé d'accès et votre clé d'accès secrète. Par défaut : utilise la variable d'environnement AWS_CREDENTIAL_FILE, si elle est définie.
-C, --ec2-cert-file-path VALUE	Emplacement de votre fichier de certificat EC2 pour les demandes de signature. Vous pouvez utiliser la variable d'environnement EC2_CERT pour spécifier cette valeur. Type : String Valeurs valides : chemin d'accès valide au fichier PEM fourni par Amazon EC2 ou AWS Identity and Access Management. Par défaut : utilise la variable d'environnement EC2_CERT, si elle est définie.
--connection-timeout VALUE	Valeur d'expiration de la connexion, en secondes. Type : entier Valeurs valides : tout nombre positif. Valeur par défaut : 30
--delimiter VALUE	Le délimiteur à utiliser lors de l'affichage des résultats délimités (longs). Type : String Valeurs valides : toute chaîne. Par défaut : virgule (,)
--headers	Si vous affichez des résultats tabulaires ou délimités, incluez les en-têtes de colonne. Si vous affichez des résultats XML, renvoyez les en-têtes HTTP de la demande de service, le cas échéant. Type : indicateur Valeurs valides : lorsqu'elles sont présentes, affiche les en-têtes. Par défaut : l'option --headers est désactivée par défaut.
-I, --access-key-id VALUE	L'identifiant de clé d'accès utilisé conjointement à la clé secrète pour signer la demande. Cela doit être utilisé conjointement à --secret-key, sinon l'option est ignorée. Toutes les demandes adressées à CloudWatch doivent être signées, sinon la demande est rejetée. Type : String Valeurs valides : un identifiant de clé d'accès valide. Par défaut : aucun
-K, --ec2-private-key-file-path VALUE	La clé privée utilisée pour signer la demande. L'utilisation de clés publiques/privées entraîne l'utilisation de SOAP par la CLI. La demande est signée à l'aide d'un certificat public et d'une clé privée. Ce paramètre doit être utilisé en conjonction avec EC2_CERT, sinon la valeur est ignorée. La valeur de la variable d'environnement EC2_PRIVATE_KEY sera utilisée si elle est définie, et cette option n'est pas spécifiée. Cette option est ignorée si la variable d'environnement AWS_CREDENTIAL_FILE est définie, ou si --aws-credentials-file est utilisé. Toutes les demandes adressées à CloudWatch doivent être signées, sinon la demande est rejetée. Type : String Valeurs valides : chemin d'accès à une clé privée ASN.1 valide. Par défaut : aucun
--region VALUE	Les demandes de région sont dirigées vers. Vous pouvez utiliser la variable d'environnement EC2_REGION pour spécifier la valeur. La région est utilisée pour créer l'URL utilisée pour appeler CloudWatch et doit être une région Amazon Web Services (AWS) valide. Type : String Valeurs valides : toute région AWS, par exemple, us-east-1. Par défaut : us-east-1, sauf si la variable d'environnement EC2_REGION est définie.
S, --secret-key VALUE	La clé d'accès secrète utilisée pour signer la demande, en conjonction avec un identifiant de clé d'accès. Ce paramètre doit être utilisé en conjonction avec --access-key-id, sinon cette option est ignorée. Type : String Valeurs valides : votre identifiant de clé d'accès. Par défaut : aucun
--show-empty-fields	Affiche les champs vides utilisant (nil) comme espace réservé pour indiquer que ces données n'ont pas été demandées. Type : indicateur Valeurs valides : aucune Par défaut : les champs vides ne sont pas affichés par défaut.
--show-request	Affiche l'URL utilisée par l'interface de ligne de commande (CLI) pour appeler AWS. Type : indicateur Valeurs valides : aucune Par défaut : FAUX
--show-table, --show-long, --show-xml, --quiet	Spécifie comment les résultats sont affichés : dans une table, délimités (long), XML ou sans sortie (silencieux). L'affichage --show-table montre un sous-ensemble des données sous forme de largeur de colonne fixe ; --show-long montre toutes les valeurs renvoyées délimitées par un caractère ; --show-xml est le rendement brut du service et --quiet supprime toutes les sorties standard. Toutes les options sont mutuellement exclusives, avec la priorité --show-table, --show-long, --show-xml, et --quiet. Type : indicateur Valeurs valides : aucune Par défaut : --show-table
-U, --url VALUE	URL utilisée pour contacter CloudWatch. Vous pouvez définir cette valeur à l'aide de la variable d'environnement AWS_CLOUDWATCH_URL. Cette valeur est utilisée conjointement avec --region pour créer l'URL attendue. Cette option remplace l'URL de l'appel de service. Type : String Valeurs valides : une URL HTTP ou HTTPS valide. Par défaut : utilise la valeur spécifiée dans AWS_CLOUDWATCH_URL, si elle est définie.

Sortie

Cette commande permet de créer ou de mettre à jour une alarme associée à la métrique spécifiée.

L'interface de ligne de commande (CLI) Amazon CloudWatch affiche des erreurs sur stderr.

Exemples

Exemple de demande

Cet exemple crée une alarme qui publie un message dans une rubrique lorsque l'utilisation de l'UC d'une instance EC2 dépasse 90 % pendant trois périodes d'une minute consécutives.

mon-put-metric-alarm --alarm-name my-alarm --alarm-description "some desc" \
--metric-name CPUUtilization --namespace AWS/EC2 --statistic Average  --period 60 --threshold 90 \
--comparison-operator GreaterThanThreshold  --dimensions InstanceId=i-abcdef --evaluation-periods 3  \
--unit Percent --alarm-actions arn:aws:sns:us-east-1:1234567890:my-topic

Rubriques en relation

Téléchargement

• Configuration de l'interface de ligne de commande

Action connexe

• PutMetricAlarm (Placer l'alerte pour métrique)

Commande connexe

• mon-put-data