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.
Creates or updates a log alarm. A log alarm evaluates the results of a CloudWatch Logs scheduled query against the configured threshold and comparison operator to determine its state.
When you create a log alarm, the operation creates a service-managed CloudWatch Logs
scheduled query that runs the query string you provide on the schedule you configure.
Each scheduled query execution returns one or more aggregated values determined by
the AggregationExpression, and each aggregated value is compared against the
alarm Threshold to determine the alarm state. The alarm uses M-out-of-N evaluation:
if QueryResultsToAlarm out of the most recent QueryResultsToEvaluate
query results breach the threshold, the alarm transitions to ALARM.
Log alarms support the alarm states (OK, ALARM, INSUFFICIENT_DATA).
Configure transition actions using OKActions, AlarmActions, and InsufficientDataActions.
If you call this operation with the name of an existing log alarm, the operation replaces the previous configuration of that alarm.
Permissions
To create or update a log alarm, you must have the cloudwatch:PutLogAlarm permission.
The IAM role specified in ScheduledQueryRoleARN must grant the CloudWatch Alarms
service permission to execute scheduled queries on the specified log groups. If you
set ActionLogLineCount, the role specified in ActionLogLineRoleArn must
grant permission to retrieve log events for inclusion in alarm notifications.
This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.
Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
public virtual Task<PutLogAlarmResponse> PutLogAlarmAsync( PutLogAlarmRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the PutLogAlarm service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| LimitExceededException | The quota for alarms for this customer has already been reached. |
| ResourceConflictException | The operation could not be completed because the request conflicts with the current state of the alarm or its underlying scheduled query resource. |
.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