Skip to content
v2.274.0

CfnCloudWatchAlarmTemplateProps Struct ​

Properties for defining a CfnCloudWatchAlarmTemplate.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_medialive as medialive } from 'aws-cdk-lib';
const cfnCloudWatchAlarmTemplateProps: medialive.CfnCloudWatchAlarmTemplateProps = {
  comparisonOperator: 'comparisonOperator',
  evaluationPeriods: 123,
  metricName: 'metricName',
  name: 'name',
  period: 123,
  statistic: 'statistic',
  targetResourceType: 'targetResourceType',
  threshold: 123,
  treatMissingData: 'treatMissingData',

  // the properties below are optional
  datapointsToAlarm: 123,
  description: 'description',
  groupIdentifier: 'groupIdentifier',
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

comparisonOperatorstringcomparison_operatorstrcomparisonOperatorStringComparisonOperatorstringComparisonOperator*stringrequired#
The comparison operator used to compare the specified statistic and the threshold.
datapointsToAlarmnumberdatapoints_to_alarmint | floatdatapointsToAlarmNumberDatapointsToAlarmdoubleDatapointsToAlarm*float64= 0#
The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A resource's optional description.
evaluationPeriodsnumberevaluation_periodsint | floatevaluationPeriodsNumberEvaluationPeriodsdoubleEvaluationPeriods*float64= 0required#
The number of periods over which data is compared to the specified threshold.
groupIdentifierstringgroup_identifierstrgroupIdentifierStringGroupIdentifierstringGroupIdentifier*string#
A cloudwatch alarm template group's identifier.

Can be either be its id or current name.

metricNamestringmetric_namestrmetricNameStringMetricNamestringMetricName*stringrequired#
The name of the metric associated with the alarm.

Must be compatible with targetResourceType.

namestringnamestrnameStringNamestringName*stringrequired#
A resource's name.

Names must be unique within the scope of a resource type in a specific region.

periodnumberperiodint | floatperiodNumberPerioddoublePeriod*float64= 0required#
The period, in seconds, over which the specified statistic is applied.
statisticstringstatisticstrstatisticStringStatisticstringStatistic*stringrequired#
The statistic to apply to the alarm's metric data.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#
Represents the tags associated with a resource.
targetResourceTypestringtarget_resource_typestrtargetResourceTypeStringTargetResourceTypestringTargetResourceType*stringrequired#
The resource type this template should dynamically generate CloudWatch metric alarms for.
thresholdnumberthresholdint | floatthresholdNumberThresholddoubleThreshold*float64= 0required#
The threshold value to compare with the specified statistic.
treatMissingDatastringtreat_missing_datastrtreatMissingDataStringTreatMissingDatastringTreatMissingData*stringrequired#
Specifies how missing data points are treated when evaluating the alarm's condition.

Used as props by ​