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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/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 collapse

Instance Attribute Details

#alarm_nameString

The CloudWatch alarm name.

Returns:

  • (String)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 771

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

#role_arnString

The IAM role that allows access to the CloudWatch alarm.

Returns:

  • (String)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 771

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

#state_reasonString

The reason for the alarm change.

Returns:

  • (String)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 771

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

#state_valueString

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

Returns:

  • (String)


771
772
773
774
775
776
777
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 771

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