interface AlarmsProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IoTSiteWise.CfnPortal.AlarmsProperty |
 Java | software.amazon.awscdk.services.iotsitewise.CfnPortal.AlarmsProperty |
 Python | aws_cdk.aws_iotsitewise.CfnPortal.AlarmsProperty |
 TypeScript | @aws-cdk/aws-iotsitewise » CfnPortal » AlarmsProperty |
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 * as iotsitewise from '@aws-cdk/aws-iotsitewise';
const alarmsProperty: iotsitewise.CfnPortal.AlarmsProperty = {
alarmRoleArn: 'alarmRoleArn',
notificationLambdaArn: 'notificationLambdaArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| alarm | string | The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events . |
| notification | string | The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide . |
alarmRoleArn?
Type:
string
(optional)
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .
notificationLambdaArn?
Type:
string
(optional)
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide .