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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass Alarms data as a hash:

{
  alarm_role_arn: "ARN", # required
  notification_lambda_arn: "ARN",
}

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alarm_role_arn ⇒ String

  The [ARN][1] 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][1] 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.

Returns:

• (String)

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

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.

Returns:

• (String)

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

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