AwsCloudWatchAlarmDetails

import type { AwsCloudWatchAlarmDetails } from "https://aws-api.deno.dev/v0.4/services/securityhub.ts?docs=full";

Specifies an alarm and associates it with the specified metric or metric math expression.

interface AwsCloudWatchAlarmDetails {

ActionsEnabled?: boolean | null;

AlarmActions?: string[] | null;

AlarmArn?: string | null;

AlarmConfigurationUpdatedTimestamp?: string | null;

AlarmDescription?: string | null;

AlarmName?: string | null;

ComparisonOperator?: string | null;

DatapointsToAlarm?: number | null;

Dimensions?: AwsCloudWatchAlarmDimensionsDetails[] | null;

EvaluateLowSampleCountPercentile?: string | null;

EvaluationPeriods?: number | null;

ExtendedStatistic?: string | null;

InsufficientDataActions?: string[] | null;

MetricName?: string | null;

Namespace?: string | null;

OkActions?: string[] | null;

Period?: number | null;

Statistic?: string | null;

Threshold?: number | null;

ThresholdMetricId?: string | null;

TreatMissingData?: string | null;

Unit?: string | null;

}

§Properties

ActionsEnabled?: boolean | null

[src]

Indicates whether actions should be executed during any changes to the alarm state.

AlarmActions?: string[] | null

[src]

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

AlarmArn?: string | null

[src]

The ARN of the alarm.

AlarmConfigurationUpdatedTimestamp?: string | null

[src]

The time stamp of the last update to the alarm configuration.

AlarmDescription?: string | null

[src]

The description of the alarm.

AlarmName?: string | null

[src]

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

ComparisonOperator?: string | null

[src]

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

DatapointsToAlarm?: number | null

[src]

The number of datapoints that must be breaching to trigger the alarm.

Dimensions?: AwsCloudWatchAlarmDimensionsDetails[] | null

[src]

The dimensions for the metric associated with the alarm.

EvaluateLowSampleCountPercentile?: string | null

[src]

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

EvaluationPeriods?: number | null

[src]

The number of periods over which data is compared to the specified threshold.

ExtendedStatistic?: string | null

[src]

The percentile statistic for the metric associated with the alarm.

InsufficientDataActions?: string[] | null

[src]

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

MetricName?: string | null

[src]

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

Namespace?: string | null

[src]

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

OkActions?: string[] | null

[src]

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

Period?: number | null

[src]

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

Statistic?: string | null

[src]

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

Threshold?: number | null

[src]

The value to compare with the specified statistic.

ThresholdMetricId?: string | null

[src]

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

TreatMissingData?: string | null

[src]

Sets how this alarm is to handle missing data points.

Unit?: string | null

[src]

The unit of the metric associated with the alarm.