Class: Aws::IoTSiteWise::Types::Alarms

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::Alarms

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see [Monitoring with alarms] in the *IoT SiteWise Application Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alarm_role_arn ⇒ String

  The [ARN] of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

• #notification_lambda_arn ⇒ String

  The [ARN] of the Lambda function that manages alarm notifications.

Instance Attribute Details

#alarm_role_arn ⇒ String

The [ARN] of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 214

class Alarms < Struct.new(
  :alarm_role_arn,
  :notification_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_lambda_arn ⇒ String

The [ARN] of the Lambda function that manages alarm notifications. For more information, see [Managing alarm notifications] in the *IoT Events Developer Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 214

class Alarms < Struct.new(
  :alarm_role_arn,
  :notification_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end