mon-put-metric-alarm - Amazon CloudWatch
DescripciónSintaxisOpcionesOpciones comunesOutputEjemplosTemas relacionados

mon-put-metric-alarm

Descripción

Crea o actualiza una alarma y la asocia a la métrica de Amazon CloudWatch que se especifique. También puede utilizar este comando para asociar uno o varios recursos de Amazon Simple Notification Service (Amazon SNS) a una alarma.

Cuando esta operación crea una alarma, el estado de la alarma se establece inmediatamente en INSUFFICIENT_DATA. La alarma se evalúa y su StateValue se ajusta de forma adecuada. A continuación, se ejecuta cualquier acción asociada a StateValue.

nota

Al actualizar una alarma existente, StateValue se deja sin cambios.

Sintaxis

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]

Opciones

Nombre Descripción

AlarmName

El nombre de la alarma que se va a actualizar o crear. El nombre debe ser único en la cuenta de AWS. Puede establecer también este valor mediante --alarm-name:

Tipo: argumento

Valores válidos: una cadena UTF-8.

Valor predeterminado: n/a

Obligatorio: sí

--actions-enabled VALUE

Indica si las acciones se ejecutan cuando la alarma cambia el estado.

Tipo: booleano

Valores válidos: True o False

Valor predeterminado: True

Obligatorio: no

--alarm-actions VALUE1,VALUE2,VALUE3...

Las acciones (hasta cinco) que se ejecutarán cuando esta alarma pase a un estado ALARM desde cualquier otro. Cada acción se especifica como un nombre de recurso de Amazon (ARN). Mediante las acciones de alarma, puede publicar en un tema de Amazon SNS, activar una política de Amazon EC2 Auto Scaling o detener, terminar o recuperar una instancia de Amazon EC2.

nota

Si está utilizando una cuenta de AWS Identity and Access Management (IAM) para crear o modificar una alarma, debe contar con los siguientes permisos de Amazon EC2:

  • ec2:DescribeInstanceStatus y ec2:DescribeInstances para todas las alarmas en métricas de estado de una instancia EC2 de Amazon EC2.

  • ec2:StopInstances para alarmas con acciones de parada.

  • ec2:TerminateInstances: para alarmas con acciones de terminación.

  • ec2:DescribeInstanceRecoveryAttribute y ec2:RecoverInstances: para alarmas con acciones de recuperación.

Si dispone de permisos de lectura o de escritura para Amazon CloudWatch pero no para Amazon EC2, puede aun crear una alarma, pero las acciones para detener o terminar no se realizarán en la instancia de Amazon EC2. No obstante, si más tarde se le concede permiso para utilizar las API de Amazon EC2 asociadas, se realizarán las acciones de alarma que ha creado con anterioridad. Para obtener más información general sobre las políticas de IAM, consulte Permissions and Policies (Permisos y políticas) en la Guía del usuario de IAM.

Si utiliza un rol de IAM (por ejemplo, un perfil de instancia de Amazon EC2), no puede detener o terminar la instancia con acciones de alarma. Sin embargo, todavía puede ver el estado de alarma y realizar cualquier otra acción, como las notificaciones de Amazon SNS o las políticas de Amazon EC2 Auto Scaling.

Si utiliza las credenciales de seguridad temporales que se otorgan con AWS Security Token Service (AWS STS), no puede detener o terminar una instancia de Amazon EC2 con acciones de alarma.

Tipo: String

Valores válidos: Un ARN para un tema de Amazon SNS, una política de Auto Scaling o un ARN para detener, terminar o recuperar una instancia de Amazon EC2.

Valor predeterminado: n/a

Obligatorio: no

--alarm-description VALUE

La descripción de la alarma.

Tipo: String

Valores válidos: cualquier cadena Unicode entre 1 y 255 caracteres de longitud.

Valor predeterminado: n/a

Obligatorio: no

--comparison-operator VALUE

El operador de comparación utilizado para comparar un punto de datos con el umbral.

Tipo: enumeración

Valores válidos: uno de GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold o LessThanOrEqualToThreshold

Valor predeterminado: n/a

Obligatorio: sí

--dimensions "key1=value1,key2=value2..."

Las dimensiones de la métrica que se va a crear para la que desea crear una alarma. Puede especificar dimensiones dos formas y los formatos se pueden combinar o utilizar indistintamente:

  • Una opción por dimensión: --dimensions "key1=value1" --dimensions "key2=value2"

  • Una opción integral: --dimensions "key1=value1,key2=value2"

Tipo: Map

Valores válidos: una cadena con el formato nombre=valor, donde la clave es el nombre de la dimensión y el valor es el valor de la dimensión. Los nombres de dimensión y los valores deben ser una cadena ANSI de entre 1 y 250 caracteres. Se permite un máximo de 10 dimensiones.

