CfnCloudWatchAlarmTemplateMixinProps
- class aws_cdk.mixins_preview.aws_medialive.mixins.CfnCloudWatchAlarmTemplateMixinProps(*, comparison_operator=None, datapoints_to_alarm=None, description=None, evaluation_periods=None, group_identifier=None, metric_name=None, name=None, period=None, statistic=None, tags=None, target_resource_type=None, threshold=None, treat_missing_data=None)
Bases:
objectProperties for CfnCloudWatchAlarmTemplatePropsMixin.
- Parameters:
comparison_operator (
Optional[str]) – The comparison operator used to compare the specified statistic and the threshold.datapoints_to_alarm (
Union[int,float,None]) – The number of datapoints within the evaluation period that must be breaching to trigger the alarm. Default: - 0description (
Optional[str]) – A resource’s optional description.evaluation_periods (
Union[int,float,None]) – The number of periods over which data is compared to the specified threshold. Default: - 0group_identifier (
Optional[str]) – A cloudwatch alarm template group’s identifier. Can be either be its id or current name.metric_name (
Optional[str]) – The name of the metric associated with the alarm. Must be compatible with targetResourceType.name (
Optional[str]) – A resource’s name. Names must be unique within the scope of a resource type in a specific region.period (
Union[int,float,None]) – The period, in seconds, over which the specified statistic is applied. Default: - 0statistic (
Optional[str]) – The statistic to apply to the alarm’s metric data.tags (
Optional[Mapping[str,str]]) – Represents the tags associated with a resource.target_resource_type (
Optional[str]) – The resource type this template should dynamically generate CloudWatch metric alarms for.threshold (
Union[int,float,None]) – The threshold value to compare with the specified statistic. Default: - 0treat_missing_data (
Optional[str]) – Specifies how missing data points are treated when evaluating the alarm’s condition.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_medialive import mixins as medialive_mixins cfn_cloud_watch_alarm_template_mixin_props = medialive_mixins.CfnCloudWatchAlarmTemplateMixinProps( comparison_operator="comparisonOperator", datapoints_to_alarm=123, description="description", evaluation_periods=123, group_identifier="groupIdentifier", metric_name="metricName", name="name", period=123, statistic="statistic", tags={ "tags_key": "tags" }, target_resource_type="targetResourceType", threshold=123, treat_missing_data="treatMissingData" )
Attributes
- comparison_operator
The comparison operator used to compare the specified statistic and the threshold.
- datapoints_to_alarm
The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description
A resource’s optional description.
- evaluation_periods
The number of periods over which data is compared to the specified threshold.
- group_identifier
A cloudwatch alarm template group’s identifier.
Can be either be its id or current name.
- metric_name
The name of the metric associated with the alarm.
Must be compatible with targetResourceType.
- name
A resource’s name.
Names must be unique within the scope of a resource type in a specific region.
- period
The period, in seconds, over which the specified statistic is applied.
- statistic
The statistic to apply to the alarm’s metric data.
- tags
Represents the tags associated with a resource.
- target_resource_type
The resource type this template should dynamically generate CloudWatch metric alarms for.
- threshold
The threshold value to compare with the specified statistic.
- treat_missing_data
Specifies how missing data points are treated when evaluating the alarm’s condition.