interface CfnCloudWatchAlarmTemplateProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.MediaLive.CfnCloudWatchAlarmTemplateProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsmedialive#CfnCloudWatchAlarmTemplateProps |
 Java | software.amazon.awscdk.services.medialive.CfnCloudWatchAlarmTemplateProps |
 Python | aws_cdk.aws_medialive.CfnCloudWatchAlarmTemplateProps |
 TypeScript | aws-cdk-lib » aws_medialive » CfnCloudWatchAlarmTemplateProps |
Properties for defining a CfnCloudWatchAlarmTemplate.
Example
// 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,
groupIdentifier: 'groupIdentifier',
metricName: 'metricName',
name: 'name',
period: 123,
statistic: 'statistic',
targetResourceType: 'targetResourceType',
threshold: 123,
treatMissingData: 'treatMissingData',
// the properties below are optional
datapointsToAlarm: 123,
description: 'description',
tags: {
tagsKey: 'tags',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| comparison | string | The comparison operator used to compare the specified statistic and the threshold. |
| evaluation | number | The number of periods over which data is compared to the specified threshold. |
| group | string | A cloudwatch alarm template group's identifier. |
| metric | string | The name of the metric associated with the alarm. |
| name | string | A resource's name. |
| period | number | The period, in seconds, over which the specified statistic is applied. |
| statistic | string | The statistic to apply to the alarm's metric data. |
| target | string | The resource type this template should dynamically generate CloudWatch metric alarms for. |
| threshold | number | The threshold value to compare with the specified statistic. |
| treat | string | Specifies how missing data points are treated when evaluating the alarm's condition. |
| datapoints | number | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. |
| description? | string | A resource's optional description. |
| tags? | { [string]: string } | Represents the tags associated with a resource. |
comparisonOperator
Type:
string
The comparison operator used to compare the specified statistic and the threshold.
evaluationPeriods
Type:
number
The number of periods over which data is compared to the specified threshold.
groupIdentifier
Type:
string
A cloudwatch alarm template group's identifier.
Can be either be its id or current name.
metricName
Type:
string
The name of the metric associated with the alarm.
Must be compatible with targetResourceType.
name
Type:
string
A resource's name.
Names must be unique within the scope of a resource type in a specific region.
period
Type:
number
The period, in seconds, over which the specified statistic is applied.
statistic
Type:
string
The statistic to apply to the alarm's metric data.
targetResourceType
Type:
string
The resource type this template should dynamically generate CloudWatch metric alarms for.
threshold
Type:
number
The threshold value to compare with the specified statistic.
treatMissingData
Type:
string
Specifies how missing data points are treated when evaluating the alarm's condition.
datapointsToAlarm?
Type:
number
(optional, default: 0)
The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
description?
Type:
string
(optional)
A resource's optional description.
tags?
Type:
{ [string]: string }
(optional)
Represents the tags associated with a resource.