cloudwatch_put_log_alarm: Creates or updates a log alarm
In paws.management: 'Amazon Web Services' Management & Governance Services

cloudwatch_put_log_alarm

R Documentation

Creates or updates a log alarm

Description

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.

See https://www.paws-r-sdk.com/docs/cloudwatch_put_log_alarm/ for full documentation.

Usage

cloudwatch_put_log_alarm(
  AlarmName,
  AlarmDescription = NULL,
  ScheduledQueryConfiguration,
  ActionLogLineCount = NULL,
  ActionLogLineRoleArn = NULL,
  ActionsEnabled = NULL,
  OKActions = NULL,
  AlarmActions = NULL,
  InsufficientDataActions = NULL,
  QueryResultsToEvaluate,
  QueryResultsToAlarm,
  Threshold,
  ComparisonOperator,
  TreatMissingData = NULL,
  Tags = NULL,
  WarmUpConfiguration = NULL
)

Arguments

`AlarmName`	[required] The name for the alarm. This name must be unique within the Amazon Web Services account and Region.
`AlarmDescription`	The description for the alarm.
`ScheduledQueryConfiguration`	[required] The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.
`ActionLogLineCount`	The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.
`ActionLogLineRoleArn`	The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when `ActionLogLineCount` is greater than 0.
`ActionsEnabled`	Indicates whether actions should be executed during any changes to the alarm state. The default is `true`.
`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). Valid Values: Amazon SNS actions: `arn:aws:sns:region:account-id:sns-topic-name` Lambda actions: Invoke the latest version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name ⁠` Invoke a specific version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:version-number ⁠` Invoke a function by using an alias Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:alias-name ⁠`
`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). Valid Values: Amazon SNS actions: `arn:aws:sns:region:account-id:sns-topic-name` Lambda actions: Invoke the latest version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name ⁠` Invoke a specific version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:version-number ⁠` Invoke a function by using an alias Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:alias-name ⁠` Systems Manager actions: `arn:aws:ssm:region:account-id:opsitem:severity`
`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). Valid Values: Amazon SNS actions: `arn:aws:sns:region:account-id:sns-topic-name` Lambda actions: Invoke the latest version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name ⁠` Invoke a specific version of a Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:version-number ⁠` Invoke a function by using an alias Lambda function: `⁠arn:aws:lambda:region:account-id:function:function-name:alias-name ⁠`
`QueryResultsToEvaluate`	[required] The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.
`QueryResultsToAlarm`	[required] 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). Must be less than or equal to `QueryResultsToEvaluate`.
`Threshold`	[required] The value to compare with the aggregated query result.
`ComparisonOperator`	[required] The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are `GreaterThanThreshold`, `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, and `LessThanOrEqualToThreshold`.
`TreatMissingData`	Sets how this alarm is to handle missing data points. Valid values are `breaching`, `notBreaching`, `ignore`, and `missing`. If this parameter is omitted, the default behavior of `missing` is used.
`Tags`	A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.
`WarmUpConfiguration`	The warm-up configuration for the alarm. A warm-up period delays alarm evaluation after you create or update the alarm. The warm-up period reduces alarm noise from missing data while a new resource or service starts publishing data. For more information, see Alarm warm-up periods in the Amazon CloudWatch User Guide.