@pulumi/aws-native/cloudwatch/getLogAlarm.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Resource Type definition for AWS::CloudWatch::LogAlarm. A LogAlarm evaluates scheduled query results from CloudWatch Logs and triggers actions when thresholds are breached.
 */
export declare function getLogAlarm(args: GetLogAlarmArgs, opts?: pulumi.InvokeOptions): Promise<GetLogAlarmResult>;
export interface GetLogAlarmArgs {
    /**
     * The name of the log alarm.
     */
    alarmName: string;
}
export interface GetLogAlarmResult {
    /**
     * The number of log lines to include in alarm notifications. Valid values are 0 to 50.
     */
    readonly actionLogLineCount?: number;
    /**
     * The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications. Required when ActionLogLineCount is greater than 0.
     */
    readonly actionLogLineRoleArn?: string;
    /**
     * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
     */
    readonly actionsEnabled?: boolean;
    /**
     * The list of actions to execute when this alarm transitions into an ALARM state from any other state.
     */
    readonly alarmActions?: string[];
    /**
     * The description of the log alarm.
     */
    readonly alarmDescription?: string;
    /**
     * The ARN of the log alarm.
     */
    readonly arn?: string;
    /**
     * The arithmetic operation to use when comparing the specified threshold and the query results. Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
     */
    readonly comparisonOperator?: string;
    /**
     * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
     */
    readonly insufficientDataActions?: string[];
    /**
     * The actions to execute when this alarm transitions to the OK state from any other state.
     */
    readonly okActions?: string[];
    /**
     * The number of query results that must be breaching to trigger the alarm.
     */
    readonly queryResultsToAlarm?: number;
    /**
     * The number of query results over which data is compared to the specified threshold.
     */
    readonly queryResultsToEvaluate?: number;
    /**
     * The scheduled query configuration for the log alarm.
     */
    readonly scheduledQueryConfiguration?: outputs.cloudwatch.LogAlarmScheduledQueryConfiguration;
    /**
     * A list of key-value pairs to associate with the log alarm.
     */
    readonly tags?: outputs.Tag[];
    /**
     * The value to compare against the results of the scheduled query evaluation.
     */
    readonly threshold?: number;
    /**
     * Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
     */
    readonly treatMissingData?: string;
}
/**
 * Resource Type definition for AWS::CloudWatch::LogAlarm. A LogAlarm evaluates scheduled query results from CloudWatch Logs and triggers actions when thresholds are breached.
 */
export declare function getLogAlarmOutput(args: GetLogAlarmOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLogAlarmResult>;
export interface GetLogAlarmOutputArgs {
    /**
     * The name of the log alarm.
     */
    alarmName: pulumi.Input<string>;
}