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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CloudwatchAlarmAction

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CloudwatchAlarmAction data as a 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.

Instance Attribute Summary

• #alarm_name ⇒ String

  The CloudWatch alarm name.

• #role_arn ⇒ String

  The IAM role that allows access to the CloudWatch alarm.

• #state_reason ⇒ String

  The reason for the alarm change.

• #state_value ⇒ String

  The value of the alarm state.

Instance Attribute Details

#alarm_name ⇒ String

The CloudWatch alarm name.

# File 'lib/aws-sdk-iot/types.rb', line 1453

class CloudwatchAlarmAction < Struct.new(
  :role_arn,
  :alarm_name,
  :state_reason,
  :state_value)
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role that allows access to the CloudWatch alarm.

# File 'lib/aws-sdk-iot/types.rb', line 1453

class CloudwatchAlarmAction < Struct.new(
  :role_arn,
  :alarm_name,
  :state_reason,
  :state_value)
  include Aws::Structure
end

#state_reason ⇒ String

The reason for the alarm change.

# File 'lib/aws-sdk-iot/types.rb', line 1453

class CloudwatchAlarmAction < Struct.new(
  :role_arn,
  :alarm_name,
  :state_reason,
  :state_value)
  include Aws::Structure
end

#state_value ⇒ String

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

# File 'lib/aws-sdk-iot/types.rb', line 1453

class CloudwatchAlarmAction < Struct.new(
  :role_arn,
  :alarm_name,
  :state_reason,
  :state_value)
  include Aws::Structure
end