interface EvaluationWindowProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.CloudWatch.CfnAlarmPropsMixin.EvaluationWindowProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscloudwatch#CfnAlarmPropsMixin_EvaluationWindowProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnAlarmPropsMixin.EvaluationWindowProperty |
 Python | aws_cdk.cfn_property_mixins.aws_cloudwatch.CfnAlarmPropsMixin.EvaluationWindowProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_cloudwatch » CfnAlarmPropsMixin » EvaluationWindowProperty |
The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs.
This is a union type. Set exactly one of its members, SlidingWindow or WallClockWindow. If you don't set EvaluationWindow, the alarm uses a SlidingWindow by default.
For more information, see Alarm evaluation windows in the CloudWatch User Guide.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from '@aws-cdk/cfn-property-mixins';
declare const slidingWindow: any;
const evaluationWindowProperty: cloudwatch.CfnAlarmPropsMixin.EvaluationWindowProperty = {
slidingWindow: slidingWindow,
wallClockWindow: {
timezone: 'timezone',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| sliding | any | A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. |
| wall | IResolvable | Wall | An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone. |
slidingWindow?
Type:
any
(optional)
A sliding window, which advances each time the alarm is evaluated, forming a rolling time window.
This is the default evaluation window.
wallClockWindow?
Type:
IResolvable | Wall
(optional)
An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone.
When you use a wall clock window, the alarm's period must be 1 minute (60 seconds), 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day (86,400 seconds), or 1 week (604,800 seconds). Other period values aren't supported with a wall clock window. Choose a wall clock window when your monitoring is tied to a business or calendar period, such as daily reports, batch jobs, or backups, or when you want alarm evaluations to match the periods shown on a metric dashboard.