interface CfnLogAlarmProps

Language	Type name
.NET	`Amazon.CDK.AWS.CloudWatch.CfnLogAlarmProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnLogAlarmProps`
Java	`software.amazon.awscdk.services.cloudwatch.CfnLogAlarmProps`
Python	`aws_cdk.aws_cloudwatch.CfnLogAlarmProps`
TypeScript	`aws-cdk-lib` » `aws_cloudwatch` » `CfnLogAlarmProps`

Properties for defining a CfnLogAlarm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnLogAlarmProps: cloudwatch.CfnLogAlarmProps = {
  comparisonOperator: 'comparisonOperator',
  queryResultsToAlarm: 123,
  queryResultsToEvaluate: 123,
  scheduledQueryConfiguration: {
    aggregationExpression: 'aggregationExpression',
    logGroupIdentifiers: ['logGroupIdentifiers'],
    queryLanguage: 'queryLanguage',
    queryString: 'queryString',
    scheduleConfiguration: {
      scheduleExpression: 'scheduleExpression',

      // the properties below are optional
      endTimeOffset: 123,
      startTimeOffset: 123,
    },
    scheduledQueryRoleArn: 'scheduledQueryRoleArn',
  },
  threshold: 123,

  // the properties below are optional
  actionLogLineCount: 123,
  actionLogLineRoleArn: 'actionLogLineRoleArn',
  actionsEnabled: false,
  alarmActions: ['alarmActions'],
  alarmDescription: 'alarmDescription',
  alarmName: 'alarmName',
  insufficientDataActions: ['insufficientDataActions'],
  okActions: ['okActions'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  treatMissingData: 'treatMissingData',
};

Properties

Name	Type	Description
comparisonOperator	`string`	The arithmetic operation to use when comparing the specified threshold and the query results.
queryResultsToAlarm	`number`	The number of query results that must be breaching to trigger the alarm.
queryResultsToEvaluate	`number`	The number of query results over which data is compared to the specified threshold.
scheduledQueryConfiguration	`IResolvable` `\|` `ScheduledQueryConfigurationProperty`	The scheduled query configuration for the log alarm.
threshold	`number`	The value to compare against the results of the scheduled query evaluation.
actionLogLineCount?	`number`	The number of log lines to include in alarm notifications.
actionLogLineRoleArn?	`string`	The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications.
actionsEnabled?	`boolean \|` `IResolvable`	Indicates whether actions should be executed during any changes to the alarm state.
alarmActions?	`string[]`	The list of actions to execute when this alarm transitions into an ALARM state from any other state.
alarmDescription?	`string`	The description of the log alarm.
alarmName?	`string`	The name of the log alarm.
insufficientDataActions?	`string[]`	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
okActions?	`string[]`	The actions to execute when this alarm transitions to the OK state from any other state.
tags?	`CfnTag[]`	A list of key-value pairs to associate with the log alarm.
treatMissingData?	`string`	Sets how this alarm is to handle missing data points.