Package software.amazon.awscdk.services.iotsitewise

Interface CfnPortal.AlarmsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPortal.AlarmsProperty.Jsii$Proxy

Enclosing class:

CfnPortal

@Stability(Stable)
public static interface CfnPortal.AlarmsProperty
extends software.amazon.jsii.JsiiSerializable

Contains the configuration information of an alarm created in an AWS 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 AWS IoT SiteWise Application Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 AlarmsProperty alarmsProperty = AlarmsProperty.builder()
         .alarmRoleArn("alarmRoleArn")
         .notificationLambdaArn("notificationLambdaArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPortal.AlarmsProperty.Builder	A builder for CfnPortal.AlarmsProperty
static final class	CfnPortal.AlarmsProperty.Jsii$Proxy	An implementation for CfnPortal.AlarmsProperty

Method Summary

Modifier and Type	Method	Description
static CfnPortal.AlarmsProperty.Builder	builder()
default String	getAlarmRoleArn()	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .
default String	getNotificationLambdaArn()	The ARN of the Lambda function that manages alarm notifications.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmRoleArn

@Stability(Stable)
@Nullable
default String getAlarmRoleArn()

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-alarmrolearn

getNotificationLambdaArn

@Stability(Stable)
@Nullable
default String getNotificationLambdaArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-notificationlambdaarn

builder

@Stability(Stable)
static CfnPortal.AlarmsProperty.Builder builder()

Returns:

a CfnPortal.AlarmsProperty.Builder of CfnPortal.AlarmsProperty