AWS SDK for C++  1.9.128
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTSiteWise::Model::Alarms Class Reference

#include <Alarms.h>

Public Member Functions

 Alarms ()
 
 Alarms (Aws::Utils::Json::JsonView jsonValue)
 
Alarmsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAlarmRoleArn () const
 
bool AlarmRoleArnHasBeenSet () const
 
void SetAlarmRoleArn (const Aws::String &value)
 
void SetAlarmRoleArn (Aws::String &&value)
 
void SetAlarmRoleArn (const char *value)
 
AlarmsWithAlarmRoleArn (const Aws::String &value)
 
AlarmsWithAlarmRoleArn (Aws::String &&value)
 
AlarmsWithAlarmRoleArn (const char *value)
 
const Aws::StringGetNotificationLambdaArn () const
 
bool NotificationLambdaArnHasBeenSet () const
 
void SetNotificationLambdaArn (const Aws::String &value)
 
void SetNotificationLambdaArn (Aws::String &&value)
 
void SetNotificationLambdaArn (const char *value)
 
AlarmsWithNotificationLambdaArn (const Aws::String &value)
 
AlarmsWithNotificationLambdaArn (Aws::String &&value)
 
AlarmsWithNotificationLambdaArn (const char *value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 37 of file Alarms.h.

Constructor & Destructor Documentation

◆ Alarms() [1/2]

Aws::IoTSiteWise::Model::Alarms::Alarms ( )

◆ Alarms() [2/2]

Aws::IoTSiteWise::Model::Alarms::Alarms ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AlarmRoleArnHasBeenSet()

bool Aws::IoTSiteWise::Model::Alarms::AlarmRoleArnHasBeenSet ( ) const
inline

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.

Definition at line 60 of file Alarms.h.

◆ GetAlarmRoleArn()

const Aws::String& Aws::IoTSiteWise::Model::Alarms::GetAlarmRoleArn ( ) const
inline

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.

Definition at line 52 of file Alarms.h.

◆ GetNotificationLambdaArn()

const Aws::String& Aws::IoTSiteWise::Model::Alarms::GetNotificationLambdaArn ( ) const
inline

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

Definition at line 119 of file Alarms.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoTSiteWise::Model::Alarms::Jsonize ( ) const

◆ NotificationLambdaArnHasBeenSet()

bool Aws::IoTSiteWise::Model::Alarms::NotificationLambdaArnHasBeenSet ( ) const
inline

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

Definition at line 129 of file Alarms.h.

◆ operator=()

Alarms& Aws::IoTSiteWise::Model::Alarms::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAlarmRoleArn() [1/3]

void Aws::IoTSiteWise::Model::Alarms::SetAlarmRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 76 of file Alarms.h.

◆ SetAlarmRoleArn() [2/3]

void Aws::IoTSiteWise::Model::Alarms::SetAlarmRoleArn ( const Aws::String value)
inline

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.

Definition at line 68 of file Alarms.h.

◆ SetAlarmRoleArn() [3/3]

void Aws::IoTSiteWise::Model::Alarms::SetAlarmRoleArn ( const char *  value)
inline

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.

Definition at line 84 of file Alarms.h.

◆ SetNotificationLambdaArn() [1/3]

void Aws::IoTSiteWise::Model::Alarms::SetNotificationLambdaArn ( Aws::String &&  value)
inline

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

Definition at line 149 of file Alarms.h.

◆ SetNotificationLambdaArn() [2/3]

void Aws::IoTSiteWise::Model::Alarms::SetNotificationLambdaArn ( const Aws::String value)
inline

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

Definition at line 139 of file Alarms.h.

◆ SetNotificationLambdaArn() [3/3]

void Aws::IoTSiteWise::Model::Alarms::SetNotificationLambdaArn ( const char *  value)
inline

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

Definition at line 159 of file Alarms.h.

◆ WithAlarmRoleArn() [1/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithAlarmRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 100 of file Alarms.h.

◆ WithAlarmRoleArn() [2/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithAlarmRoleArn ( const Aws::String value)
inline

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.

Definition at line 92 of file Alarms.h.

◆ WithAlarmRoleArn() [3/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithAlarmRoleArn ( const char *  value)
inline

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.

Definition at line 108 of file Alarms.h.

◆ WithNotificationLambdaArn() [1/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithNotificationLambdaArn ( Aws::String &&  value)
inline

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

Definition at line 179 of file Alarms.h.

◆ WithNotificationLambdaArn() [2/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithNotificationLambdaArn ( const Aws::String value)
inline

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

Definition at line 169 of file Alarms.h.

◆ WithNotificationLambdaArn() [3/3]

Alarms& Aws::IoTSiteWise::Model::Alarms::WithNotificationLambdaArn ( const char *  value)
inline

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

Definition at line 189 of file Alarms.h.


The documentation for this class was generated from the following file: