Class CfnPortal.AlarmsProperty

Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

Inheritance

object

CfnPortal.AlarmsProperty

Implements

CfnPortal.IAlarmsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPortal.AlarmsProperty : CfnPortal.IAlarmsProperty

Syntax (vb)

Public Class CfnPortal.AlarmsProperty Implements CfnPortal.IAlarmsProperty

Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples

// 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"
             };

Synopsis

Constructors

AlarmsProperty()

Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

Properties

AlarmRoleArn	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	The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide .

Constructors

AlarmsProperty()

Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

public AlarmsProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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"
             };

Properties

AlarmRoleArn

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

public string? AlarmRoleArn { get; set; }

Property Value

string

Remarks

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

NotificationLambdaArn

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

public string? NotificationLambdaArn { get; set; }