AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The details about a log alarm.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.LogAlarm

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class LogAlarm

The LogAlarm type exposes the following members

Constructors

NameDescription
Public Method LogAlarm()

Properties

NameTypeDescription
Public Property ActionLogLineCount System.Nullable<System.Int32>

Gets and sets the property ActionLogLineCount.

The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

Public Property ActionLogLineRoleArn System.String

Gets and sets the property ActionLogLineRoleArn.

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

Public Property ActionsEnabled System.Nullable<System.Boolean>

Gets and sets the property ActionsEnabled.

Indicates whether actions should be executed during any changes to the alarm state.

Public Property AlarmActions System.Collections.Generic.List<System.String>

Gets and sets the property AlarmActions.

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property AlarmArn System.String

Gets and sets the property AlarmArn.

The Amazon Resource Name (ARN) of the alarm.

Public Property AlarmConfigurationUpdatedTimestamp System.Nullable<System.DateTime>

Gets and sets the property AlarmConfigurationUpdatedTimestamp.

The time stamp of the last update to the alarm configuration.

Public Property AlarmDescription System.String

Gets and sets the property AlarmDescription.

The description of the alarm.

Public Property AlarmName System.String

Gets and sets the property AlarmName.

The name of the alarm.

Public Property ComparisonOperator Amazon.CloudWatch.ComparisonOperator

Gets and sets the property ComparisonOperator.

The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

Public Property EvaluationState Amazon.CloudWatch.EvaluationState

Gets and sets the property EvaluationState.

If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

Public Property InsufficientDataActions System.Collections.Generic.List<System.String>

Gets and sets the property InsufficientDataActions.

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property OKActions System.Collections.Generic.List<System.String>

Gets and sets the property OKActions.

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property QueryResultsToAlarm System.Nullable<System.Int32>

Gets and sets the property QueryResultsToAlarm.

The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

Public Property QueryResultsToEvaluate System.Nullable<System.Int32>

Gets and sets the property QueryResultsToEvaluate.

The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

Public Property ScheduledQueryConfiguration Amazon.CloudWatch.Model.ScheduledQueryConfiguration

Gets and sets the property ScheduledQueryConfiguration.

The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

Public Property StateReason System.String

Gets and sets the property StateReason.

An explanation for the alarm state, in text format.

Public Property StateReasonData System.String

Gets and sets the property StateReasonData.

An explanation for the alarm state, in JSON format.

Public Property StateTransitionedTimestamp System.Nullable<System.DateTime>

Gets and sets the property StateTransitionedTimestamp.

The date and time that the alarm's StateValue most recently changed.

Public Property StateUpdatedTimestamp System.Nullable<System.DateTime>

Gets and sets the property StateUpdatedTimestamp.

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

Public Property StateValue Amazon.CloudWatch.StateValue

Gets and sets the property StateValue.

The state value for the alarm.

Public Property Threshold System.Nullable<System.Double>

Gets and sets the property Threshold.

The value to compare with the aggregated query result.

Public Property TreatMissingData System.String

Gets and sets the property TreatMissingData.

How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer