@pulumi/aws-native
Version:
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)
160 lines (159 loc) • 6.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
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 class LogAlarm extends pulumi.CustomResource {
/**
* Get an existing LogAlarm resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): LogAlarm;
/**
* Returns true if the given object is an instance of LogAlarm. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LogAlarm;
/**
* The number of log lines to include in alarm notifications. Valid values are 0 to 50.
*/
readonly actionLogLineCount: pulumi.Output<number | undefined>;
/**
* 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: pulumi.Output<string | undefined>;
/**
* Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
*/
readonly actionsEnabled: pulumi.Output<boolean | undefined>;
/**
* The list of actions to execute when this alarm transitions into an ALARM state from any other state.
*/
readonly alarmActions: pulumi.Output<string[] | undefined>;
/**
* The description of the log alarm.
*/
readonly alarmDescription: pulumi.Output<string | undefined>;
/**
* The name of the log alarm.
*/
readonly alarmName: pulumi.Output<string | undefined>;
/**
* The ARN of the log alarm.
*/
readonly arn: pulumi.Output<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: pulumi.Output<string>;
/**
* The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
*/
readonly insufficientDataActions: pulumi.Output<string[] | undefined>;
/**
* The actions to execute when this alarm transitions to the OK state from any other state.
*/
readonly okActions: pulumi.Output<string[] | undefined>;
/**
* The number of query results that must be breaching to trigger the alarm.
*/
readonly queryResultsToAlarm: pulumi.Output<number>;
/**
* The number of query results over which data is compared to the specified threshold.
*/
readonly queryResultsToEvaluate: pulumi.Output<number>;
/**
* The scheduled query configuration for the log alarm.
*/
readonly scheduledQueryConfiguration: pulumi.Output<outputs.cloudwatch.LogAlarmScheduledQueryConfiguration>;
/**
* A list of key-value pairs to associate with the log alarm.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The value to compare against the results of the scheduled query evaluation.
*/
readonly threshold: pulumi.Output<number>;
/**
* Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
*/
readonly treatMissingData: pulumi.Output<string | undefined>;
/**
* Create a LogAlarm resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LogAlarmArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a LogAlarm resource.
*/
export interface LogAlarmArgs {
/**
* The number of log lines to include in alarm notifications. Valid values are 0 to 50.
*/
actionLogLineCount?: pulumi.Input<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.
*/
actionLogLineRoleArn?: pulumi.Input<string>;
/**
* Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
*/
actionsEnabled?: pulumi.Input<boolean>;
/**
* The list of actions to execute when this alarm transitions into an ALARM state from any other state.
*/
alarmActions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description of the log alarm.
*/
alarmDescription?: pulumi.Input<string>;
/**
* The name of the log alarm.
*/
alarmName?: pulumi.Input<string>;
/**
* The arithmetic operation to use when comparing the specified threshold and the query results. Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
*/
comparisonOperator: pulumi.Input<string>;
/**
* The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
*/
insufficientDataActions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The actions to execute when this alarm transitions to the OK state from any other state.
*/
okActions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The number of query results that must be breaching to trigger the alarm.
*/
queryResultsToAlarm: pulumi.Input<number>;
/**
* The number of query results over which data is compared to the specified threshold.
*/
queryResultsToEvaluate: pulumi.Input<number>;
/**
* The scheduled query configuration for the log alarm.
*/
scheduledQueryConfiguration: pulumi.Input<inputs.cloudwatch.LogAlarmScheduledQueryConfigurationArgs>;
/**
* A list of key-value pairs to associate with the log alarm.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The value to compare against the results of the scheduled query evaluation.
*/
threshold: pulumi.Input<number>;
/**
* Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
*/
treatMissingData?: pulumi.Input<string>;
}