The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
Declaration Syntax| C# |
public class MetricAlarm
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | MetricAlarm()()()() | Initializes a new instance of the MetricAlarm class |
 | ActionsEnabled |
Indicates whether actions should be executed during any changes to the alarm's state.
|
| AlarmActions |
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.
Constraints: |
| AlarmArn |
The Amazon Resource Name (ARN) of the alarm.
Constraints: |
| AlarmConfigurationUpdatedTimestamp |
The time stamp of the last update to the alarm configuration.
|
| AlarmDescription |
The description for the alarm.
Constraints: |
| AlarmName |
The name of the alarm.
Constraints: |
| ComparisonOperator |
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is
used as the first operand.
Constraints: |
| Dimensions |
The list of dimensions associated with the alarm's associated metric.
Constraints: |
| Equals(Object) | (Inherited from Object.) |
| EvaluationPeriods |
The number of periods over which data is compared to the specified threshold.
Constraints: |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| InsufficientDataActions |
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an
Auto Scaling policy. The current WSDL lists this attribute as UnknownActions. Constraints: |
| MetricName |
The name of the alarm's metric.
Constraints: |
| Namespace |
The namespace of alarm's associated metric.
Constraints: |
| OKActions |
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.
Constraints: |
| Period |
The period in seconds over which the statistic is applied.
Constraints: |
| StateReason |
A human-readable explanation for the alarm's state.
Constraints: |
| StateReasonData |
An explanation for the alarm's state in machine-readable JSON format
Constraints: |
| StateUpdatedTimestamp |
The time stamp of the last update to the alarm's state.
|
| StateValue |
The state value for the alarm.
Constraints: |
| Statistic |
The statistic to apply to the alarm's associated metric.
Constraints: |
| Threshold |
The value against which the specified statistic is compared.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| Unit |
The unit of the alarm's associated metric.
Constraints: |
| WithActionsEnabled(Boolean) | Obsolete.
Sets the ActionsEnabled property
|
| WithAlarmActions(array<String>[]()[][]) | Obsolete.
Adds elements to the AlarmActions collection
|
| WithAlarmActions(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the AlarmActions collection
|
| WithAlarmArn(String) | Obsolete.
Sets the AlarmArn property
|
| WithAlarmConfigurationUpdatedTimestamp(DateTime) | Obsolete.
Sets the AlarmConfigurationUpdatedTimestamp property
|
| WithAlarmDescription(String) | Obsolete.
Sets the AlarmDescription property
|
| WithAlarmName(String) | Obsolete.
Sets the AlarmName property
|
| WithComparisonOperator(String) | Obsolete.
Sets the ComparisonOperator property
|
| WithDimensions(array<Dimension>[]()[][]) | Obsolete.
Adds elements to the Dimensions collection
|
| WithDimensions(IEnumerable<(Of <<'(Dimension>)>>)) | Obsolete.
Adds elements to the Dimensions collection
|
| WithEvaluationPeriods(Int32) | Obsolete.
Sets the EvaluationPeriods property
|
| WithInsufficientDataActions(array<String>[]()[][]) | Obsolete.
Adds elements to the InsufficientDataActions collection
|
| WithInsufficientDataActions(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the InsufficientDataActions collection
|
| WithMetricName(String) | Obsolete.
Sets the MetricName property
|
| WithNamespace(String) | Obsolete.
Sets the Namespace property
|
| WithOKActions(array<String>[]()[][]) | Obsolete.
Adds elements to the OKActions collection
|
| WithOKActions(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the OKActions collection
|
| WithPeriod(Int32) | Obsolete.
Sets the Period property
|
| WithStateReason(String) | Obsolete.
Sets the StateReason property
|
| WithStateReasonData(String) | Obsolete.
Sets the StateReasonData property
|
| WithStateUpdatedTimestamp(DateTime) | Obsolete.
Sets the StateUpdatedTimestamp property
|
| WithStateValue(String) | Obsolete.
Sets the StateValue property
|
| WithStatistic(String) | Obsolete.
Sets the Statistic property
|
| WithThreshold(Double) | Obsolete.
Sets the Threshold property
|
| WithUnit(String) | Obsolete.
Sets the Unit property
|
Inheritance Hierarchy| Object | |
 | MetricAlarm |