com.amazonaws.services.iotsitewise.model

Class Alarms

java.lang.Object

com.amazonaws.services.iotsitewise.model.Alarms

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Alarms
extends Object
implements Serializable, Cloneable, StructuredPojo

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 Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Alarms()

Method Summary

Modifier and Type	Method and Description
Alarms	clone()
boolean	equals(Object obj)
String	getAlarmRoleArn() 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.
String	getNotificationLambdaArn() The ARN of the Lambda function that manages alarm notifications.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAlarmRoleArn(String alarmRoleArn) 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.
void	setNotificationLambdaArn(String notificationLambdaArn) The ARN of the Lambda function that manages alarm notifications.
String	toString() Returns a string representation of this object.
Alarms	withAlarmRoleArn(String alarmRoleArn) 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.
Alarms	withNotificationLambdaArn(String notificationLambdaArn) The ARN of the Lambda function that manages alarm notifications.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Alarms

public Alarms()

Method Detail

setAlarmRoleArn

public void setAlarmRoleArn(String alarmRoleArn)

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.

Parameters:

alarmRoleArn - 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.

getAlarmRoleArn

public String getAlarmRoleArn()

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:

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.

withAlarmRoleArn

public Alarms withAlarmRoleArn(String alarmRoleArn)

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.

Parameters:

alarmRoleArn - 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:

Returns a reference to this object so that method calls can be chained together.

setNotificationLambdaArn

public void setNotificationLambdaArn(String notificationLambdaArn)

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

Parameters:

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

getNotificationLambdaArn

public String getNotificationLambdaArn()

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

Returns:

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

withNotificationLambdaArn

public Alarms withNotificationLambdaArn(String notificationLambdaArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Alarms clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.