Valor predeterminado: n/a

Obligatorio: no

--evaluation-periods VALUE

El número de periodos consecutivos para los que se compara el valor de la métrica con el umbral para determinar el estado de la alarma.

Tipo: entero

Valores válidos: un número mayor que cero.

Valor predeterminado: n/a

Obligatorio: sí

--metric-name VALUE

El nombre de la métrica en el activar la alarma.

Tipo: argumento

Valores válidos: cualquier cadena ANSI entre 1 y 250 caracteres de longitud.

Valor predeterminado: n/a

Obligatorio: sí

--namespace VALUE

El espacio de nombres de la métrica en el que activar la alarma. Para obtener más información acerca de los espacios de nombres, consulte Espacios de nombres de AWS.

Tipo: String

Valores válidos: cualquier cadena ANSI entre 1 y 250 caracteres de longitud.

Valor predeterminado: n/a

Obligatorio: sí

--ok-actions VALUE1,VALUE2,VALUE3...

Las acciones (hasta cinco) que se ejecutarán cuando esta alarma pase a un estado OK desde cualquier otro. Cada acción se especifica como un nombre de recurso de Amazon (ARN).

Tipo: String

Valores válidos: Un identificador ARN válido.

Valor predeterminado: n/a

Obligatorio: no

--period VALUE

El periodo de la métrica en el que activar la alarma (en segundos).

Tipo: argumento

Valores válidos: un número, en segundos que es un múltiplo de 60 segundos.

Valor predeterminado: n/a

Obligatorio: sí

--statistic VALUE

La estadística de la métrica en la que activar la alarma.

Tipo: enumeración

Valores válidos: SampleCount, Average, Sum, Minimum o Maximum

Valor predeterminado: n/a

Obligatorio: debe especificar --statistic o --extendedstatistic.

--extendedstatistic VALUE

La estadística de percentil en la que activar la alarma.

Tipo: String

Valores válidos: cualquier percentil con hasta dos decimales (por ejemplo, p95.45).

Valor predeterminado: n/a

Obligatorio: debe especificar --statistic o --extendedstatistic.

--threshold VALUE

El umbral con el que se comparan los puntos de datos para determinar el estado de alarma.

Tipo: doble

Valores válidos: un valor doble. Todos los valores debe ser un número comprendido entre 1E-130 y 1E130.

Valor predeterminado: n/a

Obligatorio: sí

--unit VALUE

La unidad de la métrica en el activar la alarma.

Tipo: enumeración

Valores válidos: uno de los siguientes:

  • Segundos

  • Microsegundos

  • Milisegundos

  • Bytes

  • Kilobytes

  • Megabytes

  • Gigabytes

  • Terabytes

  • Bits

  • Kilobits

  • Megabits

  • Gigabits

  • Terabits

  • Porcentaje

  • Recuento

  • Bytes/segundo

  • Kilobytes/segundo

  • Megabytes/segundo

  • Gigabytes/segundo

  • Terabytes/segundo

  • Bits/segundo

  • Kilobits/segundo

  • Megabits/segundo

  • Gigabits/segundo

  • Terabits/segundo

  • Recuento/segundo

  • Ninguno

Valor predeterminado: n/a

Obligatorio: no

--insufficient-data-actions VALUE1,VALUE2,VALUE3...

Las acciones (hasta cinco) que se ejecutarán cuando esta alarma pase a un estado INSUFFICIENT_DATA desde cualquier otro. Cada acción se especifica como un nombre de recurso de Amazon (ARN).

Tipo: String

Valores válidos: Un identificador ARN válido.

Valor predeterminado: n/a

Obligatorio: no

Opciones comunes

Nombre Descripción

--aws-credential-file VALUE

La ubicación del archivo de credenciales de AWS. Puede establecer este valor mediante la variable de entorno AWS_CREDENTIAL_FILE. Si define la variable de entorno o proporciona la ruta de acceso al archivo de credenciales, el archivo debe existir o, de lo contrario, se produce un error en la solicitud. Las solicitudes de CloudWatch deben firmarse con un ID de clave de acceso y una clave de acceso secreta.

Tipo: String

Valores válidos: Ruta de acceso válida de un archivo que contenga el ID de clave de acceso y la clave de acceso secreta.

Valor predeterminado: Utiliza la variable de entorno AWS_CREDENTIAL_FILE, si se establece.

-C, --ec2-cert-file-path VALUE

La ubicación del archivo del certificado EC2 para las solicitudes de firma. Puede utilizar la variable de entorno EC2_CERT para especificar este valor.

Tipo: String

Valores válidos: una ruta de archivo válida al archivo PEM que Amazon EC2 o AWS Identity and Access Management proporcionan.

Valor predeterminado: Utiliza la variable de entorno EC2_CERT, si se establece.

--connection-timeout VALUE

