Skip to content
v2.276.0

AlarmsProperty Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const alarmsProperty: iotsitewise.CfnPortal.AlarmsProperty = {
  alarmRoleArn: 'alarmRoleArn',
  notificationLambdaArn: 'notificationLambdaArn',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotsitewise as iotsitewise

alarms_property = iotsitewise.CfnPortal.AlarmsProperty(
    alarm_role_arn="alarmRoleArn",
    notification_lambda_arn="notificationLambdaArn"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTSiteWise;

var alarmsProperty = new AlarmsProperty {
    AlarmRoleArn = "alarmRoleArn",
    NotificationLambdaArn = "notificationLambdaArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

alarmsProperty := &AlarmsProperty{
	AlarmRoleArn: jsii.String("alarmRoleArn"),
	NotificationLambdaArn: jsii.String("notificationLambdaArn"),
}

Properties ​

alarmRoleArnoptionalstringalarm_role_arnoptionalstralarmRoleArnoptionalStringAlarmRoleArnoptionalstringAlarmRoleArnoptional*string#
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .
notificationLambdaArnoptionalstringnotification_lambda_arnoptionalstrnotificationLambdaArnoptionalStringNotificationLambdaArnoptionalstringNotificationLambdaArnoptional*string#
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Lambda function that manages alarm notifications. For more information, see [Managing alarm notifications](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) in the *AWS IoT Events Developer Guide* .