Options
All
  • Public
  • Public/Protected
  • All
English
  • English
  • Français
Menu
Warning
The configuration file schema documentation is a work in progress. Please use this draft document with caution. The deeper you browse into the hierarchy, the less accurate the definitions are likely to be.

This section is used to define the default values for all defined CloudWatch Alarms, to define the specific alarms and override any defaults when specified on an individual alarm definition.

Hierarchy

  • CloudWatchAlarmDefaultsAndDefinitions

Index

Properties

default-accounts

default-accounts: string[]
Title: Default Accounts
Description: Account(s) where all CloudWatch Alarms are to be deployed, unless a different account list is specified on the rule. Specify ALL to target all accounts in the Organization.

default-comparison-operator

default-comparison-operator: string
Title: Default Comparison Operator
Description: The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. Valid Values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold | LessThanLowerOrGreaterThanUpperThreshold | LessThanLowerThreshold | GreaterThanUpperThreshold

default-evaluation-periods

default-evaluation-periods: number
Title: Default Evaluation Periods
Description: The number of the most recent periods, or data points, to evaluate when determining alarm state

Optional default-in-org-mgmt-use-lcl-sns

default-in-org-mgmt-use-lcl-sns: boolean
Title: Default in Org Mgmt account use local SNS
Description: By default, cross-account SNS topics in the central-log-services account are leveraged, this overides this setting in the Org Management account to use local topics as the default for all rules.

default-namespace

default-namespace: string
Title: Default Namespace
Description: A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics

default-period

default-period: number
Title: Default Period
Description: Period is the length of time to evaluate the metric or expression to create each individual data point for an alarm. It is expressed in seconds. If you choose one minute as the period, the alarm evaluates the metric once per minute

default-regions

default-regions: string[]
Title: Default Regions
Description: Currently only the Accelerator home region is supported.

default-statistic

default-statistic: string
Title: Default Statistic
Description: Statistics are metric data aggregations over specified periods of time. CloudWatch provides statistics based on the metric data points provided by your custom data or provided by other AWS services to CloudWatch

default-threshold

default-threshold: number
Title: Default Threshold
Description: The value to compare the metric value against

default-threshold-type

default-threshold-type: string
Title: Default Threshold Type
Description: Static to use a value a a threshold

default-treat-missing-data

default-treat-missing-data: string
Title: Default Treat Missing Data
Description: Similar to how each alarm is always in one of three states, each specific data point reported to CloudWatch falls under one of three categories: Not breaching (within the threshold), Breaching (violating the threshold), Missing

definitions

Title: Definitions
Description: This section defines the list of CloudWatch alarms to be deployed.