You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::CloudwatchAlarmAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CloudwatchAlarmAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  role_arn: "AwsArn", # required
  alarm_name: "AlarmName", # required
  state_reason: "StateReason", # required
  state_value: "StateValue", # required
}

Describes an action that updates a CloudWatch alarm.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_name ⇒ String

The CloudWatch alarm name.

Returns:

  • (String) —

    The CloudWatch alarm name.

#role_arn ⇒ String

The IAM role that allows access to the CloudWatch alarm.

Returns:

  • (String) —

    The IAM role that allows access to the CloudWatch alarm.

#state_reason ⇒ String

The reason for the alarm change.

Returns:

  • (String) —

    The reason for the alarm change.

#state_value ⇒ String

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

Returns:

  • (String) —

    The value of the alarm state.