El valor del tiempo de espera de la conexión en segundos.

Tipo: entero

Valores válidos: Cualquier número positivo.

Predeterminado: 30

--delimiter VALUE

El delimitador que se va a utilizar al mostrar resultados delimitados (largos).

Tipo: String

Valores válidos: Cualquier cadena.

Valor predeterminado: Coma (,)

--headers

Si muestra resultados tabulares o delimitados, incluya las cabeceras de columna. Si muestra resultados XML, devuelva las cabeceras HTTP de la solicitud de servicio, si corresponde.

Tipo: Flag

Valores válidos: Cuando hay, muestra cabeceras.

Valor predeterminado: La opción --headers está deshabilitada de forma predeterminada.

-I, --access-key-id VALUE

El ID de clave de acceso que se utilizará, en combinación con la clave secreta, para firmar la solicitud. Esto se debe utilizar en combinación con la clave secreta, de lo contrario, se ignora la opción. Todas las solicitudes a CloudWatch deben estar firmadas; de lo contrario, la solicitud se rechaza.

Tipo: String

Valores válidos: Un ID de clave de acceso válido.

Valor predeterminado: None

-K, --ec2-private-key-file-path VALUE

La clave privada que se va a utilizar para firmar la solicitud. El uso de claves públicas o privadas hace que la CLI utilice SOAP. La solicitud se firma con un certificado público y una clave privada. Este parámetro se debe usar junto con EC2_CERT, de lo contrario, el valor no se tiene en cuenta. El valor de la variable de entorno EC2_PRIVATE_KEY se usará si está configurado, y esta opción no está especificada. Esta opción se pasa por alto si la variable de entorno AWS_CREDENTIAL_FILE está establecida, o se utiliza --aws-credentials-file. Todas las solicitudes a CloudWatch deben estar firmadas; de lo contrario, la solicitud se rechaza.

Tipo: String

Valores válidos: Ruta de acceso a una clave privada ASN.1 válida.

Valor predeterminado: None

--region VALUE

Las solicitudes de región se dirigen a. Puede utilizar la variable de entorno EC2_REGION para especificar el valor. La región se utiliza para crear la URL que se utiliza para llamar a CloudWatch, y debe ser una Región (de AWS) válida de Amazon Web Services.

Tipo: String

Valores válidos: Cualquier Región de AWS, por ejemplo, us-east-1.

Valor predeterminado: us-east-1, a menos que la variable de entorno EC2_REGION esté establecida.

S, --secret-key VALUE

La clave de acceso secreta que se utilizará para firmar la solicitud, junto con un ID de clave de acceso. Este parámetro se debe usar junto con --access-key-id, de lo contrario, la opción no en tiene en cuenta.

Tipo: String

Valores válidos: ID de clave de acceso.

Valor predeterminado: None

--show-empty-fields

Muestra campos vacíos al utilizar (nulo) como espacio disponible para indicar que no se solicitaron estos datos.

Tipo: Flag

Valores válidos: Ninguno

Valor predeterminado: Los campos vacíos no se muestran de forma predeterminada.

--show-request

Muestra la URL que utiliza la CLI para llamar a AWS.

Tipo: Flag

Valores válidos: Ninguno

Valor predeterminado: falso

--show-table, --show-long, --show-xml, --quiet

Especifica cómo se muestran los resultados: en una tabla, delimitados (largos), XML o sin salida (silenciosos). La pantalla --show-table muestra un subconjunto de los datos en forma de ancho de columna fija; --show-long muestra todos los valores devueltos delimitados por un carácter; --show-xml es el retorno sin procesar del servicio; y --quiet suprime toda la salida estándar. Todas las opciones son mutuamente excluyentes, con la prioridad --show-table, --show-long, --show-xml y --quiet.

Tipo: Flag

Valores válidos: Ninguno

Valor predeterminado: --show-table

-U, --url VALUE

La dirección URL que se utiliza para contactarse con CloudWatch. Puede establecer este valor mediante la variable de entorno AWS_CLOUDWATCH_URL. Este valor se usa en combinación con --region para crear la URL esperada. Esta opción anula la dirección URL de la llamada de servicio.

Tipo: String

Valores válidos: Una dirección HTTP o HTTPS válida.

Valor predeterminado: utiliza el valor que se especifica en AWS_CLOUDWATCH_URL, si se establece.

Output

Este comando crea o actualiza una alarma asociada a la métrica especificada.

La CLI de Amazon CloudWatch muestra errores en stderr.

Ejemplos

Ejemplo de solicitud

En este ejemplo se crea una alarma que publica un mensaje a un tema cuando la utilización de la CPU de una instancia EC2 supera el 90 por ciento durante tres períodos consecutivos de un minuto.

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

Temas relacionados

Descargar

Acción relacionada

Comando relacionado