mon-set-alarm-state - Amazon CloudWatch

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

mon-set-alarm-state

Description

Permet de modifier temporairement l'état de l'alarme spécifiée. À la période suivante, l'alarme est définie sur son état VRAI.

Syntaxe

mon-set-alarm-state AlarmName --state-reason value --state-value value [--state-reason-data value] [Common Options]

Options

Name (Nom) Description

AlarmName

Le nom de l'alarme. 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

--state-reason VALUE

Raison pour laquelle cette alarme a été définie sur cet état (lisible par l'utilisateur).

Type : String

Valeurs valides : une chaîne UTF-8 comportant entre 1 et 1 023 caractères.

Par défaut : S.o.

Obligatoire : oui

--state-reason-data VALUE

Raison pour laquelle cette alarme a été définie sur cet état. Ces données sont destinés à être dans un format JSON lisible par la machine.

Type : String

Valeurs valides : Une chaîne JSON lisible par la machine valide comprise entre 1 et 4 000 caractères.

Par défaut : S.o.

Obligatoire : non

--state-value VALUE

État sur lequel l'alarme doit être définie.

Type : énumération

Valeurs valides : ALARM, OK ou INSUFFICIENT_DATA

Par défaut : S.o.

Obligatoire : oui

Options courantes

Nom Description

--aws-credential-file VALUE

L'emplacement du fichier contenant vos AWS informations d'identification. 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 CloudWatch demandes 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 EC2 certificat pour les demandes de signature. Vous pouvez utiliser la variable d'environnement EC2_CERT pour spécifier cette valeur.

Type : String

Valeurs valides : chemin de fichier valide vers le 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 CloudWatch doivent être signées, sinon elles sont rejetées.

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 CloudWatch doivent être signées, sinon elles sont rejetées.

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 : n'importe quelle AWS région, 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 modifie temporairement l'état d'une alarme et affiche OK-Set alarm state value lorsque la demande est réussie.

L'Amazon CloudWatch CLI affiche les erreurs sur stderr.

Exemples

Exemple de demande

Cet exemple définit l'état de l'alarme nommée my-alarm sur OK.

mon-set-alarm-state --alarm-name my-alarm --state OK

Rubriques en relation

Téléchargement

Action connexe

Commande connexe