Interface ICfnAlarmProps
Properties for defining a CfnAlarm
.
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public interface ICfnAlarmProps
Syntax (vb)
Public Interface ICfnAlarmProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.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.Lightsail;
var cfnAlarmProps = new CfnAlarmProps {
AlarmName = "alarmName",
ComparisonOperator = "comparisonOperator",
EvaluationPeriods = 123,
MetricName = "metricName",
MonitoredResourceName = "monitoredResourceName",
Threshold = 123,
// the properties below are optional
ContactProtocols = new [] { "contactProtocols" },
DatapointsToAlarm = 123,
NotificationEnabled = false,
NotificationTriggers = new [] { "notificationTriggers" },
TreatMissingData = "treatMissingData"
};
Synopsis
Properties
AlarmName | The name of the alarm. |
ComparisonOperator | The arithmetic operation to use when comparing the specified statistic and threshold. |
ContactProtocols | The contact protocols for the alarm, such as |
DatapointsToAlarm | The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the |
EvaluationPeriods | The number of periods over which data is compared to the specified threshold. |
MetricName | The name of the metric associated with the alarm. |
MonitoredResourceName | The name of the Lightsail resource that the alarm monitors. |
NotificationEnabled | A Boolean value indicating whether the alarm is enabled. |
NotificationTriggers | The alarm states that trigger a notification. |
Threshold | The value against which the specified statistic is compared. |
TreatMissingData | Specifies how the alarm handles missing data points. |
Properties
AlarmName
The name of the alarm.
string AlarmName { get; }
Property Value
System.String
Remarks
ComparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold.
string ComparisonOperator { get; }
Property Value
System.String
Remarks
ContactProtocols
The contact protocols for the alarm, such as Email
, SMS
(text messaging), or both.
virtual string[] ContactProtocols { get; }
Property Value
System.String[]
Remarks
Allowed Values : Email
| SMS
DatapointsToAlarm
The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM
state.
virtual Nullable<double> DatapointsToAlarm { get; }
Property Value
System.Nullable<System.Double>
Remarks
EvaluationPeriods
The number of periods over which data is compared to the specified threshold.
double EvaluationPeriods { get; }
Property Value
System.Double
Remarks
MetricName
The name of the metric associated with the alarm.
string MetricName { get; }
Property Value
System.String
Remarks
MonitoredResourceName
The name of the Lightsail resource that the alarm monitors.
string MonitoredResourceName { get; }
Property Value
System.String
Remarks
NotificationEnabled
A Boolean value indicating whether the alarm is enabled.
virtual object NotificationEnabled { get; }
Property Value
System.Object
Remarks
NotificationTriggers
The alarm states that trigger a notification.
virtual string[] NotificationTriggers { get; }
Property Value
System.String[]
Remarks
To specify the OK
and INSUFFICIENT_DATA
values, you must also specify ContactProtocols
values. Otherwise, the OK
and INSUFFICIENT_DATA
values will not take effect and the stack will drift.
Allowed Values : OK
| ALARM
| INSUFFICIENT_DATA
Threshold
The value against which the specified statistic is compared.
double Threshold { get; }
Property Value
System.Double
Remarks
TreatMissingData
Specifies how the alarm handles missing data points.
virtual string TreatMissingData { get; }
Property Value
System.String
Remarks
An alarm can treat missing data in the following ways: