Skip to main content
Version: v1.5

AWS METRIC-ALARM

Description

Terraform module which creates Cloudwatch resources on AWS

Specification

Properties

NameDescriptionTypeRequiredDefault
actions_enabledIndicates whether or not actions should be executed during any changes to the alarm's state. Defaults to true.boolfalse
alarm_actionsThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).list(string)false
alarm_descriptionThe description for the alarm.stringfalse
alarm_nameThe descriptive name for the alarm. This name must be unique within the user's AWS account.stringtrue
comparison_operatorThe arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold.stringtrue
create_metric_alarmWhether to create the Cloudwatch metric alarmboolfalse
datapoints_to_alarmThe number of datapoints that must be breaching to trigger the alarm.numberfalse
dimensionsThe dimensions for the alarm's associated metric.anyfalse
evaluate_low_sample_count_percentilesUsed only for alarms based on percentiles. If you specify ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported: ignore, and evaluate.stringfalse
evaluation_periodsThe number of periods over which data is compared to the specified threshold.numbertrue
extended_statisticThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.stringfalse
insufficient_data_actionsThe list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).list(string)false
metric_nameThe name for the alarm's associated metric. See docs for supported metrics.stringfalse
metric_queryEnables you to create an alarm based on a metric math expression. You may specify at most 20.anyfalse
namespaceThe namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.stringfalse
ok_actionsThe list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).list(string)false
periodThe period in seconds over which the specified statistic is applied.stringfalse
statisticThe statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximumstringfalse
tagsA mapping of tags to assign to all resourcesmap(string)false
thresholdThe value against which the specified statistic is compared.numberfalse
threshold_metric_idIf this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.stringfalse
treat_missing_dataSets how this alarm is to handle missing data points. The following values are supported: missing, ignore, breaching and notBreaching.stringfalse
unitThe unit for the alarm's associated metric.stringfalse
writeConnectionSecretToRefThe secret which the cloud resource connection will be written towriteConnectionSecretToReffalse

writeConnectionSecretToRef

NameDescriptionTypeRequiredDefault
nameThe secret name which the cloud resource connection will be written tostringtrue
namespaceThe secret namespace which the cloud resource connection will be written tostringfalse