cloudwatch_set_alarm_state: Temporarily sets the state of an alarm for testing purposes

View source: R/cloudwatch_operations.R

cloudwatch_set_alarm_stateR Documentation

Temporarily sets the state of an alarm for testing purposes

Description

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

See https://www.paws-r-sdk.com/docs/cloudwatch_set_alarm_state/ for full documentation.

Usage

cloudwatch_set_alarm_state(
  AlarmName,
  StateValue,
  StateReason,
  StateReasonData = NULL
)

Arguments

AlarmName

[required] The name of the alarm.

StateValue

[required] The value of the state.

StateReason

[required] The reason that this alarm is set to this specific state, in text format.

StateReasonData

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.


paws.management documentation built on Sept. 12, 2023, 1:06 a.m.