Skip to content

cloudwatch set-alarm-state

Temporarily sets the state of an alarm for testing purposes

Description

temporarily sets the state of an alarm for testing purposes

Synopsis

cloudwatch set-alarm-state
    [--site <site>]
    [--region <region>]
    <name>
    --reason <reason>
    [--reason_data <reason_data>]
    --state <state>

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

region - (string)

     AWS region for the service
     Example: --region "region-1"
     Default: _None_      Attributes: optional

name - (string)

     The name of the alarm
     Example: "name-1"
     Default: _None_      Attributes: required

reason - (string)

     The reason that this alarm is set to this specific state, in text format
     Example: --reason "reason-1"
     Default: _None_      Attributes: required

reason_data - (string)

     The reason that this alarm is set to this specific state, in JSON format
     Example: --reason_data "reason_data-1"
     Default: _None_      Attributes: optional

state - (string)

     The value of the state
     Example: --state "state-1"
     Default: _None_      Attributes: required

Examples

cloudwatch set-alarm-state --region "region-1" "name-1" --reason "reason-1" --reason_data "reason_data-1" --state "state-1"

Access Control

To use this command, you need access to the following:

Field Value
Action "update"
Service Type "cloudwatch"
Service Instance
Namespace
Object Type "alarm"
Object ID

Please see Access Control for details.