Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlarmConfig

SecurityConfig / CloudWatchConfig / AlarmSetConfig / AlarmConfig

AWS CloudWatch Alarm configuration

example
- alarmName: CIS-1.1-RootAccountUsage
  alarmDescription: Alarm for usage of "root" account
  snsAlertLevel: Low
  metricName: RootAccountUsage
  namespace: LogMetrics
  comparisonOperator: GreaterThanOrEqualToThreshold
  evaluationPeriods: 1
  period: 300
  statistic: Sum
  threshold: 1
  treatMissingData: notBreaching

Hierarchy

  • AlarmConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly alarmDescription

alarmDescription: string = ''

Description for the alarm

Readonly alarmName

alarmName: string = ''

Name of the alarm

Readonly comparisonOperator

comparisonOperator: string = ''

Comparison to use to check if metric is breaching

Readonly evaluationPeriods

evaluationPeriods: number = 1

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

Readonly metricName

metricName: string = ''

Name of the metric.

Readonly namespace

namespace: string = ''

Namespace of the metric.

Readonly period

period: number = 300

The period over which the specified statistic is applied.

Readonly snsAlertLevel

snsAlertLevel: string = ''

Alert SNS notification level Deprecated

Readonly snsTopicName

snsTopicName: string = ''

SNS Topic Name SNS Topic Name from global config

Readonly statistic

statistic: string = ''

What functions to use for aggregating.

Can be one of the following:

  • “Minimum” | “min”
  • “Maximum” | “max”
  • “Average” | “avg”
  • “Sum” | “sum”
  • “SampleCount | “n”
  • “pNN.NN”

Readonly threshold

threshold: number = 1

The value against which the specified statistic is compared.

Readonly treatMissingData

treatMissingData: string = ''

Sets how this alarm is to handle missing data points.

Generated using TypeDoc